Class DataMapping

Method Details

• getDataMappingProblems

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

  Description copied from interface: DataMappingProblemsSupplier

  Adds this element's problems to the list, plus those of its children when includeChildren is true; the default adds none.

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

  Returns the context holding the constants added with setValue(String, Object); it is the parent of the context used to evaluate expressions.

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

  Returns the conditions that must all be true for a record to be mapped; otherwise the result has no target record.

• addCondition

  public DataMapping addCondition(LogicalExpression condition)

  Adds a condition that must be true for a record to be mapped; otherwise the result has no target record.

• addCondition

  public DataMapping addCondition(Collection<LogicalExpression> conditions)

  Adds conditions that must all be true for a record to be mapped; otherwise the result has no target record.

• getConditionsSource

  public List<String> getConditionsSource()

• getFieldMappings

  public List<IFieldMapping> getFieldMappings()

  Returns the field mappings, applied in order to build the target record.

• addFieldMapping

  public DataMapping addFieldMapping(IFieldMapping fieldMapping)

• addFieldMapping

  public DataMapping addFieldMapping(Collection<IFieldMapping> fieldMappings)

• addFieldMapping

  public DataMapping addFieldMapping(String targetFieldName, String sourceExpression)

  Adds a FieldMapping that sets targetFieldName to the value of the sourceExpression expression.

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

  Returns the number of map(ExpressionContext) calls so far, also available to expressions as rownum.

• map

  public DataMappingResult map(ExpressionContext expressionContext)

  Maps the record in the given context; exceptions thrown by individual field mappings are collected in the returned result instead of being thrown.

• 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

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

  Description copied from class: DataMappingPart

  Returns the data mapping containing this part (itself for a DataMapping) or null if it is not known.

  Specified by:

  getDataMapping in class DataMappingPart

• getDataMappingPartContainer

  public DataMappingPart getDataMappingPartContainer()

  Description copied from class: DataMappingPart

  Returns the data mapping part containing this one or null if there is none.

  Specified by:

  getDataMappingPartContainer in class DataMappingPart

• getDataMappingPartType

  public DataMappingPartType getDataMappingPartType()

  Description copied from class: DataMappingPart

  Returns the kind of part this is, such as DataMappingPartType.FieldMapping.

  Specified by:

  getDataMappingPartType in class DataMappingPart

• getDataMappingPartName

  public String getDataMappingPartName()

  Description copied from class: DataMappingPart

  Returns the name identifying this part: the data mapping's name or a field mapping's target field name.

  Specified by:

  getDataMappingPartName in class DataMappingPart

• 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 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

  Parameters:

  source -

  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)

  Description copied from interface: JsonSerializable

  Writes this object as JSON to the writer, then closes the writer.

  Specified by:

  toJson in interface JsonSerializable

  Specified by:

  toJson in interface RecordSerializable

• toJson

  public DataMapping toJson(Writer writer, boolean closeWriter)

  Description copied from interface: JsonSerializable

  Writes this object as JSON to the writer, closing the writer afterwards if closeWriter is true.

  Specified by:

  toJson in interface JsonSerializable

  Specified by:

  toJson in interface RecordSerializable

• toXml

  public DataMapping toXml(Writer writer)

  Description copied from interface: XmlSerializable

  Writes this object as indented XML, without a declaration, to the writer and then closes it.

  Specified by:

  toXml in interface XmlSerializable

• fromJson

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

• fromJson

  public DataMapping fromJson(InputStream inputStream)

  Description copied from interface: JsonSerializable

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

  Specified by:

  fromJson in interface JsonSerializable

  Specified by:

  fromJson in interface RecordSerializable

• fromXml

  public DataMapping fromXml(InputStream inputStream)

  Description copied from interface: XmlSerializable

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

  Specified by:

  fromXml in interface XmlSerializable

• fromXml

  public DataMapping fromXml(String xml)

  Specified by:

  fromXml in interface XmlSerializable

• 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

• fromXmlElement

  public DataMapping fromXmlElement(Element dataMappingElement)

  Specified by:

  fromXmlElement in interface XmlSerializable