A B C D E F G H I L M N O P R S T U V

A

add(String, Object) - Method in class io.cdap.wrangler.api.Row

Adds a value into row with name.

add(Token) - Method in class io.cdap.wrangler.api.TokenGroup

addLoadableDirective(String) - Method in class io.cdap.wrangler.api.RecipeSymbol.Builder

A Recipe can specify the pragma instructions for loading the directives dynamically.

addOrSet(String, Object) - Method in class io.cdap.wrangler.api.Row

Adds or sets the value.

addOrSetAtIndex(int, String, Object) - Method in class io.cdap.wrangler.api.Row

Adds or sets the value to the beginning.

addToken(Token) - Method in class io.cdap.wrangler.api.RecipeSymbol.Builder

This method provides a way to add a Token to the TokenGroup.

addVersion(String) - Method in class io.cdap.wrangler.api.RecipeSymbol.Builder

Recipe can specify the version of the grammar.

all(Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A relation that has association with all in the output field.

all(Many, Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A relation that has association with a set of targets + all in the output field.

Arguments - Interface in io.cdap.wrangler.api

This class Arguments represents the wrapped tokens that are tokenized and parsed arguments provided to the Executor.

B

Bool - Class in io.cdap.wrangler.api.parser

The Bool class wraps the primitive type Boolean in a object.

Bool(Boolean) - Constructor for class io.cdap.wrangler.api.parser.Bool

Allocates a Boolean object representing the value argument.

BoolList - Class in io.cdap.wrangler.api.parser

The Bool List class wraps the list of primitive type Boolean in a object.

BoolList(List<Boolean>) - Constructor for class io.cdap.wrangler.api.parser.BoolList

Allocates a List<Boolean> object representing the value argument.

build() - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

build() - Method in class io.cdap.wrangler.api.parser.UsageDefinition.Builder

build() - Method in class io.cdap.wrangler.api.RecipeSymbol.Builder

Returns a fully constructed and valid RecipeSymbol object.

builder() - Static method in class io.cdap.wrangler.api.lineage.Mutation

Builder() - Constructor for class io.cdap.wrangler.api.lineage.Mutation.Builder

A builder constructor.

builder(String) - Static method in class io.cdap.wrangler.api.parser.UsageDefinition

This is a static method for creating a builder for the UsageDefinition object.

Builder(String) - Constructor for class io.cdap.wrangler.api.parser.UsageDefinition.Builder

builder() - Static method in class io.cdap.wrangler.api.RecipeSymbol

Static method for creating an instance of the RecipeSymbol.Builder.

Builder() - Constructor for class io.cdap.wrangler.api.RecipeSymbol.Builder

C

Categories - Annotation Type in io.cdap.wrangler.api.annotations

This annotation defines the category for a directive.

code - Variable in class io.cdap.wrangler.api.ErrorRecordBase

column() - Method in interface io.cdap.wrangler.api.Arguments

Returns the source column number these arguments were parsed from.

ColumnName - Class in io.cdap.wrangler.api.parser

ColumnName(String) - Constructor for class io.cdap.wrangler.api.parser.ColumnName

ColumnNameList - Class in io.cdap.wrangler.api.parser

Class description here.

ColumnNameList(List<String>) - Constructor for class io.cdap.wrangler.api.parser.ColumnNameList

columns() - Method in class io.cdap.wrangler.api.lineage.Many

columns(Collection<ColumnName>) - Static method in class io.cdap.wrangler.api.lineage.Many

List of ColumnName specified as source or target.

columns(ColumnName...) - Static method in class io.cdap.wrangler.api.lineage.Many

List of ColumnName specifying source or target.

columns(String...) - Static method in class io.cdap.wrangler.api.lineage.Many

List of columns of type String specifying either source or target.

compile(String) - Method in interface io.cdap.wrangler.api.Compiler

Compiles the recipe that is supplied in a String format.

compile(Location) - Method in interface io.cdap.wrangler.api.Compiler

Compiles the recipe that is supplied in a Location on HDFS.

compile(Path) - Method in interface io.cdap.wrangler.api.Compiler

Compiles the recipe that is supplied in a Path on Filesystem.

CompileException - Exception in io.cdap.wrangler.api

This class CompileException is thrown when there is any issue with compiling the Recipe.

CompileException(String) - Constructor for exception io.cdap.wrangler.api.CompileException

CompileException(String, Iterator<SyntaxError>) - Constructor for exception io.cdap.wrangler.api.CompileException

CompileException(String, Exception) - Constructor for exception io.cdap.wrangler.api.CompileException

Compiler - Interface in io.cdap.wrangler.api

This Compiler interface provides a way to implement your own version of compiler for directive or recipe.

CompileStatus - Class in io.cdap.wrangler.api

This class CompileStatus contains the status of compilation.

CompileStatus(RecipeSymbol) - Constructor for class io.cdap.wrangler.api.CompileStatus

CompileStatus(boolean, Iterator<SyntaxError>) - Constructor for class io.cdap.wrangler.api.CompileStatus

conditional(String, String) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A relation that's conditional, depending on whether source and target are same.

contains(String) - Method in interface io.cdap.wrangler.api.Arguments

This method checks if there exists a token named name registered with this object.

create(Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

Specifies a relation that has no cause but effect.

createTokenGroup(SourceInfo) - Method in class io.cdap.wrangler.api.RecipeSymbol.Builder

TokenGroup is created for each directive in the recipe.

D

define() - Method in interface io.cdap.wrangler.api.Directive

This method provides a way for the developer to provide information about the arguments expected by this directive.

define(String, TokenType) - Method in class io.cdap.wrangler.api.parser.UsageDefinition.Builder

This method provides a way to set the name and the type of token, while defaulting the label to 'null' and setting the optional to FALSE.

define(String, TokenType, String) - Method in class io.cdap.wrangler.api.parser.UsageDefinition.Builder

Allows users to define a token with a name, type of the token and additional optional for the label that is used during creation of the usage for the directive.

define(String, TokenType, boolean) - Method in class io.cdap.wrangler.api.parser.UsageDefinition.Builder

Method allows users to specify a field as optional in combination to the name of the token and the type of token.

define(String, TokenType, String, boolean) - Method in class io.cdap.wrangler.api.parser.UsageDefinition.Builder

Method allows users to specify a field as optional in combination to the name of the token, the type of token and also the ability to specify a label for the usage.

destroy() - Method in interface io.cdap.wrangler.api.Executor

This method provides a way for the directive to de-initialize or destroy the resources that were acquired during the initialization phase.

destroy() - Method in interface io.cdap.wrangler.api.RecipePipeline

Destroys the pipeline.

Directive - Interface in io.cdap.wrangler.api

Directive is a user defined directive.

DirectiveAlias - Interface in io.cdap.wrangler.api

This interface DirectiveAlias provides a way to check if a directive is aliased and if there it is aliased to what it is being aliased.

DirectiveConfig - Class in io.cdap.wrangler.api

This class DirectiveConfig defines the configuration for the Wrangler.

DirectiveConfig() - Constructor for class io.cdap.wrangler.api.DirectiveConfig

DirectiveContext - Interface in io.cdap.wrangler.api

DirectiveContext provides the context object to the processing of directives.

DirectiveEnforcer - Interface in io.cdap.wrangler.api

This class defines the interfaces that would provide the ability to check whether the user should be provided access to the directive being used.

DirectiveExecutionException - Exception in io.cdap.wrangler.api

A Executor specific exception used for communicating issues with execution of pipeline in that step.

DirectiveExecutionException(Exception) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveExecutionException(String) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveExecutionException(String, Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveExecutionException(Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveExecutionException(String, String) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveExecutionException(String, String, Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveExecutionException

DirectiveLoadException - Exception in io.cdap.wrangler.api

Class description here.

DirectiveLoadException(String) - Constructor for exception io.cdap.wrangler.api.DirectiveLoadException

DirectiveLoadException(String, Exception) - Constructor for exception io.cdap.wrangler.api.DirectiveLoadException

DirectiveName - Class in io.cdap.wrangler.api.parser

Class description here.

DirectiveName(String) - Constructor for class io.cdap.wrangler.api.parser.DirectiveName

DirectiveNotFoundException - Exception in io.cdap.wrangler.api

Class description here.

DirectiveNotFoundException(String) - Constructor for exception io.cdap.wrangler.api.DirectiveNotFoundException

DirectiveParseException - Exception in io.cdap.wrangler.api

An exception thrown when there is error in parsing specification.

DirectiveParseException(String, Iterator<SyntaxError>) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

DirectiveParseException(String, Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

DirectiveParseException(Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

DirectiveParseException(String) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

DirectiveParseException(String, String) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

DirectiveParseException(String, String, Throwable) - Constructor for exception io.cdap.wrangler.api.DirectiveParseException

doubleValue() - Method in class io.cdap.wrangler.api.LazyNumber

Returns the value of the specified number as a double.

drop(Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

Specifies a relation that need to be dropped.

E

EMPTY - Static variable in class io.cdap.wrangler.api.DirectiveConfig

ErrorRecord - Class in io.cdap.wrangler.api

Specifies the structure for Error records.

ErrorRecord(Row, String, int, boolean) - Constructor for class io.cdap.wrangler.api.ErrorRecord

ErrorRecord(Row, String, int) - Constructor for class io.cdap.wrangler.api.ErrorRecord

ErrorRecordBase - Class in io.cdap.wrangler.api

Base class for error record that includes the critical fields.

ErrorRecordBase(String, int, boolean) - Constructor for class io.cdap.wrangler.api.ErrorRecordBase

ErrorRowException - Exception in io.cdap.wrangler.api

Exception throw when the record needs to emitted to error collector.

ErrorRowException(String, int, boolean) - Constructor for exception io.cdap.wrangler.api.ErrorRowException

ErrorRowException(String, int) - Constructor for exception io.cdap.wrangler.api.ErrorRowException

ErrorRowException(String, String, int) - Constructor for exception io.cdap.wrangler.api.ErrorRowException

errors() - Method in exception io.cdap.wrangler.api.DirectiveParseException

errors() - Method in interface io.cdap.wrangler.api.RecipePipeline

Returns records that are errored out.

execute(I, ExecutorContext) - Method in interface io.cdap.wrangler.api.Executor

Executes a wrangle step on single Row and return an array of wrangled Row.

execute(List<I>, Schema) - Method in interface io.cdap.wrangler.api.RecipePipeline

Executes the pipeline on the input.

execute(List<I>) - Method in interface io.cdap.wrangler.api.RecipePipeline

Executes the pipeline on the input.

Executor<I,O> - Interface in io.cdap.wrangler.api

A interface defining the wrangle Executor in the wrangling RecipePipeline.

ExecutorContext - Interface in io.cdap.wrangler.api

Pipeline Context for passing contextual information to the pipeline being executed.

ExecutorContext.Environment - Enum in io.cdap.wrangler.api

Specifies the environment in which wrangler is running.

Expression - Class in io.cdap.wrangler.api.parser

Class description here.

Expression(String) - Constructor for class io.cdap.wrangler.api.parser.Expression

F

FALSE - Static variable in class io.cdap.wrangler.api.Optional

When an argument is non optional, FALSE is specified.

find(String) - Method in class io.cdap.wrangler.api.Row

Finds a column index based on the name of the column.

floatValue() - Method in class io.cdap.wrangler.api.LazyNumber

Returns the value of the specified number as a float.

G

generate(Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A relation that has association with all the input fields.

get(int) - Method in class io.cdap.wrangler.api.TokenGroup

get(String) - Method in interface io.cdap.wrangler.api.TransientStore

A value associated with the variable in the transient store.

getAlias(String) - Method in interface io.cdap.wrangler.api.DirectiveAlias

Returns the root directive aliasee

getAliasName(String) - Method in class io.cdap.wrangler.api.DirectiveConfig

Dereferences an alias if defined, else returns the directive itself.

getCharPosition() - Method in class io.cdap.wrangler.api.parser.SyntaxError

getCode() - Method in class io.cdap.wrangler.api.ErrorRecordBase

getCode() - Method in exception io.cdap.wrangler.api.ErrorRowException

getCode() - Method in exception io.cdap.wrangler.api.ReportErrorAndProceed

getColumn(int) - Method in class io.cdap.wrangler.api.Row

Gets a column name by index.

getColumnNumber() - Method in class io.cdap.wrangler.api.SourceInfo

getContextName() - Method in interface io.cdap.wrangler.api.ExecutorContext

getDirectiveName() - Method in class io.cdap.wrangler.api.parser.UsageDefinition

Returns the name of the directive for which the this UsageDefinition object is created.

getEnvironment() - Method in interface io.cdap.wrangler.api.ExecutorContext

getErrors() - Method in class io.cdap.wrangler.api.CompileStatus

getFields() - Method in class io.cdap.wrangler.api.Row

getFirst() - Method in class io.cdap.wrangler.api.Pair

getFirst() - Method in class io.cdap.wrangler.api.Triplet

getLine() - Method in class io.cdap.wrangler.api.parser.SyntaxError

getLineNumber() - Method in class io.cdap.wrangler.api.parser.SyntaxError

getLineNumber() - Method in class io.cdap.wrangler.api.SourceInfo

getLoadableDirectives() - Method in class io.cdap.wrangler.api.RecipeSymbol

Returns a set of dynamically loaded directives as plugins.

getMessage() - Method in class io.cdap.wrangler.api.ErrorRecordBase

getMessage() - Method in exception io.cdap.wrangler.api.ErrorRowException

getMessage() - Method in class io.cdap.wrangler.api.parser.SyntaxError

getMessage() - Method in exception io.cdap.wrangler.api.ReportErrorAndProceed

getMetrics() - Method in interface io.cdap.wrangler.api.ExecutorContext

getNamespace() - Method in interface io.cdap.wrangler.api.ExecutorContext

getOptionalTokensCount() - Method in class io.cdap.wrangler.api.parser.UsageDefinition

Returns the count of TokenDefinition that have been specified as optional in the UsageDefinition.

getProperties() - Method in interface io.cdap.wrangler.api.ExecutorContext

getReverseAlias() - Method in class io.cdap.wrangler.api.DirectiveConfig

getRow() - Method in class io.cdap.wrangler.api.ErrorRecord

getSecond() - Method in class io.cdap.wrangler.api.Pair

getSecond() - Method in class io.cdap.wrangler.api.Triplet

getService(String, String) - Method in interface io.cdap.wrangler.api.ExecutorContext

Returns a valid service url.

getSource() - Method in class io.cdap.wrangler.api.SourceInfo

getSourceInfo() - Method in class io.cdap.wrangler.api.TokenGroup

getSources() - Method in class io.cdap.wrangler.api.lineage.Relation

getSymbols() - Method in class io.cdap.wrangler.api.CompileStatus

getTargets() - Method in class io.cdap.wrangler.api.lineage.Relation

getThird() - Method in class io.cdap.wrangler.api.Triplet

getTokens() - Method in class io.cdap.wrangler.api.parser.UsageDefinition

This method returns the list of TokenDefinition that should be used for parsing the directive into Arguments.

getTransientStore() - Method in interface io.cdap.wrangler.api.ExecutorContext

getType() - Method in class io.cdap.wrangler.api.lineage.Relation

getValue(int) - Method in class io.cdap.wrangler.api.Row

Gets a value of row at specified index.

getValue(String) - Method in class io.cdap.wrangler.api.Row

Gets value based on the column name.

getVariables() - Method in interface io.cdap.wrangler.api.TransientStore

Set of all the variables.

getVersion() - Method in class io.cdap.wrangler.api.RecipeSymbol

Returns the version of the grammar as specified in the recipe.

GrammarMigrator - Interface in io.cdap.wrangler.api

This is a interface for migrating grammar from one version to other.

H

hasAlias(String) - Method in interface io.cdap.wrangler.api.DirectiveAlias

Checks if the directive is aliased.

hasAlias(String) - Method in class io.cdap.wrangler.api.DirectiveConfig

Checks if a directive is aliased.

I

id() - Method in class io.cdap.wrangler.api.lineage.Relation

Deprecated.

this id is no longer needed to construct the relation, the wrangler transform will generate id for the relation

Identifier - Class in io.cdap.wrangler.api.parser

The Identifier class wraps the primitive type String in a object.

Identifier(String) - Constructor for class io.cdap.wrangler.api.parser.Identifier

Allocates a String object representing the value argument.

increment(TransientVariableScope, String, long) - Method in interface io.cdap.wrangler.api.TransientStore

Increments a value of the variable.

initialize(Arguments) - Method in interface io.cdap.wrangler.api.Executor

This method provides a way for the custom directive writer the ability to access the arguments passed by the users.

initialize(DirectiveContext) - Method in interface io.cdap.wrangler.api.RecipeParser

Initialises the directive with a DirectiveContext.

initialize(RecipeParser, ExecutorContext) - Method in interface io.cdap.wrangler.api.RecipePipeline

Initializes the wrangle pipeline using the directives.

intValue() - Method in class io.cdap.wrangler.api.LazyNumber

Returns the value of the specified number as an int.

io.cdap.wrangler.api - package io.cdap.wrangler.api

APIs for working with wrangler.

io.cdap.wrangler.api.annotations - package io.cdap.wrangler.api.annotations

Collection of annotations used for annotaing Directives and classes of wrangler project.

io.cdap.wrangler.api.lineage - package io.cdap.wrangler.api.lineage

io.cdap.wrangler.api.parser - package io.cdap.wrangler.api.parser

APIs for parsing directives.

isExcluded(String) - Method in class io.cdap.wrangler.api.DirectiveConfig

Checks if the directive should be excluded.

isExcluded(String) - Method in interface io.cdap.wrangler.api.DirectiveEnforcer

Checks if the directive is being excluded from being used.

isShownInWrangler() - Method in class io.cdap.wrangler.api.ErrorRecordBase

isShownInWrangler() - Method in exception io.cdap.wrangler.api.ErrorRowException

isSuccess() - Method in class io.cdap.wrangler.api.CompileStatus

iterator() - Method in exception io.cdap.wrangler.api.CompileException

iterator() - Method in class io.cdap.wrangler.api.RecipeSymbol

Returns an iterator to the list of token groups maintained by this object.

iterator() - Method in class io.cdap.wrangler.api.TokenGroup

L

label() - Method in class io.cdap.wrangler.api.parser.TokenDefinition

LazyNumber - Class in io.cdap.wrangler.api

This class holds a number value that is lazily converted to a specific number type

LazyNumber(String) - Constructor for class io.cdap.wrangler.api.LazyNumber

length() - Method in class io.cdap.wrangler.api.Row

line() - Method in interface io.cdap.wrangler.api.Arguments

Returns the source line number these arguments were parsed from.

Lineage - Interface in io.cdap.wrangler.api.lineage

This class Lineage defines a mutation defined by the directive that gets capture as lineage.

lineage() - Method in interface io.cdap.wrangler.api.lineage.Lineage

Returns a Mutation that can be used to generate lineage.

longValue() - Method in class io.cdap.wrangler.api.LazyNumber

Returns the value of the specified number as a long.

M

Many - Class in io.cdap.wrangler.api.lineage

Many class is a helper to define many-to-one or one-to-many or many-to-many relations.

message - Variable in class io.cdap.wrangler.api.ErrorRecordBase

migrate() - Method in interface io.cdap.wrangler.api.GrammarMigrator

Migrates each directive from one version to other.

Mutation - Class in io.cdap.wrangler.api.lineage

The Mutation class represents a collection of relations which can be used to generate lineage for a directive.

Mutation.Builder - Class in io.cdap.wrangler.api.lineage

Builder to create Mutation.

N

name() - Method in class io.cdap.wrangler.api.parser.TokenDefinition

nextId() - Static method in class io.cdap.wrangler.api.SUID

Creates a unique 64 bits ID by aggregating the current time in milliseconds since epoch (Jan.

Numeric - Class in io.cdap.wrangler.api.parser

Class description here.

Numeric(LazyNumber) - Constructor for class io.cdap.wrangler.api.parser.Numeric

NumericList - Class in io.cdap.wrangler.api.parser

Class description here.

NumericList(List<LazyNumber>) - Constructor for class io.cdap.wrangler.api.parser.NumericList

O

of(String...) - Static method in class io.cdap.wrangler.api.lineage.Many

Method provides an easy way to translate ellipses parameters into a array of columns.

of(Collection<String>) - Static method in class io.cdap.wrangler.api.lineage.Many

List of columns of type string as source or target.

Optional - Class in io.cdap.wrangler.api

This class Optional is a helper class used in specifying whether a argument for the directive is optional or not.

Optional() - Constructor for class io.cdap.wrangler.api.Optional

optional() - Method in class io.cdap.wrangler.api.parser.TokenDefinition

ordinal() - Method in class io.cdap.wrangler.api.parser.TokenDefinition

P

Pair<F,S> - Class in io.cdap.wrangler.api

A pair consisting of two elements - first & second.

Pair(F, S) - Constructor for class io.cdap.wrangler.api.Pair

parse() - Method in interface io.cdap.wrangler.api.RecipeParser

Generates a configured set of Executor to be executed.

Properties - Class in io.cdap.wrangler.api.parser

Class description here.

Properties(Map<String, Token>) - Constructor for class io.cdap.wrangler.api.parser.Properties

Public - Annotation Type in io.cdap.wrangler.api.annotations

Annotation for marking classes as public, stable interfaces.

PublicEvolving - Annotation Type in io.cdap.wrangler.api.annotations

Annotation to mark classes and methods for public use, but with evolving interfaces.

R

Ranges - Class in io.cdap.wrangler.api.parser

Class description here.

Ranges(List<Triplet<Numeric, Numeric, String>>) - Constructor for class io.cdap.wrangler.api.parser.Ranges

readable(String, Object...) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

An easy way to created a formatted string of transformation.

readable(String, List<Object>) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A variation to specify the readable string for transformation.

readable() - Method in class io.cdap.wrangler.api.lineage.Mutation

RecipeException - Exception in io.cdap.wrangler.api

A RecipePipeline specific exception used for communicating issues with execution of pipeline.

RecipeException(Exception) - Constructor for exception io.cdap.wrangler.api.RecipeException

RecipeException(String) - Constructor for exception io.cdap.wrangler.api.RecipeException

RecipeException(String, Throwable) - Constructor for exception io.cdap.wrangler.api.RecipeException

RecipeParser - Interface in io.cdap.wrangler.api

A specification for how RecipePipeline will process.

RecipePipeline<I,O,E> - Interface in io.cdap.wrangler.api

RecipePipeline executes array of Executor in the order they are specified.

RecipeSymbol - Class in io.cdap.wrangler.api

This object RecipeSymbol stores information about all the TokenGroup ( TokenGroup represents a collection of tokens generated from parsing a single directive).

RecipeSymbol.Builder - Class in io.cdap.wrangler.api

This inner class provides a builder pattern for building the RecipeSymbol object.

relation(ColumnName, ColumnName) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A standard relation between source of ColumnName to target of ColumnName.

relation(String, String) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A standard one-to-one relation.

relation(ColumnName, Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A standard one-to-one relation.

relation(String, Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

A relation specifying one-to-many.

relation(Many, String) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

Specifies a relation that is many-to-one.

relation(Many, Many) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

Specifies Many to Many relation.

relation(Many, ColumnName) - Method in class io.cdap.wrangler.api.lineage.Mutation.Builder

Specifies a many-to-one relation.

Relation - Class in io.cdap.wrangler.api.lineage

The Relation class represents a relation between a list of sources to a list of targets.

Relation.Type - Enum in io.cdap.wrangler.api.lineage

Specifies the type of relations that can exist between source and target.

relations() - Method in class io.cdap.wrangler.api.lineage.Mutation

remove(int) - Method in class io.cdap.wrangler.api.Row

Removes the column and value at given index.

ReportErrorAndProceed - Exception in io.cdap.wrangler.api

Exception throw when the record needs to emitted to error collector.

ReportErrorAndProceed(String, int) - Constructor for exception io.cdap.wrangler.api.ReportErrorAndProceed

reset(TransientVariableScope) - Method in interface io.cdap.wrangler.api.TransientStore

Resets the state of this store.

Row - Class in io.cdap.wrangler.api

Row defines the schema and data on which the wrangler will operate upon.

Row() - Constructor for class io.cdap.wrangler.api.Row

Row(Row) - Constructor for class io.cdap.wrangler.api.Row

Makes a copy of the row.

Row(List<String>) - Constructor for class io.cdap.wrangler.api.Row

Initializes a row with list of columns.

Row(String, Object) - Constructor for class io.cdap.wrangler.api.Row

Initializes the row with column name and value.

S

set(TransientVariableScope, String, Object) - Method in interface io.cdap.wrangler.api.TransientStore

Sets the value of the object for variable named 'name'.

setColumn(int, String) - Method in class io.cdap.wrangler.api.Row

Sets the name of the column at a given index.

setValue(int, Object) - Method in class io.cdap.wrangler.api.Row

Updates the value of the row at index idx.

showInWrangler - Variable in class io.cdap.wrangler.api.ErrorRecordBase

size() - Method in interface io.cdap.wrangler.api.Arguments

Returns the number of tokens that are mapped to arguments.

size() - Method in class io.cdap.wrangler.api.RecipeSymbol

Returns number of groups tokenized and parsed.

size() - Method in class io.cdap.wrangler.api.TokenGroup

source() - Method in interface io.cdap.wrangler.api.Arguments

This method returns the original source line of the directive as specified the user.

SourceInfo - Class in io.cdap.wrangler.api

Class description here.

SourceInfo(int, int, String) - Constructor for class io.cdap.wrangler.api.SourceInfo

SUID - Class in io.cdap.wrangler.api

This class SUID creates a unique 64-bit ID with capacity to generate around 64K unique ids within a millisecond.

SyntaxError - Class in io.cdap.wrangler.api.parser

The class SyntaxError contains information about the errors observed during parsing of the recipe.

SyntaxError(int, int, String, String) - Constructor for class io.cdap.wrangler.api.parser.SyntaxError

T

Text - Class in io.cdap.wrangler.api.parser

Class description here.

Text(String) - Constructor for class io.cdap.wrangler.api.parser.Text

TextList - Class in io.cdap.wrangler.api.parser

Class description here.

TextList(List<String>) - Constructor for class io.cdap.wrangler.api.parser.TextList

toJson() - Method in interface io.cdap.wrangler.api.Arguments

Returns JsonElement representation of this object.

toJson() - Method in class io.cdap.wrangler.api.DirectiveConfig

Converts this object into a JsonElement.

toJson() - Method in class io.cdap.wrangler.api.parser.Bool

Returns the members of this Bool object as a JsonElement.

toJson() - Method in class io.cdap.wrangler.api.parser.BoolList

Returns the members of this BoolList object as a JsonElement.

toJson() - Method in class io.cdap.wrangler.api.parser.ColumnName

toJson() - Method in class io.cdap.wrangler.api.parser.ColumnNameList

toJson() - Method in class io.cdap.wrangler.api.parser.DirectiveName

toJson() - Method in class io.cdap.wrangler.api.parser.Expression

toJson() - Method in class io.cdap.wrangler.api.parser.Identifier

Returns the members of this Identifier object as a JsonElement.

toJson() - Method in class io.cdap.wrangler.api.parser.Numeric

toJson() - Method in class io.cdap.wrangler.api.parser.NumericList

toJson() - Method in class io.cdap.wrangler.api.parser.Properties

toJson() - Method in class io.cdap.wrangler.api.parser.Ranges

toJson() - Method in class io.cdap.wrangler.api.parser.Text

toJson() - Method in class io.cdap.wrangler.api.parser.TextList

toJson() - Method in interface io.cdap.wrangler.api.parser.Token

The class implementing this interface will return the JsonElement instance including the values of the object.

toJson() - Method in class io.cdap.wrangler.api.RecipeSymbol

This method toJson returns the JsonElement object representation of this object.

toJson() - Method in class io.cdap.wrangler.api.SourceInfo

Token - Interface in io.cdap.wrangler.api.parser

The Token class represents the object that contains the value and type of the token as parsed by the parser of the grammar defined for recipe.

TokenDefinition - Class in io.cdap.wrangler.api.parser

The TokenDefinition class represents a definition of token as specified by the user while defining a directive usage.

TokenDefinition(String, TokenType, String, int, boolean) - Constructor for class io.cdap.wrangler.api.parser.TokenDefinition

TokenGroup - Class in io.cdap.wrangler.api

Class description here.

TokenGroup() - Constructor for class io.cdap.wrangler.api.TokenGroup

TokenGroup(SourceInfo) - Constructor for class io.cdap.wrangler.api.TokenGroup

TokenType - Enum in io.cdap.wrangler.api.parser

The TokenType class provides the enumerated types for different types of tokens that are supported by the grammar.

toString() - Method in class io.cdap.wrangler.api.LazyNumber

toString() - Method in class io.cdap.wrangler.api.parser.SyntaxError

toString() - Method in class io.cdap.wrangler.api.parser.UsageDefinition

This method converts the UsageDefinition into a usage string for this directive.

toString() - Method in class io.cdap.wrangler.api.SourceInfo

TransientStore - Interface in io.cdap.wrangler.api

TransientStore is an interface that holds volatile information that's present across all the steps associated with the directives that are processing a single record.

TransientVariableScope - Enum in io.cdap.wrangler.api

TransientVariableScope defines the scope of the transient variable.

Triplet<F,S,T> - Class in io.cdap.wrangler.api

A triplet consisting of three elements - first, second & third.

Triplet(F, S, T) - Constructor for class io.cdap.wrangler.api.Triplet

TRUE - Static variable in class io.cdap.wrangler.api.Optional

When an argument is optional, TRUE is specified.

type(String) - Method in interface io.cdap.wrangler.api.Arguments

Each token is defined as one of the types defined in the class TokenType.

TYPE - Static variable in interface io.cdap.wrangler.api.Directive

This defines a interface variable that is static and final for specify the type of the plugin this interface would provide.

type() - Method in class io.cdap.wrangler.api.parser.Bool

Returns the type of this Bool object as a TokenType enum.

type() - Method in class io.cdap.wrangler.api.parser.BoolList

Returns the type of this BoolList object as a TokenType enum.

type() - Method in class io.cdap.wrangler.api.parser.ColumnName

type() - Method in class io.cdap.wrangler.api.parser.ColumnNameList

type() - Method in class io.cdap.wrangler.api.parser.DirectiveName

type() - Method in class io.cdap.wrangler.api.parser.Expression

type() - Method in class io.cdap.wrangler.api.parser.Identifier

Returns the type of this Identifier object as a TokenType enum.

type() - Method in class io.cdap.wrangler.api.parser.Numeric

type() - Method in class io.cdap.wrangler.api.parser.NumericList

type() - Method in class io.cdap.wrangler.api.parser.Properties

type() - Method in class io.cdap.wrangler.api.parser.Ranges

type() - Method in class io.cdap.wrangler.api.parser.Text

type() - Method in class io.cdap.wrangler.api.parser.TextList

type() - Method in interface io.cdap.wrangler.api.parser.Token

Returns the TokenType of the object represented by the implementation of this interface.

type() - Method in class io.cdap.wrangler.api.parser.TokenDefinition

U

Usage - Annotation Type in io.cdap.wrangler.api.annotations

A interface defining the usage for the directive.

UsageDefinition - Class in io.cdap.wrangler.api.parser

This class UsageDefinition provides a way for users to registers the argument for UDDs.

UsageDefinition.Builder - Class in io.cdap.wrangler.api.parser

This inner builder class provides a way to create UsageDefinition object.

V

value(String) - Method in interface io.cdap.wrangler.api.Arguments

This method returns the token value based on the name specified in the argument.

value() - Method in class io.cdap.wrangler.api.parser.Bool

Returns the value of this Boolean object as a boolean primitive.

value() - Method in class io.cdap.wrangler.api.parser.BoolList

Returns the value of this BoolList object as a list of boolean primitive.

value() - Method in class io.cdap.wrangler.api.parser.ColumnName

value() - Method in class io.cdap.wrangler.api.parser.ColumnNameList

value() - Method in class io.cdap.wrangler.api.parser.DirectiveName

value() - Method in class io.cdap.wrangler.api.parser.Expression

value() - Method in class io.cdap.wrangler.api.parser.Identifier

Returns the value of this String object as a boolean primitive.

value() - Method in class io.cdap.wrangler.api.parser.Numeric

value() - Method in class io.cdap.wrangler.api.parser.NumericList

value() - Method in class io.cdap.wrangler.api.parser.Properties

value() - Method in class io.cdap.wrangler.api.parser.Ranges

value() - Method in class io.cdap.wrangler.api.parser.Text

value() - Method in class io.cdap.wrangler.api.parser.TextList

value() - Method in interface io.cdap.wrangler.api.parser.Token

Returns the value of the object wrapped by the implementation of this interface.

valueOf(String) - Static method in enum io.cdap.wrangler.api.ExecutorContext.Environment

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.cdap.wrangler.api.lineage.Relation.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.cdap.wrangler.api.parser.TokenType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.cdap.wrangler.api.TransientVariableScope

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.cdap.wrangler.api.ExecutorContext.Environment

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.cdap.wrangler.api.lineage.Relation.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.cdap.wrangler.api.parser.TokenType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.cdap.wrangler.api.TransientVariableScope

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P R S T U V