Class Pipeline

Method Details

• getActions

  public List<PipelineAction> getActions()

  Returns a read-only view of the actions, in the order they are applied.

• getUndoneActions

  public List<PipelineAction> getUndoneActions()

  Returns a read-only view of the actions removed by undoLastAction() that can still be redone.

• getActionCount

  public int getActionCount()

• getUndoneActionCount

  public int getUndoneActionCount()

• addAction

  public Pipeline addAction(PipelineAction action)

  Appends an action, attaches it to this pipeline and clears the redo history.

• addAction

  public Pipeline addAction(Integer index, PipelineAction action)

  Inserts an action at the given 0-based index (or appends it if the index is null), attaches it to this pipeline and clears the redo history.

• setAction

  public Pipeline setAction(int index, PipelineAction action)

  Replaces the action at the given 0-based index.

• setActions

  public Pipeline setActions(List<PipelineAction> actions)

  Replaces all the actions with the given list and clears the redo history.

• undoLastAction

  public PipelineAction undoLastAction()

  Removes the last action and keeps it for redoLastAction(); returns it, or null if there are no actions.

• redoLastAction

  public PipelineAction redoLastAction()

  Re-appends the most recently undone action; returns it, or null if there is nothing to redo.

• generateJavaCodeImpl

  public void generateJavaCodeImpl(JavaCodeBuilder code)

  Description copied from class: AbstractPipeline

  Writes the Java code for this pipeline's own processing, between the input and output code.

  Specified by:

  generateJavaCodeImpl in class AbstractPipeline

• applyDataProcessingImpl

  protected DataReader applyDataProcessingImpl(DataReader reader)

  Description copied from class: AbstractPipeline

  Wraps the reader with this pipeline's own processing; called between the source and target entity transformers.

  Specified by:

  applyDataProcessingImpl in class AbstractPipeline

• toRecord

  public Record toRecord()

  Description copied from interface: RecordSerializable

  Converts this object's state to a record that RecordSerializable.fromRecord(Record) can load.

  Specified by:

  toRecord in interface RecordSerializable

  Overrides:

  toRecord in class AbstractPipeline

• fromRecord

  public Pipeline fromRecord(Record source)

  Description copied from interface: RecordSerializable

  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

  Specified by:

  fromRecord in interface RecordSerializable

  Overrides:

  fromRecord in class AbstractPipeline

  Parameters:

  source -

  Returns:

  this instance.

• toXmlElement

  public Element toXmlElement(Document document)

  Description copied from interface: XmlSerializable

  Returns an element, created with document, describing this object; the default implementation throws a DataException.

  Specified by:

  toXmlElement in interface XmlSerializable

  Overrides:

  toXmlElement in class AbstractPipeline

• fromXmlElement

  public Pipeline fromXmlElement(Element pipelineElement)

  Specified by:

  fromXmlElement in interface XmlSerializable

  Overrides:

  fromXmlElement in class AbstractPipeline

• fromXml

  public Pipeline fromXml(InputStream inputStream)

  Description copied from interface: XmlSerializable

  Parses the XML in the stream and loads this object's state from its root element.

• fromXml

  public Pipeline fromXml(String xml)

• fromJson

  public Pipeline fromJson(InputStream inputStream)

  Description copied from interface: JsonSerializable

  Loads this object's state from the UTF-8 encoded JSON in the stream.

• fromJson

  public Pipeline fromJson(String jsonString)

  Description copied from interface: JsonSerializable

  Loads this object's state from the given JSON text.

  Specified by:

  fromJson in interface JsonSerializable

  Specified by:

  fromJson in interface RecordSerializable

  Overrides:

  fromJson in class AbstractPipeline

• setName

  public Pipeline setName(String name)

  Overrides:

  setName in class AbstractPipeline

• setDescription

  public Pipeline setDescription(String description)

  Overrides:

  setDescription in class AbstractPipeline

• setInput

  public Pipeline setInput(PipelineInput input)

  Overrides:

  setInput in class AbstractPipeline

• setInputAsDataReaderFactory

  public Pipeline setInputAsDataReaderFactory(DataReaderFactory factory)

  Description copied from class: AbstractPipeline

  Sets the input to a DataReaderPipelineInput that creates its readers with the given factory.

  Overrides:

  setInputAsDataReaderFactory in class AbstractPipeline

• setInputAsDataReader

  public Pipeline setInputAsDataReader(DataReader reader)

  Description copied from class: AbstractPipeline

  Sets the input to a DataReaderPipelineInput that always returns the given reader instance.

  Overrides:

  setInputAsDataReader in class AbstractPipeline

• setOutput

  public Pipeline setOutput(PipelineOutput output)

  Overrides:

  setOutput in class AbstractPipeline

• setOutputAsDataWriterFactory

  public Pipeline setOutputAsDataWriterFactory(DataWriterFactory factory)

  Description copied from class: AbstractPipeline

  Sets the output to a DataWriterPipelineOutput that creates its writers with the given factory.

  Overrides:

  setOutputAsDataWriterFactory in class AbstractPipeline

• setOutputAsDataWriter

  public Pipeline setOutputAsDataWriter(DataWriter writer)

  Description copied from class: AbstractPipeline

  Sets the output to a DataWriterPipelineOutput that always returns the given writer instance.

  Overrides:

  setOutputAsDataWriter in class AbstractPipeline

• setSourceEntity

  public Pipeline setSourceEntity(EntityDef sourceEntity)

  Description copied from class: AbstractPipeline

  Sets the schema entity used to convert and validate records read from the input, before any processing (null for none).

  Overrides:

  setSourceEntity in class AbstractPipeline

• setTargetEntity

  public Pipeline setTargetEntity(EntityDef targetEntity)

  Description copied from class: AbstractPipeline

  Sets the schema entity used to convert and validate records after processing, before they are written (null for none).

  Overrides:

  setTargetEntity in class AbstractPipeline

• setMultithreaded

  public Pipeline setMultithreaded(boolean multithreaded)

  Description copied from class: AbstractPipeline

  Indicates if each processing stage runs in its own thread using an AsyncReader (defaults to true).

  Overrides:

  setMultithreaded in class AbstractPipeline

• setDiscardWriter

  public Pipeline setDiscardWriter(DataWriter discardWriter)

  Description copied from class: AbstractPipeline

  Sets the writer that receives records failing source or target entity validation, instead of stopping the pipeline.

  Overrides:

  setDiscardWriter in class AbstractPipeline

• setDiscardReasonFieldName

  public Pipeline setDiscardReasonFieldName(String discardReasonFieldName)

  Description copied from class: AbstractPipeline

  Sets the name of the field added to discarded records to hold the failure message; only allowed with a discard writer.

  Overrides:

  setDiscardReasonFieldName in class AbstractPipeline