io.cdap.wrangler.api.lineage

Class Mutation.Builder

java.lang.Object

io.cdap.wrangler.api.lineage.Mutation.Builder

Enclosing class:

Mutation

public static class Mutation.Builder
extends Object

Builder to create Mutation.

Constructor Summary

Constructors

Constructor and Description
Builder() A builder constructor.

Method Summary

Modifier and Type	Method and Description
Mutation.Builder	all(Many sources) A relation that has association with all in the output field.
Mutation.Builder	all(Many sources, Many targets) A relation that has association with a set of targets + all in the output field.
Mutation	build()
Mutation.Builder	conditional(String source, String target) A relation that's conditional, depending on whether source and target are same.
Mutation.Builder	create(Many targets) Specifies a relation that has no cause but effect.
Mutation.Builder	drop(Many sources) Specifies a relation that need to be dropped.
Mutation.Builder	generate(Many targets) A relation that has association with all the input fields.
Mutation.Builder	readable(String format, List<Object> args) A variation to specify the readable string for transformation.
Mutation.Builder	readable(String format, Object... args) An easy way to created a formatted string of transformation.
Mutation.Builder	relation(ColumnName source, ColumnName target) A standard relation between source of ColumnName to target of ColumnName.
Mutation.Builder	relation(ColumnName source, Many targets) A standard one-to-one relation.
Mutation.Builder	relation(Many sources, ColumnName target) Specifies a many-to-one relation.
Mutation.Builder	relation(Many sources, Many targets) Specifies Many to Many relation.
Mutation.Builder	relation(Many sources, String target) Specifies a relation that is many-to-one.
Mutation.Builder	relation(String source, Many targets) A relation specifying one-to-many.
Mutation.Builder	relation(String source, String target) A standard one-to-one relation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

A builder constructor.

Method Detail

readable

public Mutation.Builder readable(String format,
                                 Object... args)

An easy way to created a formatted string of transformation.

Parameters:

format - a format string.

args - Arguments referenced by the format specifiers in the format string.

Returns:

a instance of Mutation.Builder.

readable

public Mutation.Builder readable(String format,
                                 List<Object> args)

A variation to specify the readable string for transformation.

Parameters:

format - a format string.

args - Arguments referenced by the format specifiers in the format string.

Returns:

a instance of Mutation.Builder.

drop

public Mutation.Builder drop(Many sources)

Specifies a relation that need to be dropped.

Parameters:

sources - a list of sources to be dropped from lineage.

Returns:

a instance of Mutation.Builder.

create

public Mutation.Builder create(Many targets)

Specifies a relation that has no cause but effect.

Parameters:

targets - a list of targets.

Returns:

a instance of Mutation.Builder.

generate

public Mutation.Builder generate(Many targets)

A relation that has association with all the input fields. This method is used usually during set columns scenarios.

Parameters:

targets - a list of targets.

Returns:

a instance of Mutation.Builder.

all

public Mutation.Builder all(Many sources)

A relation that has association with all in the output field. This method is used usually during parse scenarios.

Parameters:

sources - list of sources to be associated with all output.

Returns:

a instance of Mutation.Builder.

all

public Mutation.Builder all(Many sources,
                            Many targets)

A relation that has association with a set of targets + all in the output field. This method is used usually during parse scenarios, where the directive knows some part of the relation, but unclear about the overall outputs it will generate For example, csv parser will parse field body -> a,b,c, and still preserve body.

Parameters:

sources - list of sources to be associated with targets and all output fields.

targets - list of targets to be associated with the sources.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(ColumnName source,
                                 ColumnName target)

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

Parameters:

source - a instance of ColumnName source.

target - a instance of ColumnName target.

Returns:

a instance of Mutation.Builder.

conditional

public Mutation.Builder conditional(String source,
                                    String target)

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

Parameters:

source - a instance of String source.

target - a instance of String target.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(String source,
                                 String target)

A standard one-to-one relation.

Parameters:

source - a source column.

target - a target column.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(ColumnName source,
                                 Many targets)

A standard one-to-one relation.

Parameters:

source - a source column of type ColumnName.

targets - a target column of type ColumnName.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(String source,
                                 Many targets)

A relation specifying one-to-many.

Parameters:

source - a source column of type String.

targets - Many target columns to be associated with source.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(Many sources,
                                 String target)

Specifies a relation that is many-to-one.

Parameters:

sources - Many source columns to be associated with target.

target - a target column of type String.

Returns:

a instance of Mutation.Builder.

relation

public Mutation.Builder relation(Many sources,
                                 Many targets)

Specifies Many to Many relation.

Parameters:

sources - Many source columns to be associated with Many targets.

targets - Many target columns to be associated with Many sources.

Returns:

a instance of Mutation.Builder

relation

public Mutation.Builder relation(Many sources,
                                 ColumnName target)

Specifies a many-to-one relation.

Parameters:

sources - Many source columns to be associated with target.

target - a instance of ColumnName target.

Returns:

a instance of Mutation.Builder.

build

public Mutation build()