de.hybris.platform.webservices.util.objectgraphtransformer.impl

Class DefaultPropertyMapping

java.lang.Object

de.hybris.platform.webservices.util.objectgraphtransformer.impl.AbstractPropertyMapping

de.hybris.platform.webservices.util.objectgraphtransformer.impl.DefaultPropertyMapping

All Implemented Interfaces:

PropertyMapping

public class DefaultPropertyMapping
extends AbstractPropertyMapping

Field Summary

Fields inherited from class de.hybris.platform.webservices.util.objectgraphtransformer.impl.AbstractPropertyMapping

_isInitialized, COMPLIANCE_LEVEL_HIGH, COMPLIANCE_LEVEL_LOW, COMPLIANCE_LEVEL_MEDIUM, nodeMapping

Constructor Summary

Constructors

Constructor and Description
DefaultPropertyMapping(NodeMapping nodeMapping, DefaultPropertyConfig readProperty, DefaultPropertyConfig writeProperty) Constructs a new instance using the two passed arguments as read- and write property.
DefaultPropertyMapping(NodeMapping nodeMapping, java.lang.String property) Constructor.
DefaultPropertyMapping(NodeMapping nodeMapping, java.lang.String readProp, java.lang.String writeProp)
DefaultPropertyMapping(NodeMapping nodeMapping, java.lang.String readProp, java.lang.String writeProp, PropertyInterceptor readInterceptor, PropertyInterceptor writeInterceptor) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the mapping id.
java.util.List<NodeMapping>	getNewNodeMappings()
PropertyProcessor	getProcessor() Returns the Processor which is used to transfer data from source to target for this mapping.
java.util.List<PropertyFilter>	getPropertyFilters()
DefaultPropertyConfig	getSourceConfig() Returns the source configuration for this mapping.
DefaultPropertyConfig	getTargetConfig() Returns the target configuration for this mapping.
protected boolean	initialize(int complianceLevel) Compiles configuration settings by assuming this property belongs to passed node which itself belongs to passed graph.
boolean	isNode() True when type of read-property (source node property) represents a GraphNode which implies further processing with deeper graph processing .
protected boolean	isTypeCheckEnabled()
boolean	isVirtual() True when this mapping is treated "virtual".
void	setFilters(java.util.List<PropertyFilter> filters)
void	setNewNodeMappings(java.util.List<NodeMapping> nodeConfig)
protected void	setNode(boolean isNode)
protected void	setVirtual(boolean isVirtual)
java.lang.String	toExtString() Enhanced toString representation.
java.lang.String	toString()

Methods inherited from class de.hybris.platform.webservices.util.objectgraphtransformer.impl.AbstractPropertyMapping

getParentMapping, isInitialized, setInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPropertyMapping

public DefaultPropertyMapping(NodeMapping nodeMapping,
                              java.lang.String property)

Constructor.

Parameters:

property -

DefaultPropertyMapping

public DefaultPropertyMapping(NodeMapping nodeMapping,
                              java.lang.String readProp,
                              java.lang.String writeProp)

Parameters:

readProp -

writeProp -

DefaultPropertyMapping

public DefaultPropertyMapping(NodeMapping nodeMapping,
                              java.lang.String readProp,
                              java.lang.String writeProp,
                              PropertyInterceptor readInterceptor,
                              PropertyInterceptor writeInterceptor)

Constructor.

Maps a read-property to a write-property. Properties are given independently from any concrete class and must follow java bean naming scheme. A PropertyInterceptor for both, read-value and write value, can be passed.

A configuration must be compiled before it can be used. Compiling binds the configuration to a specific GraphNode and a GraphTransformer and verifies whether configuration is valid (e.g. property names)

Parameters:

readProp - name of read property from source node

writeProp - name of write property from target node

readInterceptor - PropertyInterceptor for read

writeInterceptor - PropertyInterceptor for write

DefaultPropertyMapping

public DefaultPropertyMapping(NodeMapping nodeMapping,
                              DefaultPropertyConfig readProperty,
                              DefaultPropertyConfig writeProperty)

Constructs a new instance using the two passed arguments as read- and write property.

Parameters:

readProperty - DefaultPropertyConfig

writeProperty - DefaultPropertyConfig

Method Detail

getId

public java.lang.String getId()

Description copied from interface: PropertyMapping

Returns the mapping id.

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

Returns:

id String

getPropertyFilters

public java.util.List<PropertyFilter> getPropertyFilters()

isNode

public boolean isNode()

Description copied from interface: PropertyMapping

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.

setNode

protected void setNode(boolean isNode)

isVirtual

public boolean isVirtual()

Description copied from interface: PropertyMapping

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

setVirtual

protected void setVirtual(boolean isVirtual)

setFilters

public void setFilters(java.util.List<PropertyFilter> filters)

getNewNodeMappings

public java.util.List<NodeMapping> getNewNodeMappings()

setNewNodeMappings

public void setNewNodeMappings(java.util.List<NodeMapping> nodeConfig)

getProcessor

public PropertyProcessor getProcessor()

Description copied from interface: PropertyMapping

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

getSourceConfig

public DefaultPropertyConfig getSourceConfig()

Description copied from interface: PropertyMapping

Returns the source configuration for this mapping.

This is the property which is taken for reading.

Returns:

PropertyConfig

getTargetConfig

public DefaultPropertyConfig getTargetConfig()

Description copied from interface: PropertyMapping

Returns the target configuration for this mapping.

This is the property which is taken for writing.

Returns:

PropertyConfig

initialize

protected boolean initialize(int complianceLevel)

Compiles configuration settings by assuming this property belongs to passed node which itself belongs to passed graph.

Specified by:

initialize in class AbstractPropertyMapping

Parameters:

complianceLevel - various levels for error handling

Returns:

true when compiling was successful

isTypeCheckEnabled

protected boolean isTypeCheckEnabled()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toExtString

public java.lang.String toExtString()

Enhanced toString representation. Use carefully as this method has an performance impact.

Returns:

String representation