Package com.northconcepts.datapipeline.transform

Class SetSequenceNumberField

java.lang.Object
com.northconcepts.datapipeline.transform.Transformer
com.northconcepts.datapipeline.transform.SetSequenceNumberField
public class SetSequenceNumberField extends Transformer
Adds a sequence (auto increment) field with the specified increment (step). See FieldPath for supported field name expressions.

  • Constructor Details

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, long start, long step)
      Creates a transformer that numbers records from start in steps of step, overwriting any existing value.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, double start, double step)
      Creates a transformer that numbers records from start in steps of step, overwriting any existing value.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, BigDecimal start, BigDecimal step)
      Creates a transformer that numbers records from start in steps of step, overwriting any existing value.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, BigInteger start, BigInteger step)
      Creates a transformer that numbers records from start in steps of step, overwriting any existing value.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, long start, long step, boolean overwrite)
      Creates a transformer that numbers records from start in steps of step; when overwrite is false, records that already have the field are skipped without using a number.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, double start, double step, boolean overwrite)
      Creates a transformer that numbers records from start in steps of step; when overwrite is false, records that already have the field are skipped without using a number.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, BigDecimal start, BigDecimal step, boolean overwrite)
      Creates a transformer that numbers records from start in steps of step; when overwrite is false, records that already have the field are skipped without using a number.

    • SetSequenceNumberField

      public SetSequenceNumberField(String name, BigInteger start, BigInteger step, boolean overwrite)
      Creates a transformer that numbers records from start in steps of step; when overwrite is false, records that already have the field are skipped without using a number.

  • Method Details

    • getName

      public String getName()

    • getStart

      public Number getStart()

    • getStep

      public Number getStep()

    • getOverwrite

      public boolean getOverwrite()

    • 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