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

Class RenameFieldsAction

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineObject

com.northconcepts.datapipeline.foundations.pipeline.action.PipelineAction

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

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataReaderAction, JavaCodeGenerator, Serializable

public class RenameFieldsAction
extends PipelineAction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenameFieldsAction.FieldMapping

Field Summary

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 and Description
RenameFieldsAction()

Method Summary

Modifier and Type	Method and Description
RenameFieldsAction	add(String source, String target)
DataReader	apply(DataReader reader)
RenameFieldsAction	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
PipelineAction	fromXmlElement(Element element)
void	generateJavaCode(JavaCodeBuilder code)
List<RenameFieldsAction.FieldMapping>	getMapping()
boolean	isParseFieldNamesAsFieldPath() Indicates if each source field name in the mappings should be treated as a FieldPath expression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false).
RenameFieldsAction	setMapping(List<RenameFieldsAction.FieldMapping> mapping)
RenameFieldsAction	setParseFieldNamesAsFieldPath(boolean parseFieldNamesAsFieldPath) Indicates if each source field name in the mappings should be treated as a FieldPath expression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false).
PipelineAction	setPipeline(Pipeline pipeline)
Record	toRecord()
Element	toXmlElement(Document document)

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

escapeJavaString, getCode, getDescription, getDisplayText, getPipeline, setDescription, 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.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

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

newInstanceFromJson

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

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

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

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

RenameFieldsAction

public RenameFieldsAction()

Method Detail

setPipeline

public PipelineAction setPipeline(Pipeline pipeline)

Overrides:

setPipeline in class PipelineAction

getMapping

public List<RenameFieldsAction.FieldMapping> getMapping()

setMapping

public RenameFieldsAction setMapping(List<RenameFieldsAction.FieldMapping> mapping)

add

public RenameFieldsAction add(String source,
                              String target)

isParseFieldNamesAsFieldPath

public boolean isParseFieldNamesAsFieldPath()

Indicates if each source field name in the mappings should be treated as a FieldPath expression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false). Setting this to false allows white spaces and special characters to be used in the source field names without quoting and escaping internal quotes.

setParseFieldNamesAsFieldPath

public RenameFieldsAction setParseFieldNamesAsFieldPath(boolean parseFieldNamesAsFieldPath)

Indicates if each source field name in the mappings should be treated as a FieldPath expression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false). Setting this to false allows white spaces and special characters to be used in the source field names without quoting and escaping internal quotes.

apply

public DataReader apply(DataReader reader)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class PipelineAction

fromRecord

public RenameFieldsAction 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

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class PipelineAction

fromXmlElement

public PipelineAction fromXmlElement(Element element)

Specified by:

fromXmlElement in interface XmlSerializable

Overrides:

fromXmlElement in class PipelineAction

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

Overrides:

generateJavaCode in class PipelineAction