Package com.northconcepts.datapipeline.transform

Class RemoveFields

java.lang.Object
com.northconcepts.datapipeline.transform.Transformer
com.northconcepts.datapipeline.transform.RemoveFields
Direct Known Subclasses:
ExcludeFields
public class RemoveFields extends Transformer
See FieldPath for supported field name expressions.

  • Constructor Details

    • RemoveFields

      public RemoveFields(Collection<String> fieldNames)
      Creates a transformer that removes the given fields from each record, ignoring any that are missing.

    • RemoveFields

      public RemoveFields(String... fieldNames)
      Creates a transformer that removes the given fields from each record, ignoring any that are missing.

  • Method Details

    • add

      public RemoveFields add(Collection<String> fieldNames)
      Adds more fields to remove; a null collection is ignored.

    • add

      public RemoveFields add(String... fieldNames)
      Adds more fields to remove.

    • 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