Package io.jmix.dataimport.configuration.mapping

Interface PropertyMapping

All Known Implementing Classes:

CustomPropertyMapping, ReferenceMultiFieldPropertyMapping, ReferencePropertyMapping, SimplePropertyMapping

@NullMarked
public interface PropertyMapping

Property mapping describes how to map a field from input data with entity property.
Basically, a property mapping contains the following info:

• Entity property name: name of the entity property that should be populated by the value
• Data field name: a name of the field that contains a raw value for entity property.
  If input data is XLSX or CSV, a name of the field - column header.
  If input data is XML, a name of the field - tag name.

See Also:

• SimplePropertyMapping
• CustomPropertyMapping
• ReferencePropertyMapping
• ReferenceMultiFieldPropertyMapping

Method Summary

Modifier and Type	Method	Description
@Nullable String	getDataFieldName()	Gets a data field name.
String	getEntityPropertyName()	Gets an entity property name.

Method Details

getEntityPropertyName

String getEntityPropertyName()

Gets an entity property name.

Returns:

entity property name

getDataFieldName

@Nullable String getDataFieldName()

Gets a data field name.

Returns:

data field name