de.hybris.platform.webservices.util.objectgraphtransformer

Interface PropertyMapping

All Known Implementing Classes:

AbstractPropertyMapping, DefaultPropertyMapping

public interface PropertyMapping

"Connects" a single node-property from a source to a target.

Provides mapping information which is needed to transform and/or copy the value of a source node property into a target node.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the mapping id.
java.util.List<NodeMapping>	getNewNodeMappings()
NodeMapping	getParentMapping() Returns the parent mapping which this mapping belongs too.
PropertyProcessor	getProcessor() Returns the Processor which is used to transfer data from source to target for this mapping.
java.util.List<PropertyFilter>	getPropertyFilters()
PropertyConfig	getSourceConfig() Returns the source configuration for this mapping.
PropertyConfig	getTargetConfig() Returns the target configuration for this mapping.
boolean	isNode() True when type of read-property (source node property) represents a GraphNode which implies further processing with deeper graph processing .
boolean	isVirtual() True when this mapping is treated "virtual".

Method Detail

getId

java.lang.String getId()

Returns the mapping id.

Generally this is the bean-property name of the source property.

Returns:

id String

getSourceConfig

PropertyConfig getSourceConfig()

Returns the source configuration for this mapping.

This is the property which is taken for reading.

Returns:

PropertyConfig

getTargetConfig

PropertyConfig getTargetConfig()

Returns the target configuration for this mapping.

This is the property which is taken for writing.

Returns:

PropertyConfig

getParentMapping

NodeMapping getParentMapping()

Returns the parent mapping which this mapping belongs too.

For a PropertyMapping the parent mapping is always a NodeMapping.

Returns:

NodeMapping

getProcessor

PropertyProcessor getProcessor()

Returns the Processor which is used to transfer data from source to target for this mapping.

For a PropertyMapping this is always a PropertyProcessor.

Returns:

PropertyProcessor

getNewNodeMappings

java.util.List<NodeMapping> getNewNodeMappings()

getPropertyFilters

java.util.List<PropertyFilter> getPropertyFilters()

isNode

boolean isNode()

True when type of read-property (source node property) represents a GraphNode which implies further processing with deeper graph processing . False when property returns a plain value which is not registered as GraphNode.

Mapping is treated as node when source property is a node (regardless whether target property is a node or not)

Returns:

true when property value is a node.

isVirtual

boolean isVirtual()

True when this mapping is treated "virtual". For virtual property mappings only the write property is invoked regardless whether a read property is available or not. Virtual makes sense in combinations with PropertyInterceptor. A PropertyFilter do not have any influence on virtual properties.

Returns:

true when virtual