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,SqlSelectGenerator,JavaCodeGenerator,Serializable
A
PipelineAction that renames fields; mappings with a blank target or the same name as the source are ignored.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA rename of one source field to a target name. -
Field Summary
Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
internalId, internalName, log, TIMESTAMP_FORMATFields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
SERIALIZED_CLASS_NAME, TYPEFields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
XML_SERIALIZED_CLASS_NAME -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionRenames the source field to the target name; a blank or identical target leaves the field unchanged.apply(DataReader reader) Returns a reader that applies this action to the records of the given reader, usually by wrapping it.fromRecord(Record source) Loads this instance's state from a record and returnsthis(for fluid API call chaining).fromXmlElement(Element element) voidAppends Java source code representing this object to the given builder.generateSqlSelect(QuerySource... querySources) Generates a SQL SELECT statement from the given query sources.booleanIndicates if each source field name in the mappings should be treated as aFieldPathexpression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false).setMapping(List<RenameFieldsAction.FieldMapping> mapping) setParseFieldNamesAsFieldPath(boolean parseFieldNamesAsFieldPath) Indicates if each source field name in the mappings should be treated as aFieldPathexpression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false).setPipeline(Pipeline pipeline) Sets the pipeline this action belongs to; called byPipelinewhen the action is added to it.toRecord()Converts this object's state to a record thatRecordSerializable.fromRecord(Record)can load.toXmlElement(Document document) Returns an element, created withdocument, describing this object; the default implementation throws aDataException.Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.action.PipelineAction
escapeJavaString, getCode, getDescription, getDisplayText, getPipeline, setDescription, toStringMethods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalIdMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties
-
Constructor Details
-
RenameFieldsAction
public RenameFieldsAction()
-
-
Method Details
-
setPipeline
Description copied from class:PipelineActionSets the pipeline this action belongs to; called byPipelinewhen the action is added to it.- Overrides:
setPipelinein classPipelineAction
-
getMapping
-
setMapping
-
add
Renames the source field to the target name; a blank or identical target leaves the field unchanged. -
isParseFieldNamesAsFieldPath
public boolean isParseFieldNamesAsFieldPath()Indicates if each source field name in the mappings should be treated as aFieldPathexpression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false). Setting this tofalseallows white spaces and special characters to be used in the source field names without quoting and escaping internal quotes. -
setParseFieldNamesAsFieldPath
Indicates if each source field name in the mappings should be treated as aFieldPathexpression and parsed (when true, the default) or as a literal and used as a name, exactly as-is without parsing (when false). Setting this tofalseallows white spaces and special characters to be used in the source field names without quoting and escaping internal quotes. -
apply
Description copied from interface:DataReaderActionReturns a reader that applies this action to the records of the given reader, usually by wrapping it. -
generateSqlSelect
Description copied from interface:SqlSelectGeneratorGenerates 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
Description copied from interface:RecordSerializableConverts this object's state to a record thatRecordSerializable.fromRecord(Record)can load.- Specified by:
toRecordin interfaceRecordSerializable- Overrides:
toRecordin classPipelineAction
-
fromRecord
Description copied from interface:RecordSerializableLoads this instance's state from a record and returnsthis(for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.- Specified by:
fromRecordin interfaceRecordSerializable- Overrides:
fromRecordin classPipelineAction- Parameters:
source-- Returns:
- this instance.
-
toXmlElement
Description copied from interface:XmlSerializableReturns an element, created withdocument, describing this object; the default implementation throws aDataException.- Specified by:
toXmlElementin interfaceXmlSerializable- Overrides:
toXmlElementin classPipelineAction
-
fromXmlElement
- Specified by:
fromXmlElementin interfaceXmlSerializable- Overrides:
fromXmlElementin classPipelineAction
-
generateJavaCode
Description copied from interface:JavaCodeGeneratorAppends Java source code representing this object to the given builder.- Specified by:
generateJavaCodein interfaceJavaCodeGenerator- Overrides:
generateJavaCodein classPipelineAction
-