com.northconcepts.datapipeline.foundations.datamapping

Class DataMapping

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.datamapping.DataMappingObject

com.northconcepts.datapipeline.foundations.datamapping.DataMappingPart

com.northconcepts.datapipeline.foundations.datamapping.DataMapping

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataMappingProblemsSupplier, JavaCodeGenerator, Serializable

public class DataMapping
extends DataMappingPart
implements JavaCodeGenerator, DataMappingProblemsSupplier

The top-level abstraction to map a set of values from source to target using the DataPipeline Expression Language or custom implementation.

See Also:

Serialized Form

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
DataMapping()

Method Summary

Modifier and Type	Method and Description
DataMapping	addCondition(Collection<LogicalExpression> conditions)
DataMapping	addCondition(LogicalExpression condition)
DataException	addExceptionProperties(DataException exception) Adds this object's current state to a DataException.
DataMapping	addExcludedFields(Collection<String> excludedFields) Adds fields to be removed from the target.
DataMapping	addExcludedFields(String... excludedFields) Adds fields to be removed from the target.
DataMapping	addFieldMapping(Collection<IFieldMapping> fieldMappings)
DataMapping	addFieldMapping(IFieldMapping fieldMapping)
DataMapping	addFieldMapping(String targetFieldName, String sourceExpression)
DataMapping	fromJson(InputStream inputStream)
DataMapping	fromJson(String jsonString)
DataMapping	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
DataMapping	fromXml(InputStream inputStream)
DataMapping	fromXml(String xml)
DataMapping	fromXmlElement(Element dataMappingElement)
void	generateJavaCode(JavaCodeBuilder code)
List<LogicalExpression>	getConditions()
List<String>	getConditionsSource()
DataMapping	getDataMapping()
DataMappingPart	getDataMappingPartContainer()
String	getDataMappingPartName()
DataMappingPartType	getDataMappingPartType()
void	getDataMappingProblems(List<DataMappingProblem> problems, boolean includeChildren)
String	getDescription()
Set<String>	getExcludedFields() The set of fields to be removed from the target.
List<IFieldMapping>	getFieldMappings()
String	getName()
DefaultExpressionContext	getRootExpressionContext()
long	getRownum()
EntityDef	getSourceEntity() The schema entity used to convert and validate incoming data before this mapping is performed (default null).
EntityDef	getTargetEntity() The schema entity used to convert and validate outgoing data after this mapping is performed (default null).
EntityDef	getTargetValidationEntity() Deprecated.
boolean	isAutoMapping() Indicates if incoming source fields should be mapped automatically without the need for explicit FieldMappings (default false).
DataMappingResult	map(ExpressionContext expressionContext)
DataMapping	setAutoMapping(boolean autoMapping) Indicates if incoming source fields should be mapped automatically without the need for explicit FieldMappings (default false).
DataMapping	setDescription(String description)
DataMapping	setName(String name)
DataMapping	setSourceEntity(EntityDef sourceEntity) The schema entity used to convert and validate incoming data before this mapping is performed (default null).
DataMapping	setTargetEntity(EntityDef targetEntity) The schema entity used to convert and validate outgoing data after this mapping is performed (default null).
DataMapping	setTargetValidationEntity(EntityDef targetValidationEntity) Deprecated.
DataMapping	setValue(String name, Object value) Add a constant for this mapping to use when evaluating expressions like the FieldMapping.getSourceExpression(), AbstractFieldMapping.getCondition(), and getConditions().
DataMapping	setValue(String name, Object value, Class<?> type) Add a constant for this mapping to use when evaluating expressions like the FieldMapping.getSourceExpression(), AbstractFieldMapping.getCondition(), and getConditions().
String	toJson()
DataMapping	toJson(Writer writer)
DataMapping	toJson(Writer writer, boolean closeWriter)
Record	toRecord()
DataMapping	toXml(Writer writer)
Element	toXmlElement(Document document)

Methods inherited from class com.northconcepts.datapipeline.foundations.datamapping.DataMappingPart

getDataMappingName, getDataMappingPartContainerName, getDataMappingPartContainerType

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

assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

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

toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.foundations.datamapping.DataMappingProblemsSupplier

getDataMappingProblems, getDataMappingProblems

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

fromArrayValue, fromArrayValue, fromArrayValue, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toRecord

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

newInstanceFromJson

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

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

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

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

DataMapping

public DataMapping()

Method Detail

getDataMappingProblems

public void getDataMappingProblems(List<DataMappingProblem> problems,
                                   boolean includeChildren)

Specified by:

getDataMappingProblems in interface DataMappingProblemsSupplier

getName

public String getName()

setName

public DataMapping setName(String name)

getDescription

public String getDescription()

setDescription

public DataMapping setDescription(String description)

isAutoMapping

public boolean isAutoMapping()

Indicates if incoming source fields should be mapped automatically without the need for explicit FieldMappings (default false).

setAutoMapping

public DataMapping setAutoMapping(boolean autoMapping)

Indicates if incoming source fields should be mapped automatically without the need for explicit FieldMappings (default false).

getRootExpressionContext

public DefaultExpressionContext getRootExpressionContext()

setValue

public DataMapping setValue(String name,
                            Object value)

Add a constant for this mapping to use when evaluating expressions like the FieldMapping.getSourceExpression(), AbstractFieldMapping.getCondition(), and getConditions().

setValue

public DataMapping setValue(String name,
                            Object value,
                            Class<?> type)

Add a constant for this mapping to use when evaluating expressions like the FieldMapping.getSourceExpression(), AbstractFieldMapping.getCondition(), and getConditions().

getSourceEntity

public EntityDef getSourceEntity()

The schema entity used to convert and validate incoming data before this mapping is performed (default null). No type conversions and validations are performed when null.

setSourceEntity

public DataMapping setSourceEntity(EntityDef sourceEntity)

The schema entity used to convert and validate incoming data before this mapping is performed (default null). No type conversions and validations are performed when null.

getTargetEntity

public EntityDef getTargetEntity()

The schema entity used to convert and validate outgoing data after this mapping is performed (default null). No type conversions and validations are performed when null.

setTargetEntity

public DataMapping setTargetEntity(EntityDef targetEntity)

The schema entity used to convert and validate outgoing data after this mapping is performed (default null). No type conversions and validations are performed when null.

getTargetValidationEntity

@Deprecated
public EntityDef getTargetValidationEntity()

Deprecated.

Use getTargetEntity() instead.

setTargetValidationEntity

@Deprecated
public DataMapping setTargetValidationEntity(EntityDef targetValidationEntity)

Deprecated.

Use setTargetEntity(EntityDef) instead.

getConditions

public List<LogicalExpression> getConditions()

addCondition

public DataMapping addCondition(LogicalExpression condition)

addCondition

public DataMapping addCondition(Collection<LogicalExpression> conditions)

getConditionsSource

public List<String> getConditionsSource()

getFieldMappings

public List<IFieldMapping> getFieldMappings()

addFieldMapping

public DataMapping addFieldMapping(IFieldMapping fieldMapping)

addFieldMapping

public DataMapping addFieldMapping(Collection<IFieldMapping> fieldMappings)

addFieldMapping

public DataMapping addFieldMapping(String targetFieldName,
                                   String sourceExpression)

getExcludedFields

public Set<String> getExcludedFields()

The set of fields to be removed from the target. Removal is performed after the mapping, but before the mapped data is converted and validated by the optional target EntityDef and returned.

addExcludedFields

public DataMapping addExcludedFields(String... excludedFields)

Adds fields to be removed from the target. Removal is performed after the mapping, but before the mapped data is converted and validated by the optional target EntityDef and returned.

addExcludedFields

public DataMapping addExcludedFields(Collection<String> excludedFields)

Adds fields to be removed from the target. Removal is performed after the mapping, but before the mapped data is converted and validated by the optional target EntityDef and returned.

getRownum

public long getRownum()

map

public DataMappingResult map(ExpressionContext expressionContext)

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: FoundationObject

Adds this object's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Specified by:

addExceptionProperties in interface DataExceptionContributor

Overrides:

addExceptionProperties in class FoundationObject

getDataMapping

public DataMapping getDataMapping()

Specified by:

getDataMapping in class DataMappingPart

getDataMappingPartContainer

public DataMappingPart getDataMappingPartContainer()

Specified by:

getDataMappingPartContainer in class DataMappingPart

getDataMappingPartType

public DataMappingPartType getDataMappingPartType()

Specified by:

getDataMappingPartType in class DataMappingPart

getDataMappingPartName

public String getDataMappingPartName()

Specified by:

getDataMappingPartName in class DataMappingPart

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public DataMapping 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 Bean

Returns:

this instance.

toJson

public String toJson()

Specified by:

toJson in interface JsonSerializable

Specified by:

toJson in interface RecordSerializable

toJson

public DataMapping toJson(Writer writer)

Specified by:

toJson in interface JsonSerializable

Specified by:

toJson in interface RecordSerializable

toJson

public DataMapping toJson(Writer writer,
                          boolean closeWriter)

Specified by:

toJson in interface JsonSerializable

Specified by:

toJson in interface RecordSerializable

toXml

public DataMapping toXml(Writer writer)

Specified by:

toXml in interface XmlSerializable

fromJson

public DataMapping fromJson(String jsonString)

Specified by:

fromJson in interface JsonSerializable

Specified by:

fromJson in interface RecordSerializable

fromJson

public DataMapping fromJson(InputStream inputStream)

Specified by:

fromJson in interface JsonSerializable

Specified by:

fromJson in interface RecordSerializable

fromXml

public DataMapping fromXml(InputStream inputStream)

Specified by:

fromXml in interface XmlSerializable

fromXml

public DataMapping fromXml(String xml)

Specified by:

fromXml in interface XmlSerializable

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

fromXmlElement

public DataMapping fromXmlElement(Element dataMappingElement)

Specified by:

fromXmlElement in interface XmlSerializable