com.yworks.yfiles.graphml

Class AbstractInputHandler<TKey,TData>

java.lang.Object

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

Type Parameters:

TKey - The type of the key, i.e. the items that are associated with the data in the GraphML.

TData - The type of the data that is associated with the keys.

All Implemented Interfaces:

IInputHandler

Direct Known Subclasses:

MapperInputHandler

public abstract class AbstractInputHandler<TKey,TData>
extends Object
implements IInputHandler

An abstract convenience implementation of the IInputHandler interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInputHandler(Class<TKey> keyType) Initializes a new instance of the AbstractInputHandler class.
protected	AbstractInputHandler(Class<TKey> keyType, ParsePrecedence precedence) Initializes a new instance of the AbstractInputHandler class.

Method Summary

Modifier and Type	Method and Description
void	applyDefault(IParseContext context) This method is invoked when no data tag is defined, and the default value should be applied.
TData	getDefaultValue() Gets the default value that will be applied to the keys where the data attribute is missing.
ParsePrecedence	getPrecedence() Gets the parse precedence that is associated with this handler.
void	initializeFromKeyDefinition(IParseContext context, Element definition) Initializes this instance from the GraphML key definition.
boolean	isDefaultExisting() Gets a value indicating whether a default value has been set, either through a key definition element or explicitly by assigning a value to the DefaultValue property.
boolean	isDefaultValueParsingEnabled() Gets a value indicating whether the default value in the key definition should be parsed.
void	parseData(IParseContext context, Node node) This method is invoked each time a data element with matching key is processed.
protected abstract TData	parseDataCore(IParseContext context, Node node) Abstract method callback that actually parses the data.
void	setDefaultValue(TData value) Sets the default value that will be applied to the keys where the data attribute is missing.
void	setDefaultValueParsingEnabled(boolean value) Sets a value indicating whether the default value in the key definition should be parsed.
void	setPrecedence(ParsePrecedence value) Sets the parse precedence that is associated with this handler.
protected abstract void	setValue(IParseContext context, TKey key, TData data) Abstract method callback that actually stores the value with the keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInputHandler

protected AbstractInputHandler(Class<TKey> keyType)

Initializes a new instance of the AbstractInputHandler class.

The Precedence has an initial value of ParsePrecedence.DEFAULT.

Parameters:

keyType - The type of the key, i.e. the items that are associated with the data in the GraphML.

AbstractInputHandler

protected AbstractInputHandler(Class<TKey> keyType,
                               ParsePrecedence precedence)

Initializes a new instance of the AbstractInputHandler class.

The Precedence gets the initial value assigned to precedence

Parameters:

keyType - The type of the key, i.e. the items that are associated with the data in the GraphML.

precedence - The precedence to assign to the Precedence property.

Method Detail

applyDefault

public void applyDefault(IParseContext context)

This method is invoked when no data tag is defined, and the default value should be applied.

This implementation delegates to setValue(IParseContext, java.lang.Object, java.lang.Object) if a default exists using the DefaultValue.

Specified by:

applyDefault in interface IInputHandler

Parameters:

context - the current parse context.

getDefaultValue

public final TData getDefaultValue()

Gets the default value that will be applied to the keys where the data attribute is missing.

If any default value is set (including null), DefaultExisting is automatically set to true.

Returns:

The default value.

See Also:

setDefaultValue(java.lang.Object)

getPrecedence

public final ParsePrecedence getPrecedence()

Gets the parse precedence that is associated with this handler.

Specified by:

getPrecedence in interface IInputHandler

Returns:

The parse precedence.

See Also:

setPrecedence(ParsePrecedence)

initializeFromKeyDefinition

public void initializeFromKeyDefinition(IParseContext context,
                                        Element definition)
                                 throws IOException

Initializes this instance from the GraphML key definition.

This implementation looks for the GraphML default element and delegates to parseDataCore(IParseContext, Node) if a default is found to store the DefaultValue.

Throws:

IOException

Parameters:

context - The context.

definition - The definition.

isDefaultExisting

public final boolean isDefaultExisting()

Gets a value indicating whether a default value has been set, either through a key definition element or explicitly by assigning a value to the DefaultValue property.

If this property is set to true, the applyDefault(IParseContext) method will call the setValue(IParseContext, java.lang.Object, java.lang.Object) method using the DefaultValue as the value parameter.

Returns:

true if the default value exists; false otherwise.

isDefaultValueParsingEnabled

public final boolean isDefaultValueParsingEnabled()

Gets a value indicating whether the default value in the key definition should be parsed.

Returns:

true if the default value should be parsed; false otherwise. The default is true.

See Also:

setDefaultValueParsingEnabled(boolean)

parseData

public void parseData(IParseContext context,
                      Node node)
               throws IOException

This method is invoked each time a data element with matching key is processed.

If the current element is of the same type as this TKey, this method delegates the actual parsing to parseDataCore(IParseContext, Node) and setValue(IParseContext, java.lang.Object, java.lang.Object)

Specified by:

parseData in interface IInputHandler

Throws:

IOException - If the data cannot be written

Parameters:

context - the current parse context.

node - the DOM node representing the data element.

parseDataCore

protected abstract TData parseDataCore(IParseContext context,
                                       Node node)
                                throws IOException

Abstract method callback that actually parses the data.

Throws:

IOException - If the data cannot be written

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.

setDefaultValue

public final void setDefaultValue(TData value)

Sets the default value that will be applied to the keys where the data attribute is missing.

If any default value is set (including null), DefaultExisting is automatically set to true.

Parameters:

value - The default value.

See Also:

getDefaultValue()

setDefaultValueParsingEnabled

public final void setDefaultValueParsingEnabled(boolean value)

Sets a value indicating whether the default value in the key definition should be parsed.

Parameters:

value - true if the default value should be parsed; false otherwise. The default is true.

See Also:

isDefaultValueParsingEnabled()

setPrecedence

public final void setPrecedence(ParsePrecedence value)

Sets the parse precedence that is associated with this handler.

Parameters:

value - The parse precedence.

See Also:

getPrecedence()

setValue

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

Abstract method callback that actually stores the value with the keys.

Parameters:

context - The context.

key - The key.

data - The data.