Package io.jmix.dataimport.configuration.mapping

Class ReferenceMultiFieldPropertyMapping

java.lang.Object

io.jmix.dataimport.configuration.mapping.ReferenceMultiFieldPropertyMapping

All Implemented Interfaces:

PropertyMapping

public class ReferenceMultiFieldPropertyMapping
extends Object
implements PropertyMapping

Mapping for reference property that is mapped by multiple data fields from the input data. This mapping allows to set:

• Entity property name: name of the reference property
• Data field name (optional): name of the data field that contains a raw values of properties for the reference entity. Note: this field is helpful for JSON (if there is a separate object for reference property) or XML (if there is a separate tag for reference property).
• Reference import policy: ReferenceImportPolicy
• Lookup property names: property names by which existing entity should be searched.
• Reference property mappings: list of PropertyMapping for reference entity properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReferenceMultiFieldPropertyMapping.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	dataFieldName
protected String	entityPropertyName
protected List<String>	lookupPropertyNames
protected ReferenceImportPolicy	referenceImportPolicy
protected List<PropertyMapping>	referencePropertyMappings

Method Summary

Modifier and Type	Method	Description
static ReferenceMultiFieldPropertyMapping.Builder	builder(String entityPropertyName, ReferenceImportPolicy policy)
String	getDataFieldName()	Gets a data field name.
String	getEntityPropertyName()	Gets an entity property name.
List<String>	getLookupPropertyNames()
ReferenceImportPolicy	getReferenceImportPolicy()
List<PropertyMapping>	getReferencePropertyMappings()
ReferenceMultiFieldPropertyMapping	setDataFieldName(String dataFieldName)
ReferenceMultiFieldPropertyMapping	setLookupPropertyNames(List<String> lookupPropertyNames)
ReferenceMultiFieldPropertyMapping	setReferencePropertyMappings(List<PropertyMapping> referencePropertyMappings)

Methods inherited from class java.lang.Object

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

Field Details

entityPropertyName

protected String entityPropertyName

dataFieldName

protected String dataFieldName

referencePropertyMappings

protected List<PropertyMapping> referencePropertyMappings

lookupPropertyNames

protected List<String> lookupPropertyNames

referenceImportPolicy

protected ReferenceImportPolicy referenceImportPolicy

Method Details

getDataFieldName

public String getDataFieldName()

Description copied from interface: PropertyMapping

Gets a data field name.

Specified by:

getDataFieldName in interface PropertyMapping

Returns:

data field name

setDataFieldName

public ReferenceMultiFieldPropertyMapping setDataFieldName(String dataFieldName)

getReferencePropertyMappings

public List<PropertyMapping> getReferencePropertyMappings()

setReferencePropertyMappings

public ReferenceMultiFieldPropertyMapping setReferencePropertyMappings(List<PropertyMapping> referencePropertyMappings)

getLookupPropertyNames

public List<String> getLookupPropertyNames()

setLookupPropertyNames

public ReferenceMultiFieldPropertyMapping setLookupPropertyNames(List<String> lookupPropertyNames)

getReferenceImportPolicy

public ReferenceImportPolicy getReferenceImportPolicy()

getEntityPropertyName

public String getEntityPropertyName()

Description copied from interface: PropertyMapping

Gets an entity property name.

Specified by:

getEntityPropertyName in interface PropertyMapping

Returns:

entity property name

builder

public static ReferenceMultiFieldPropertyMapping.Builder builder(String entityPropertyName,
 ReferenceImportPolicy policy)