Package com.northconcepts.datapipeline.transform

Class RenameField

java.lang.Object
com.northconcepts.datapipeline.transform.Transformer
com.northconcepts.datapipeline.transform.RenameField
public class RenameField extends Transformer
See FieldPath for supported field name expressions.

  • Constructor Details

    • RenameField

      public RenameField(String oldFieldPathExpression, String newName)
      Creates a new transformer to rename fields in a dataset using an expression as the source and a new name as the target. This transformer does not change the nested location of the field, only its name. See FieldPath for supported field name expressions.
      Parameters:
      oldFieldPathExpression -
      newName -

    • RenameField

      public RenameField(FieldPath oldFieldPath, String newName)
      Creates a new transformer to rename fields in a dataset using a FieldPath as the source and a new name as the target. This transformer does not change the nested location of the field, only its name. See FieldPath for supported field name expressions.
      Parameters:
      oldFieldPath -
      newName -

  • Method Details

    • getOldFieldPath

      public FieldPath getOldFieldPath()

    • getOldFieldPathAsString

      public String getOldFieldPathAsString()

    • getOldName

      @Deprecated public String getOldName()
      Deprecated.
      use getOldFieldPathAsString() instead.

    • getNewName

      public String getNewName()

    • isAllowDuplicateFieldNames

      public boolean isAllowDuplicateFieldNames()
      Indicates if a field may be renamed to the name of another field in its record instead of throwing (default is false).

    • setAllowDuplicateFieldNames

      public RenameField setAllowDuplicateFieldNames(boolean allowDuplicateFieldNames)
      Indicates if a field may be renamed to the name of another field in its record instead of throwing (default is false).

    • transform

      public boolean transform(Record record) throws Throwable
      Description copied from class: Transformer
      Applies this transformer to a record on its way through a TransformingReader or TransformingWriter.

      Contract for subclasses (see also docs/authoring/Transformer.md):

      • Mutate record in place as needed.
      • Return true to keep the record in the pipeline.
      • Return false to drop the record (the host routes it to a discard writer if one is configured, otherwise it disappears).
      • Throw to fail (or route to a discard writer, depending on host configuration).
      • Do not call incrementRecordCount() on the host endpoint; the host handles it.
      Specified by:
      transform in class Transformer
      Throws:
      Throwable

    • toString

      public String toString()
      Overrides:
      toString in class Object