de.hybris.platform.webservices.util.objectgraphtransformer

Interface GraphContext

All Known Implementing Classes:

GraphContextImpl, YObjectGraphContext

public interface GraphContext

Provides runtime information about current graph transformation process.

Additionally allows various customizations/modification which differ from globally GraphTransformer configuration and are used only for the transformation process which this context gets passed too.

Method Summary

Modifier and Type	Method and Description
java.util.Map	getAttributes() A map of attributes which is free to use.
GraphConfiguration	getConfiguration() Returns configuration options for this graph.
GraphTransformer	getGraphTransformer() Returns GraphTransformer which this context is used for.
int	getMaxDistance() Returns highest found distance which was detected for all processed nodes up to currently processed one.
java.util.List<PropertyFilter>	getNodeFilterList() Returns a modifiable List of PropertyFilter instances.
java.util.List<PropertyFilter>	getPropertyFilterList() Returns a modifiable List of PropertyFilter instances.
boolean	isReleased() Returns true when graph transformation process which used that context instance is finished.

Method Detail

getMaxDistance

int getMaxDistance()

Returns highest found distance which was detected for all processed nodes up to currently processed one.

Returns:

highest distance

getGraphTransformer

GraphTransformer getGraphTransformer()

Returns GraphTransformer which this context is used for.

Returns:

GraphTransformer

getConfiguration

GraphConfiguration getConfiguration()

Returns configuration options for this graph. Configuration settings are only valid for one transformation which this context is bound too.

Returns:

GraphConfiguration

getPropertyFilterList

java.util.List<PropertyFilter> getPropertyFilterList()

Returns a modifiable List of PropertyFilter instances. This chain of filters is applied to every processed property (including these ones which are treated as node).

Returns:

List of PropertyFilter which are getting applied to every property

getNodeFilterList

java.util.List<PropertyFilter> getNodeFilterList()

Returns a modifiable List of PropertyFilter instances. This chain of filters is applied to every processed property which is treated as GraphNode.

Returns:

list of PropertyFilter which are getting applied to node-properties only

getAttributes

java.util.Map getAttributes()

A map of attributes which is free to use.

Returns:

Map

isReleased

boolean isReleased()

Returns true when graph transformation process which used that context instance is finished. After a context is released it can not be used a second time for another transformation. However, it can still be used to gather some statistical data about the transformation.

Returns:

true when context is released