com.yworks.yfiles.graphml

Class AbstractOutputHandler<TKey,TData>

java.lang.Object

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

Type Parameters:

TKey - The type of the keys.

TData - The type of the data.

All Implemented Interfaces:

IOutputHandler

Direct Known Subclasses:

MapperOutputHandler

public abstract class AbstractOutputHandler<TKey,TData>
extends Object
implements IOutputHandler

Convenience abstract base implementation of the IOutputHandler interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOutputHandler(Class<TKey> keyType, KeyScope scope, String name, KeyType type) Initializes a new instance of the AbstractOutputHandler class using the provided scope, name, and type for the key definition.
protected	AbstractOutputHandler(Class<TKey> keyType, String name) Initializes a new instance of the AbstractOutputHandler class.

Method Summary

Modifier and Type	Method and Description
IEnumerable<GraphMLXmlAttribute>	getDataTagAttributes() Gets the XML attributes that should be added to the data element.
TData	getDefaultValue() Gets the default value.
IEnumerable<GraphMLXmlAttribute>	getKeyDefinitionAttributes() Gets the XML attributes that should be added to the key definition in the GraphML key element.
WritePrecedence	getPrecedence() Gets the write precedence for the handler.
protected abstract TData	getValue(IWriteContext context, TKey key) Callback method that obtains the data for the given key.
boolean	isDefaultExisting() Gets a value indicating whether a default value has been assigned.
boolean	isDefaultValue(IWriteContext context) Determines whether in the current context, the value is the default value and therefore no data element needs to be written.
boolean	isKeyDefaultWritingEnabled() Gets a value indicating whether to write the key default.
protected void	setDefaultExisting(boolean value) Sets a value indicating whether a default value has been assigned.
void	setDefaultValue(TData value) Sets the default value.
void	setKeyDefaultWritingEnabled(boolean value) Sets a value indicating whether to write the key default.
void	setKeyDefinitionName(String name) Sets the name for the key definition.
void	setKeyDefinitionScope(KeyScope scope) Sets the scope for the key definition.
void	setKeyDefinitionType(KeyType type) Sets the key type for the key definition.
void	setKeyDefinitionUri(String uri) Sets an optional URI for the key definition.
void	setPrecedence(WritePrecedence value) Sets the write precedence for the handler.
void	writeKeyDefinitionContent(IWriteContext context) Writes the contents of the key definition.
void	writeValue(IWriteContext context) Actually writes the value for the current context.
protected abstract void	writeValueCore(IWriteContext context, TData data) Callback method that performs the actual writing of the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOutputHandler

protected AbstractOutputHandler(Class<TKey> keyType,
                                KeyScope scope,
                                String name,
                                KeyType type)

Initializes a new instance of the AbstractOutputHandler class using the provided scope, name, and type for the key definition.

Parameters:

keyType - The type of the keys.

scope - The scope.

name - The name to use for the key definition.

type - The type to use for the key definition.

See Also:

setKeyDefinitionUri(String)

AbstractOutputHandler

protected AbstractOutputHandler(Class<TKey> keyType,
                                String name)

Initializes a new instance of the AbstractOutputHandler class.

The GraphML key scope and type are determined automatically.

Parameters:

keyType - The type of the keys.

Method Detail

getDataTagAttributes

public IEnumerable<GraphMLXmlAttribute> getDataTagAttributes()

Description copied from interface: IOutputHandler

Gets the XML attributes that should be added to the data element.

Specified by:

getDataTagAttributes in interface IOutputHandler

Returns:

The attributes for the data element.

getDefaultValue

public final TData getDefaultValue()

Gets the default value.

Setting this value also sets the DefaultExisting property.

Returns:

The default value.

See Also:

setDefaultValue(Object)

getKeyDefinitionAttributes

public IEnumerable<GraphMLXmlAttribute> getKeyDefinitionAttributes()

Description copied from interface: IOutputHandler

Gets the XML attributes that should be added to the key definition in the GraphML key element.

Specified by:

getKeyDefinitionAttributes in interface IOutputHandler

Returns:

The key definition attributes.

getPrecedence

public final WritePrecedence getPrecedence()

Gets the write precedence for the handler.

Specified by:

getPrecedence in interface IOutputHandler

Returns:

The write precedence.

See Also:

setPrecedence(WritePrecedence)

getValue

protected abstract TData getValue(IWriteContext context,
                                  TKey key)

Callback method that obtains the data for the given key.

Parameters:

context - The context.

key - The key.

Returns:

The data that is associated with the key.

isDefaultExisting

public final boolean isDefaultExisting()

Gets a value indicating whether a default value has been assigned.

Returns:

true if a default value has been assigned, false otherwise.

See Also:

setDefaultExisting(boolean)

isDefaultValue

public boolean isDefaultValue(IWriteContext context)

Determines whether in the current context, the value is the default value and therefore no data element needs to be written.

This implementation will return false if no default has been set. Otherwise it will use getValue(IWriteContext, Object) and compare the result with the DefaultValue to determine whether they are equal and therefore no data needs to be written.

Specified by:

isDefaultValue in interface IOutputHandler

Parameters:

context - The context.

Returns:

true if for the current context the default value applies and therefore no data element needs to be written.

isKeyDefaultWritingEnabled

public final boolean isKeyDefaultWritingEnabled()

Gets a value indicating whether to write the key default.

Returns:

true if the key default should be written; false otherwise.

See Also:

setKeyDefaultWritingEnabled(boolean)

setDefaultExisting

protected final void setDefaultExisting(boolean value)

Sets a value indicating whether a default value has been assigned.

Parameters:

value - true if a default value has been assigned, false otherwise.

See Also:

isDefaultExisting()

setDefaultValue

public final void setDefaultValue(TData value)

Sets the default value.

Setting this value also sets the DefaultExisting property.

Parameters:

value - The default value.

See Also:

getDefaultValue()

setKeyDefaultWritingEnabled

public final void setKeyDefaultWritingEnabled(boolean value)

Sets a value indicating whether to write the key default.

Parameters:

value - true if the key default should be written; false otherwise.

See Also:

isKeyDefaultWritingEnabled()

setKeyDefinitionName

public final void setKeyDefinitionName(String name)

Sets the name for the key definition.

Parameters:

name - The name of the key element.

setKeyDefinitionScope

public final void setKeyDefinitionScope(KeyScope scope)

Sets the scope for the key definition.

Note that the official GraphML schema does not support the KeyScope.GRAPHML so this implementation will silently ignore this which will result in KeyScope.ALL implicitly being defined.

Parameters:

scope - The scope of the key element.

setKeyDefinitionType

public final void setKeyDefinitionType(KeyType type)

Sets the key type for the key definition.

Parameters:

type - The type of the key element.

setKeyDefinitionUri

public final void setKeyDefinitionUri(String uri)

Sets an optional URI for the key definition.

By default, no URI is set.

Parameters:

uri - The URI of the key element.

setPrecedence

public final void setPrecedence(WritePrecedence value)

Sets the write precedence for the handler.

Parameters:

value - The write precedence.

See Also:

getPrecedence()

writeKeyDefinitionContent

public void writeKeyDefinitionContent(IWriteContext context)
                               throws IOException

Writes the contents of the key definition.

Depending on whether KeyDefaultWritingEnabled is enabled and DefaultExisting is true, this method will write the GraphML 'default' element and use writeValueCore(IWriteContext, Object) to serialize the DefaultValue.

Specified by:

writeKeyDefinitionContent in interface IOutputHandler

Throws:

IOException - If the key definition cannot be written.

Parameters:

context - The context.

writeValue

public final void writeValue(IWriteContext context)
                      throws IOException

Actually writes the value for the current context.

This method will use getValue(IWriteContext, Object) to obtain the data and delegate to writeValueCore(IWriteContext, Object) to perform the actual serialization.

Specified by:

writeValue in interface IOutputHandler

Throws:

IOException - If the value cannot be written.

Parameters:

context - The context.

writeValueCore

protected abstract void writeValueCore(IWriteContext context,
                                       TData data)
                                throws IOException

Callback method that performs the actual writing of the data.

Throws:

IOException - If the data cannot be written.

Parameters:

context - The context.

data - The data.