com.northconcepts.datapipeline.foundations.pipeline.action.transform.CopyFieldsAction

All Implemented Interfaces:: DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataReaderAction, SqlSelectGenerator, JavaCodeGenerator, Serializable

public class CopyFieldsAction extends PipelineAction

A PipelineAction that copies the values of source fields to target fields.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

CopyFieldsAction.FieldMapping

A copy of one source field to a target field, optionally overwriting an existing target.
Field Summary

Fields

Modifier and Type

Field

Description

List<CopyFieldsAction.FieldMapping>

mapping

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
internalId, internalName, log, TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
XML_SERIALIZED_CLASS_NAME
Constructor Summary

Constructors

Constructor

Description

CopyFieldsAction()
Method Summary

Modifier and Type

Method

Description

CopyFieldsAction

add(CopyFieldsAction.FieldMapping fieldMapping)

CopyFieldsAction

add(String source, String target)

Copies the source field to the target field, leaving the target unchanged if it already exists.

CopyFieldsAction

add(String source, String target, boolean overwrite)

Copies the source field to the target field; overwrite replaces an existing target instead of leaving it unchanged.

DataReader

apply(DataReader reader)

Returns a reader that applies this action to the records of the given reader, usually by wrapping it.

CopyFieldsAction

fromRecord(Record source)

Loads this instance's state from a record and returns this (for fluid API call chaining).

CopyFieldsAction

fromXmlElement(Element element)

void

generateJavaCode(JavaCodeBuilder code)

Appends Java source code representing this object to the given builder.

Select

generateSqlSelect(QuerySource... querySources)

Generates a SQL SELECT statement from the given query sources.

List<CopyFieldsAction.FieldMapping>

getMapping()

CopyFieldsAction

setMapping(List<CopyFieldsAction.FieldMapping> mapping)

Record

toRecord()

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

Element

toXmlElement(Document document)

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

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.action.PipelineAction
escapeJavaString, getCode, getDescription, getDisplayText, getPipeline, setDescription, setPipeline, toString

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromJson, fromJson, toJson, toJson, toJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
fromXml, fromXml, toXml, toXml, toXml, toXml, toXml

Field Details
- mapping
  
  public List<CopyFieldsAction.FieldMapping> mapping
Constructor Details
- CopyFieldsAction
  
  public CopyFieldsAction()
Method Details
- getMapping
  
  public List<CopyFieldsAction.FieldMapping> getMapping()
- setMapping
  
  public CopyFieldsAction setMapping(List<CopyFieldsAction.FieldMapping> mapping)
- add
  
  public CopyFieldsAction add(String source, String target)
  
  Copies the source field to the target field, leaving the target unchanged if it already exists.
- add
  
  public CopyFieldsAction add(String source, String target, boolean overwrite)
  
  Copies the source field to the target field; overwrite replaces an existing target instead of leaving it unchanged.
- add
  
  public CopyFieldsAction add(CopyFieldsAction.FieldMapping fieldMapping)
- apply
  
  public DataReader apply(DataReader reader)
  
  Description copied from interface: DataReaderAction
  
  Returns a reader that applies this action to the records of the given reader, usually by wrapping it.
- generateSqlSelect
  
  public Select generateSqlSelect(QuerySource... querySources)
  
  Description copied from interface: SqlSelectGenerator
  
  Generates a SQL SELECT statement from the given query sources.
  
  Parameters:
  
  querySources - the sources to include in the SELECT statement
  
  Returns:
  
  a Select object representing the generated SQL statement
- 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 PipelineAction
- 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 PipelineAction
- fromXmlElement
  
  public CopyFieldsAction fromXmlElement(Element element)
  
  Specified by:
  
  fromXmlElement in interface XmlSerializable
  
  Overrides:
  
  fromXmlElement in class PipelineAction
- fromRecord
  
  public CopyFieldsAction 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 PipelineAction
  
  Parameters:
  
  source -
  
  Returns:
  
  this instance.
- generateJavaCode
  
  public void generateJavaCode(JavaCodeBuilder code)
  
  Description copied from interface: JavaCodeGenerator
  
  Appends Java source code representing this object to the given builder.
  
  Specified by:
  
  generateJavaCode in interface JavaCodeGenerator
  
  Overrides:
  
  generateJavaCode in class PipelineAction

Class CopyFieldsAction

Nested Class Summary

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.action.PipelineAction

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Field Details

mapping

Constructor Details

CopyFieldsAction

Method Details

getMapping

setMapping

add

add

add

apply

generateSqlSelect

toRecord

toXmlElement

fromXmlElement

fromRecord

generateJavaCode