Package io.openlineage.client.utils

Class TransformationInfo

java.lang.Object

io.openlineage.client.utils.TransformationInfo

public class TransformationInfo
extends Object

Stores information about transformation type of the dependency between two expressions. The transformation is described by 3 attributes: type, subtype and masking. type indicate whether the transformation is direct (target value was derived from source value) or indirect (target value was influenced by source value). subType further divide the transformations. masking indicates whether the transformation obfuscated the source value

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransformationInfo.Subtypes
static enum	TransformationInfo.Types

Constructor Summary

Constructors

Constructor	Description
TransformationInfo(TransformationInfo.Types type, TransformationInfo.Subtypes subType, String description, Boolean masking)

Method Summary

Modifier and Type	Method	Description
static TransformationInfo	aggregation()	Method that simplifies the creation of an TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation.
static TransformationInfo	aggregation(Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation.
static TransformationInfo	aggregation(String description)	Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation with a description.
static TransformationInfo	aggregation(String description, Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation with a description.
boolean	equals(Object o)
String	getDescription()
Boolean	getMasking()
TransformationInfo.Subtypes	getSubType()
TransformationInfo.Types	getType()
int	hashCode()
static TransformationInfo	identity()	Method that simplifies the creation of an TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.IDENTITY transformation.
static TransformationInfo	identity(String description)	Method that simplifies the creation of an TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.IDENTITY transformation with a description.
static TransformationInfo	indirect(TransformationInfo.Subtypes subType)	Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.INDIRECT transformation.
static TransformationInfo	indirect(TransformationInfo.Subtypes subType, Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.INDIRECT transformation.
static TransformationInfo	indirect(TransformationInfo.Subtypes subType, String description)	Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.INDIRECT transformation with a description.
static TransformationInfo	indirect(TransformationInfo.Subtypes subType, String description, Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.INDIRECT transformation with a description.
TransformationInfo	merge(TransformationInfo another)
TransformationInfo	merge(TransformationInfo another, BinaryOperator<String> descriptionMerger)	Merges current TransformationInfo with another e.g.
OpenLineage.InputFieldTransformations	toInputFieldsTransformations()
String	toString()
static TransformationInfo	transformation()	Method that simplifies the creation of an TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation.
static TransformationInfo	transformation(Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation.
static TransformationInfo	transformation(String description)	Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation with a description.
static TransformationInfo	transformation(String description, Boolean isMasking)	Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation with a description.
TransformationInfo	withDescription(String description)	Returns a TransformationInfo identical to this one, except for the description.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TransformationInfo

public TransformationInfo(TransformationInfo.Types type,
 TransformationInfo.Subtypes subType,
 String description,
 Boolean masking)

Method Details

identity

public static TransformationInfo identity()

Method that simplifies the creation of an TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.IDENTITY transformation.

identity

public static TransformationInfo identity(String description)

Method that simplifies the creation of an TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.IDENTITY transformation with a description.

Parameters:

description - - description of the transformation

transformation

public static TransformationInfo transformation()

Method that simplifies the creation of an TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation.

transformation

public static TransformationInfo transformation(Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation.

Parameters:

isMasking - - is transformation masking

transformation

public static TransformationInfo transformation(String description)

Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation with a description.

Parameters:

description - - description of the transformation

transformation

public static TransformationInfo transformation(String description,
 Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.TRANSFORMATION transformation with a description.

Parameters:

description - - description of the transformation

isMasking - - is transformation masking

aggregation

public static TransformationInfo aggregation()

Method that simplifies the creation of an TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation.

aggregation

public static TransformationInfo aggregation(Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation.

Parameters:

isMasking - - is transformation masking

aggregation

public static TransformationInfo aggregation(String description)

Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation with a description.

Parameters:

description - - description of the transformation

aggregation

public static TransformationInfo aggregation(String description,
 Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.DIRECT, TransformationInfo.Subtypes.AGGREGATION transformation with a description.

Parameters:

description - - description of the transformation

isMasking - - is transformation masking

indirect

public static TransformationInfo indirect(TransformationInfo.Subtypes subType)

Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.INDIRECT transformation.

Parameters:

subType - - the subtype of the transformation viable subtypes: TransformationInfo.Subtypes.CONDITIONAL,TransformationInfo.Subtypes.SORT,TransformationInfo.Subtypes.GROUP_BY,TransformationInfo.Subtypes.JOIN,TransformationInfo.Subtypes.FILTER,

indirect

public static TransformationInfo indirect(TransformationInfo.Subtypes subType,
 Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.INDIRECT transformation.

Parameters:

subType - - the subtype of the transformation viable subtypes: TransformationInfo.Subtypes.CONDITIONAL,TransformationInfo.Subtypes.SORT,TransformationInfo.Subtypes.GROUP_BY,TransformationInfo.Subtypes.JOIN,TransformationInfo.Subtypes.FILTER,

isMasking - - is transformation masking (no indirect transformation is masking, but their dependencies can be)

indirect

public static TransformationInfo indirect(TransformationInfo.Subtypes subType,
 String description)

Method that simplifies the creation of TransformationInfo object representing non-masking, TransformationInfo.Types.INDIRECT transformation with a description.

Parameters:

subType - - the subtype of the transformation viable subtypes: TransformationInfo.Subtypes.CONDITIONAL,TransformationInfo.Subtypes.SORT,TransformationInfo.Subtypes.GROUP_BY,TransformationInfo.Subtypes.JOIN,TransformationInfo.Subtypes.FILTER,

description - - description of the transformation

indirect

public static TransformationInfo indirect(TransformationInfo.Subtypes subType,
 String description,
 Boolean isMasking)

Method that simplifies the creation of TransformationInfo object representing TransformationInfo.Types.INDIRECT transformation with a description.

Parameters:

subType - - the subtype of the transformation viable subtypes: TransformationInfo.Subtypes.CONDITIONAL,TransformationInfo.Subtypes.SORT,TransformationInfo.Subtypes.GROUP_BY,TransformationInfo.Subtypes.JOIN,TransformationInfo.Subtypes.FILTER,

description - - description of the transformation

isMasking - - is transformation masking (no indirect transformation is masking, but their dependencies can be)

withDescription

public TransformationInfo withDescription(String description)

Returns a TransformationInfo identical to this one, except for the description. Returns this when the description is already equal, so cached instances are preserved.

Parameters:

description - - description of the transformation

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

merge

public TransformationInfo merge(TransformationInfo another,
 BinaryOperator<String> descriptionMerger)

Merges current TransformationInfo with another e.g. given two dependencies with transformation types a -> b, t1 and b -> c, t2 the result of merge is transformation type for dependency a -> c

 Rules applied here are:
 1. if current transformation is indirect, new type and subtype is taken from current
 2. if current is not indirect and another is null we can't deduce result so we return null
 3. if another is indirect, new type and subtype is taken from another
 4. otherwise the the type and subtype are taken from the one with lower Enum.ordinal()
 5. if any TransformationInfo has masking set to true, the result has masking set to true
 

Parameters:

another - - TransformationInfo object to be merged with

merge

public TransformationInfo merge(TransformationInfo another)

toInputFieldsTransformations

public OpenLineage.InputFieldTransformations toInputFieldsTransformations()

toString

public String toString()

Overrides:

toString in class Object

getType

public TransformationInfo.Types getType()

getSubType

public TransformationInfo.Subtypes getSubType()

getDescription

public String getDescription()

getMasking

public Boolean getMasking()