Package io.jmix.dataimport.configuration.mapping

Class ReferenceMultiFieldPropertyMapping.Builder

java.lang.Object

io.jmix.dataimport.configuration.mapping.ReferenceMultiFieldPropertyMapping.Builder

Enclosing class:

ReferenceMultiFieldPropertyMapping

public static class ReferenceMultiFieldPropertyMapping.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(String entityPropertyName, ReferenceImportPolicy referenceImportPolicy)

Method Summary

Modifier and Type	Method	Description
ReferenceMultiFieldPropertyMapping.Builder	addCustomPropertyMapping(String entityPropertyName, Function<CustomMappingContext,Object> customValueFunction)	Adds a custom mapping for property.
ReferenceMultiFieldPropertyMapping.Builder	addPropertyMapping(PropertyMapping propertyMapping)	Adds specified property mapping.
ReferenceMultiFieldPropertyMapping.Builder	addReferencePropertyMapping(String entityPropertyName, String dataFieldName, String lookupPropertyName, ReferenceImportPolicy policy)	Creates and adds a property mapping for the reference property mapped by one data field.
ReferenceMultiFieldPropertyMapping.Builder	addSimplePropertyMapping(String entityPropertyName, String dataFieldName)	Adds a mapping for specified simple property.
ReferenceMultiFieldPropertyMapping	build()
ReferenceMultiFieldPropertyMapping.Builder	lookupByAllSimpleProperties()	All simple properties for which mappings are set will be used to lookup existing entity.
protected void	validate()
ReferenceMultiFieldPropertyMapping.Builder	withDataFieldName(String dataFieldName)	Sets a data field name.
ReferenceMultiFieldPropertyMapping.Builder	withLookupPropertyNames(String... lookupPropertyNames)	Sets names of the properties by which an existing entity will be searched
ReferenceMultiFieldPropertyMapping.Builder	withLookupPropertyNames(List<String> lookupPropertyNames)	Sets names of the properties by which an existing entity will be searched

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String entityPropertyName,
 ReferenceImportPolicy referenceImportPolicy)

Method Details

addSimplePropertyMapping

public ReferenceMultiFieldPropertyMapping.Builder addSimplePropertyMapping(String entityPropertyName,
 String dataFieldName)

Adds a mapping for specified simple property.

Parameters:

entityPropertyName - entity property name

dataFieldName - name of the field from input data that contains a raw value of property

Returns:

current instance of builder

addCustomPropertyMapping

public ReferenceMultiFieldPropertyMapping.Builder addCustomPropertyMapping(String entityPropertyName,
 Function<CustomMappingContext,Object> customValueFunction)

Adds a custom mapping for property.

Parameters:

entityPropertyName - entity property name

customValueFunction - function to get value for the

Returns:

current instance of builder

addReferencePropertyMapping

public ReferenceMultiFieldPropertyMapping.Builder addReferencePropertyMapping(String entityPropertyName,
 String dataFieldName,
 String lookupPropertyName,
 ReferenceImportPolicy policy)

Creates and adds a property mapping for the reference property mapped by one data field.

Parameters:

entityPropertyName - reference property name

dataFieldName - name of the field from input data that contains a raw value of lookup property

lookupPropertyName - property name from the reference entity

policy - reference import policy

Returns:

current instance of builder

See Also:

• ReferencePropertyMapping

addPropertyMapping

public ReferenceMultiFieldPropertyMapping.Builder addPropertyMapping(PropertyMapping propertyMapping)

Adds specified property mapping. Property mapping can be:

• SimplePropertyMapping
• CustomPropertyMapping
• ReferencePropertyMapping
• ReferenceMultiFieldPropertyMapping

Parameters:

propertyMapping - property mapping

Returns:

current instance of builder

See Also:

• ReferenceMultiFieldPropertyMapping.Builder

withLookupPropertyNames

public ReferenceMultiFieldPropertyMapping.Builder withLookupPropertyNames(List<String> lookupPropertyNames)

Sets names of the properties by which an existing entity will be searched

Parameters:

lookupPropertyNames - names of the properties by which an existing entity will be searched

Returns:

current instance of builder

lookupByAllSimpleProperties

public ReferenceMultiFieldPropertyMapping.Builder lookupByAllSimpleProperties()

All simple properties for which mappings are set will be used to lookup existing entity.

Returns:

current instance of builder

withLookupPropertyNames

public ReferenceMultiFieldPropertyMapping.Builder withLookupPropertyNames(String... lookupPropertyNames)

Sets names of the properties by which an existing entity will be searched

Parameters:

lookupPropertyNames - names of the properties by which an existing entity will be searched

Returns:

current instance of builder

withDataFieldName

public ReferenceMultiFieldPropertyMapping.Builder withDataFieldName(String dataFieldName)

Sets a data field name.
Note: actual for JSON/XML formats

Parameters:

dataFieldName - field/tag name from the input data that has raw values of the reference entity properties

Returns:

current instance of builder

build

public ReferenceMultiFieldPropertyMapping build()

validate

protected void validate()