com.yworks.yfiles.graphml

Class MapperInputHandler<TKey,TData>

java.lang.Object

com.yworks.yfiles.graphml.AbstractInputHandler<TKey,TData>

com.yworks.yfiles.graphml.MapperInputHandler<TKey,TData>

Type Parameters:

TKey - The type of the key.

TData - The type of the value.

All Implemented Interfaces:

IInputHandler

public class MapperInputHandler<TKey,TData>
extends AbstractInputHandler<TKey,TData>

An IInputHandler implementation that uses an IMapper instance to associate the values with the keys.

This implementation can be provided an HandleDeserializationEventArgs-handler to perform the deserialization. If no such value is provided then the default deserialization is performed.

The parsed values are stored in a IMapper.

Constructor Summary

Constructors

Constructor and Description
MapperInputHandler(Class<TKey> keyType, Class<TData> valueType) Initializes a new instance of the MapperInputHandler class that uses the IParseContext for deserialization.
MapperInputHandler(Class<TKey> keyType, Class<TData> valueType, IEventHandler<HandleDeserializationEventArgs> deserializer) Initializes a new instance of the MapperInputHandler class that uses the event handler for deserialization and suggests the provided target type for the deserializer.
MapperInputHandler(Class<TKey> keyType, Class<TData> valueType, IEventHandler<HandleDeserializationEventArgs> deserializer, Class deserializerTargetType) Initializes a new instance of the MapperInputHandler class that uses the event handler for deserialization and suggests the provided target type for the deserializer.

Method Summary

Modifier and Type	Method and Description
void	applyDefault(IParseContext context) Overridden to take the DefaultValueOverridingEnabled property into account.
protected Node	getDeserializationXmlNode(IParseContext context, Node node) Gets the node to pass to Deserializer or IParseContext.Deserialize respectively, given the 'data' or 'default' element from the GraphML.
IEventHandler<HandleDeserializationEventArgs>	getDeserializer() Gets the deserializer.
Class	getDeserializerTargetType() Gets the target deserialization type for the TargetType property.
IMapper<TKey,TData>	getMapper() Gets the mapper to use for storing the data.
boolean	isDefaultValueOverridingEnabled() Gets a value indicating whether values that are applied via the AbstractInputHandler.applyDefault(IParseContext) mechanism and are equal to the value that is already present in the mapper will explicitly be overridden in the mapper.
boolean	isUsingParentElementForDeserialization() Controls the behavior of getDeserializationXmlNode(IParseContext, Node) to return either the 'data'/'default' element itself or its content.
protected TData	parseDataCore(IParseContext context, Node node) Parses the data using either the Deserializer or the IParseContext.deserialize(Class, IParseContext, Node) call.
void	setDefaultValueOverridingEnabled(boolean value) Sets a value indicating whether values that are applied via the AbstractInputHandler.applyDefault(IParseContext) mechanism and are equal to the value that is already present in the mapper will explicitly be overridden in the mapper.
void	setDeserializer(IEventHandler<HandleDeserializationEventArgs> value) Sets the deserializer.
void	setDeserializerTargetType(Class value) Sets the target deserialization type for the TargetType property.
void	setMapper(IMapper<TKey,TData> value) Sets the mapper to use for storing the data.
void	setUsingParentElementForDeserialization(boolean value) Controls the behavior of getDeserializationXmlNode(IParseContext, Node) to return either the 'data'/'default' element itself or its content.
protected void	setValue(IParseContext context, TKey key, TData data) This method uses the Mapper to associate the data with the key.

Methods inherited from class com.yworks.yfiles.graphml.AbstractInputHandler

getDefaultValue, getPrecedence, initializeFromKeyDefinition, isDefaultExisting, isDefaultValueParsingEnabled, parseData, setDefaultValue, setDefaultValueParsingEnabled, setPrecedence

Methods inherited from class java.lang.Object

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

Constructor Detail

MapperInputHandler

public MapperInputHandler(Class<TKey> keyType,
                          Class<TData> valueType)

Initializes a new instance of the MapperInputHandler class that uses the IParseContext for deserialization.

The Precedence has an initial value of ParsePrecedence.DEFAULT.

Parameters:

keyType - The type of the key.

valueType - The type of the value.

MapperInputHandler

public MapperInputHandler(Class<TKey> keyType,
                          Class<TData> valueType,
                          IEventHandler<HandleDeserializationEventArgs> deserializer)

Initializes a new instance of the MapperInputHandler class that uses the event handler for deserialization and suggests the provided target type for the deserializer.

See Also:

getDeserializerTargetType(), getDeserializer()

MapperInputHandler

public MapperInputHandler(Class<TKey> keyType,
                          Class<TData> valueType,
                          IEventHandler<HandleDeserializationEventArgs> deserializer,
                          Class deserializerTargetType)

Initializes a new instance of the MapperInputHandler class that uses the event handler for deserialization and suggests the provided target type for the deserializer.

Parameters:

keyType - The type of the key.

valueType - The type of the value.

See Also:

getDeserializerTargetType(), getDeserializer()

Method Detail

applyDefault

public void applyDefault(IParseContext context)

Overridden to take the DefaultValueOverridingEnabled property into account.

Specified by:

applyDefault in interface IInputHandler

Overrides:

applyDefault in class AbstractInputHandler<TKey,TData>

Parameters:

context - The context for the parse operation.

See Also:

isDefaultValueOverridingEnabled(), AbstractInputHandler.applyDefault(IParseContext)

getDeserializationXmlNode

protected Node getDeserializationXmlNode(IParseContext context,
                                         Node node)

Gets the node to pass to Deserializer or IParseContext.Deserialize respectively, given the 'data' or 'default' element from the GraphML.

This method is called by parseDataCore(IParseContext, Node) to determine the node to pass to the deserialization mechanism.

This implementation returns node iff UsingParentElementForDeserialization is true (i.e. the 'data' or 'default' node itself), otherwise the first child of the node that is not a comment or processing instruction.

Parameters:

context - The context within which the node is parsed.

node - The 'data' or 'default' node.

Returns:

The node that should be deserialized.

See Also:

isUsingParentElementForDeserialization()

getDeserializer

public final IEventHandler<HandleDeserializationEventArgs> getDeserializer()

Gets the deserializer.

Returns:

The deserializer.

See Also:

setDeserializer(IEventHandler)

getDeserializerTargetType

public final Class getDeserializerTargetType()

Gets the target deserialization type for the TargetType property.

Returns:

The target type of the deserialization.

See Also:

setDeserializerTargetType(Class)

getMapper

public final IMapper<TKey,TData> getMapper()

Gets the mapper to use for storing the data.

Returns:

The mapper.

See Also:

setMapper(IMapper)

isDefaultValueOverridingEnabled

public final boolean isDefaultValueOverridingEnabled()

Gets a value indicating whether values that are applied via the AbstractInputHandler.applyDefault(IParseContext) mechanism and are equal to the value that is already present in the mapper will explicitly be overridden in the mapper.

Returns:

true if default values should be overridden in the mapper; false otherwise. By default this is set to false.

See Also:

setDefaultValueOverridingEnabled(boolean)

isUsingParentElementForDeserialization

public final boolean isUsingParentElementForDeserialization()

Controls the behavior of getDeserializationXmlNode(IParseContext, Node) to return either the 'data'/'default' element itself or its content.

The default value is false, meaning that getDeserializationXmlNode(IParseContext, Node) should return the content of the 'data'/'default' node.

Returns:

The UsingParentElementForDeserialization.

See Also:

getDeserializationXmlNode(IParseContext, Node), setUsingParentElementForDeserialization(boolean)

parseDataCore

protected TData parseDataCore(IParseContext context,
                              Node node)

Parses the data using either the Deserializer or the IParseContext.deserialize(Class, IParseContext, Node) call.

Specified by:

parseDataCore in class AbstractInputHandler<TKey,TData>

Throws:

DeserializationNotSupportedException - DeserializationNotSupportedException if Deserializer could not handle the node.

Parameters:

context - The context.

node - The node that contains the data. This is either the GraphML 'data' element or the 'default' element.

Returns:

The parsed data.

See Also:

getDeserializationXmlNode(IParseContext, Node)

setDefaultValueOverridingEnabled

public final void setDefaultValueOverridingEnabled(boolean value)

Sets a value indicating whether values that are applied via the AbstractInputHandler.applyDefault(IParseContext) mechanism and are equal to the value that is already present in the mapper will explicitly be overridden in the mapper.

Parameters:

value - true if default values should be overridden in the mapper; false otherwise. By default this is set to false.

See Also:

isDefaultValueOverridingEnabled()

setDeserializer

public final void setDeserializer(IEventHandler<HandleDeserializationEventArgs> value)

Sets the deserializer.

Parameters:

value - The deserializer.

See Also:

getDeserializer()

setDeserializerTargetType

public final void setDeserializerTargetType(Class value)

Sets the target deserialization type for the TargetType property.

Parameters:

value - The target type of the deserialization.

See Also:

getDeserializerTargetType()

setMapper

public final void setMapper(IMapper<TKey,TData> value)

Sets the mapper to use for storing the data.

Parameters:

value - The mapper.

See Also:

getMapper()

setUsingParentElementForDeserialization

public final void setUsingParentElementForDeserialization(boolean value)

Controls the behavior of getDeserializationXmlNode(IParseContext, Node) to return either the 'data'/'default' element itself or its content.

The default value is false, meaning that getDeserializationXmlNode(IParseContext, Node) should return the content of the 'data'/'default' node.

Parameters:

value - The UsingParentElementForDeserialization to set.

See Also:

getDeserializationXmlNode(IParseContext, Node), isUsingParentElementForDeserialization()

setValue

protected void setValue(IParseContext context,
                        TKey key,
                        TData data)

This method uses the Mapper to associate the data with the key.

Specified by:

setValue in class AbstractInputHandler<TKey,TData>

Parameters:

context - The context.

key - The key.

data - The data.