Class FieldLineage

java.lang.Object
com.northconcepts.datapipeline.lineage.FieldLineage

public class FieldLineage extends Object
Convenience wrapper to read and write field-level data lineage properties.
  • Field Details

    • ORIGINAL_FIELD_INDEX

      public static final String ORIGINAL_FIELD_INDEX
      The index of a field set by the DataReader before any transformation or operation was performed.
      See Also:
    • ORIGINAL_FIELD_NAME

      public static final String ORIGINAL_FIELD_NAME
      The name of a field set by the DataReader before any transformation or operation was performed.
      See Also:
    • DATABASE_COLUMN_NAME

      public static final String DATABASE_COLUMN_NAME
      The column name returned from the database for this field.
      See Also:
    • FIELD_SCHEMA

      public static final String FIELD_SCHEMA
      The field's schema for ORC and Parquet files.
      See Also:
    • DATABASE_COLUMN_SQL_TYPE

      public static final String DATABASE_COLUMN_SQL_TYPE
      The column type returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_DISPLAY_SIZE

      public static final String DATABASE_COLUMN_DISPLAY_SIZE
      The column display size returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_SCALE

      public static final String DATABASE_COLUMN_SCALE
      The column scale returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_PRECISION

      public static final String DATABASE_COLUMN_PRECISION
      The column precision returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_SCHEMA_NAME

      public static final String DATABASE_COLUMN_SCHEMA_NAME
      The schema name of a column returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_CATALOG_NAME

      public static final String DATABASE_COLUMN_CATALOG_NAME
      The catalog name of a column returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_TABLE_NAME

      public static final String DATABASE_COLUMN_TABLE_NAME
      The table name of a column returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_TYPE_NAME

      public static final String DATABASE_COLUMN_TYPE_NAME
      The column type name returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_CLASS_NAME

      public static final String DATABASE_COLUMN_CLASS_NAME
      The class name of a column returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_SIGNED

      public static final String DATABASE_COLUMN_SIGNED
      The column isSigned value returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_NULLABLE

      public static final String DATABASE_COLUMN_NULLABLE
      The column isNullable value returned from the database for this field.
      See Also:
    • DATABASE_COLUMN_JAVA_TYPE

      public static final String DATABASE_COLUMN_JAVA_TYPE
      The Java type mapped from java.sql.Types.
      See Also:
    • DATABASE_COLUMN_FIELD_TYPE

      public static final String DATABASE_COLUMN_FIELD_TYPE
      See Also:
  • Constructor Details

    • FieldLineage

      public FieldLineage()
    • FieldLineage

      public FieldLineage(Field field)
  • Method Details

    • getField

      public Field getField()
    • setField

      public FieldLineage setField(Field field)
    • getOriginalFieldIndex

      public Integer getOriginalFieldIndex()
      The index of a field set by the DataReader before any transformation or operation was performed.
    • setOriginalFieldIndex

      public FieldLineage setOriginalFieldIndex(int fieldIndex)
      The index of a field set by the DataReader before any transformation or operation was performed.
    • getOriginalFieldName

      public String getOriginalFieldName()
      The name of a field set by the DataReader before any transformation or operation was performed.
    • setOriginalFieldName

      public FieldLineage setOriginalFieldName(String fieldName)
      The name of a field set by the DataReader before any transformation or operation was performed.
    • getDatabaseUrl

      public String getDatabaseUrl()
      The JDBC connection URL.
    • setDatabaseUrl

      public FieldLineage setDatabaseUrl(String url)
      The JDBC connection URL.
    • getDatabaseQuery

      public String getDatabaseQuery()
      The SQL statement used to query the database.
    • setDatabaseQuery

      public FieldLineage setDatabaseQuery(String queryString)
      The SQL statement used to query the database.
    • getDatabaseColumnName

      public String getDatabaseColumnName()
      The column name returned from the database for this field.
    • setDatabaseColumnName

      public FieldLineage setDatabaseColumnName(String columnName)
      The column name returned from the database for this field.
    • getFile

      public File getFile()
      The java.io.File used to create the DataReader.
    • setFile

      public FieldLineage setFile(File file)
      The java.io.File used to create the DataReader.
    • getFileLineNumber

      public Long getFileLineNumber()
      The line number in the input file starting with 0.
    • setFileLineNumber

      public FieldLineage setFileLineNumber(Long lineNumber)
      The line number in the input file starting with 0.
    • getFileColumnNumber

      public Long getFileColumnNumber()
      The beginning column number in the input file starting with 0.
    • setFileColumnNumber

      public FieldLineage setFileColumnNumber(Long columnNumber)
      The beginning column number in the input file starting with 0.
    • getRecordNumber

      public Long getRecordNumber()
      The sequential record number starting with 0.
    • setRecordNumber

      public FieldLineage setRecordNumber(long recordNumber)
      The sequential record number starting with 0.
    • getFieldSchema

      public String getFieldSchema()
      The field's schema for ORC and Parquet files.
    • setFieldSchema

      public FieldLineage setFieldSchema(String fieldSchema)
      The field's schema for ORC and Parquet files.
    • getDatabaseColumnSqlType

      public Integer getDatabaseColumnSqlType()
      The column type returned from the database for this field.
    • setDatabaseColumnSqlType

      public FieldLineage setDatabaseColumnSqlType(int sqlType)
      The column type returned from the database for this field.
    • getDatabaseColumnDisplaySize

      public Integer getDatabaseColumnDisplaySize()
      The column display size returned from the database for this field.
    • setDatabaseColumnDisplaySize

      public FieldLineage setDatabaseColumnDisplaySize(int displaySize)
      The column display size returned from the database for this field.
    • getDatabaseColumnScale

      public Integer getDatabaseColumnScale()
      The column scale returned from the database for this field.
    • setDatabaseColumnScale

      public FieldLineage setDatabaseColumnScale(int scale)
      The column scale returned from the database for this field.
    • getDatabaseColumnPrecision

      public Integer getDatabaseColumnPrecision()
      The column precision returned from the database for this field.
    • setDatabaseColumnPrecision

      public FieldLineage setDatabaseColumnPrecision(int precision)
      The column precision returned from the database for this field.
    • getDatabaseColumnSchemaName

      public String getDatabaseColumnSchemaName()
      The schema name of a column returned from the database for this field.
    • setDatabaseColumnSchemaName

      public FieldLineage setDatabaseColumnSchemaName(String schemaName)
      The schema name of a column returned from the database for this field.
    • getDatabaseColumnCatalogName

      public String getDatabaseColumnCatalogName()
      The catalog name of a column returned from the database for this field.
    • setDatabaseColumnCatalogName

      public FieldLineage setDatabaseColumnCatalogName(String catalogName)
      The catalog name of a column returned from the database for this field.
    • getDatabaseColumnTableName

      public String getDatabaseColumnTableName()
      The table name of a column returned from the database for this field.
    • setDatabaseColumnTableName

      public FieldLineage setDatabaseColumnTableName(String tableName)
      The table name of a column returned from the database for this field.
    • getDatabaseColumnTypeName

      public String getDatabaseColumnTypeName()
      The column type name returned from the database for this field.
    • setDatabaseColumnTypeName

      public FieldLineage setDatabaseColumnTypeName(String typeName)
      The column type name returned from the database for this field.
    • getDatabaseColumnClassName

      public String getDatabaseColumnClassName()
      The class name of a column returned from the database for this field.
    • setDatabaseColumnClassName

      public FieldLineage setDatabaseColumnClassName(String className)
      The class name of a column returned from the database for this field.
    • getDatabaseColumnSigned

      public Boolean getDatabaseColumnSigned()
      The column isSigned value returned from the database for this field.
    • setDatabaseColumnSigned

      public FieldLineage setDatabaseColumnSigned(boolean signed)
      The column isSigned value returned from the database for this field.
    • getDatabaseColumnNullable

      public Boolean getDatabaseColumnNullable()
      The column isNullable value returned from the database for this field.
    • setDatabaseColumnNullable

      public FieldLineage setDatabaseColumnNullable(boolean nullable)
      The column isNullable value returned from the database for this field.
    • getDatabaseColumnJavaType

      public Class<?> getDatabaseColumnJavaType()
      The Java type mapped from java.sql.Types.
    • setDatabaseColumnJavaType

      public FieldLineage setDatabaseColumnJavaType(Class<?> javaType)
      The Java type mapped from java.sql.Types.
    • getDatabaseColumnFieldType

      public FieldType getDatabaseColumnFieldType()
      The FieldType mapped from the Java type of the database column for this field.
    • setDatabaseColumnFieldType

      public FieldLineage setDatabaseColumnFieldType(FieldType fieldType)
      The FieldType mapped from the Java type of the database column for this field.
    • copyFrom

      public FieldLineage copyFrom(RecordLineage recordLineage)
      Copies the file, line and column numbers, database URL and query, and record number from the record's lineage, keeping any of these values this field already has.