com.yworks.yfiles.graphml

Class MapperOutputHandler<TKey,TData>

java.lang.Object

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

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

Type Parameters:

TKey - The type of the keys.

TData - The type of the data.

All Implemented Interfaces:

IOutputHandler

public class MapperOutputHandler<TKey,TData>
extends AbstractOutputHandler<TKey,TData>

An implementation of the AbstractOutputHandler class, that uses an IMapper to retrieve the values to output for each item and a Serializer callback for the serialization or delegates to the IWriteContext.serialize(Type, IWriteContext, java.lang.Object) callback.

Constructor Summary

Constructors

Constructor and Description
MapperOutputHandler(Class<TKey> keyType, Class<TData> dataType, KeyScope scope, String name, KeyType type) Initializes a new instance of the MapperOutputHandler class using the provided key scope, the name, and the key type.
MapperOutputHandler(Class<TKey> keyType, Class<TData> dataType, String name) Initializes a new instance of the MapperOutputHandler class using the given name and inferring the scope and the type from the class parameters.

Method Summary

Modifier and Type	Method and Description
IMapper<TKey,TData>	getMapper() Gets the mapper to use for querying the data for each item.
MapperMetadata	getMapperMetadata() Gets the mapper metadata to serialize to the key definition.
IEventHandler<HandleSerializationEventArgs>	getSerializer() Gets the serialization callback to use for serializing the value in writeValueCore(IWriteContext, java.lang.Object).
Class	getSourceType() Gets the source type of the serialization.
protected TData	getValue(IWriteContext context, TKey key) Callback method that obtains the data for the given key.
void	setMapper(IMapper<TKey,TData> value) Sets the mapper to use for querying the data for each item.
void	setMapperMetadata(MapperMetadata value) Sets the mapper metadata to serialize to the key definition.
void	setSerializer(IEventHandler<HandleSerializationEventArgs> value) Sets the serialization callback to use for serializing the value in writeValueCore(IWriteContext, java.lang.Object).
void	setSourceType(Class value) Sets the source type of the serialization.
void	writeKeyDefinitionContent(IWriteContext context) Writes the contents of the key definition.
protected void	writeValueCore(IWriteContext context, TData data) Callback method that performs the actual writing of the data using either the Serializer or the IWriteContext.serialize(Type, IWriteContext, Object) method.

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

getDataTagAttributes, getDefaultValue, getKeyDefinitionAttributes, getPrecedence, isDefaultExisting, isDefaultValue, isKeyDefaultWritingEnabled, setDefaultExisting, setDefaultValue, setKeyDefaultWritingEnabled, setKeyDefinitionName, setKeyDefinitionScope, setKeyDefinitionType, setKeyDefinitionUri, setPrecedence, writeValue

Methods inherited from class java.lang.Object

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

Constructor Detail

MapperOutputHandler

public MapperOutputHandler(Class<TKey> keyType,
                           Class<TData> dataType,
                           KeyScope scope,
                           String name,
                           KeyType type)

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

Parameters:

keyType - The type of the keys.

dataType - The type of the data.

scope - The scope for the key definition attributes.

name - The name for the key definition attributes.

type - The type for the key definition attributes.

MapperOutputHandler

public MapperOutputHandler(Class<TKey> keyType,
                           Class<TData> dataType,
                           String name)

Initializes a new instance of the MapperOutputHandler class using the given name and inferring the scope and the type from the class parameters.

The GraphML key scope and type are determined automatically.

Parameters:

keyType - The type of the keys.

dataType - The type of the data.

name - The name to use for the key attributes.

Method Detail

getMapper

public final IMapper<TKey,TData> getMapper()

Gets the mapper to use for querying the data for each item.

Returns:

The mapper.

See Also:

setMapper(IMapper)

getMapperMetadata

public final MapperMetadata getMapperMetadata()

Gets the mapper metadata to serialize to the key definition.

Returns:

The mapper metadata.

See Also:

setMapperMetadata(MapperMetadata)

getSerializer

public final IEventHandler<HandleSerializationEventArgs> getSerializer()

Gets the serialization callback to use for serializing the value in writeValueCore(IWriteContext, java.lang.Object).

Returns:

The serialization callback or null to indicate that the context should be used instead.

See Also:

getSourceType(), setSerializer(IEventHandler)

getSourceType

public final Class getSourceType()

Gets the source type of the serialization.

This type will be used as the SourceType.

Returns:

The desired type of the object that is serialized.

See Also:

getSerializer(), HandleSerializationEventArgs, setSourceType(Class)

getValue

protected TData getValue(IWriteContext context,
                         TKey key)

Callback method that obtains the data for the given key.

Specified by:

getValue in class AbstractOutputHandler<TKey,TData>

Parameters:

context - The context.

key - The key.

Returns:

The data that is associated with the key using the Mapper.

setMapper

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

Sets the mapper to use for querying the data for each item.

Parameters:

value - The mapper.

See Also:

getMapper()

setMapperMetadata

public final void setMapperMetadata(MapperMetadata value)

Sets the mapper metadata to serialize to the key definition.

Parameters:

value - The mapper metadata.

See Also:

getMapperMetadata()

setSerializer

public final void setSerializer(IEventHandler<HandleSerializationEventArgs> value)

Sets the serialization callback to use for serializing the value in writeValueCore(IWriteContext, java.lang.Object).

Parameters:

value - The serialization callback or null to indicate that the context should be used instead.

See Also:

getSourceType(), getSerializer()

setSourceType

public final void setSourceType(Class value)

Sets the source type of the serialization.

This type will be used as the SourceType.

Parameters:

value - The desired type of the object that is serialized.

See Also:

getSerializer(), HandleSerializationEventArgs, getSourceType()

writeKeyDefinitionContent

public void writeKeyDefinitionContent(IWriteContext context)
                               throws IOException

Writes the contents of the key definition.

This method will additionally write the MapperMetadata to the key definition content, if any has been set.

Specified by:

writeKeyDefinitionContent in interface IOutputHandler

Overrides:

writeKeyDefinitionContent in class AbstractOutputHandler<TKey,TData>

Throws:

IOException - If the key definition cannot be written.

Parameters:

context - The context.

writeValueCore

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

Callback method that performs the actual writing of the data using either the Serializer or the IWriteContext.serialize(Type, IWriteContext, Object) method.

Specified by:

writeValueCore in class AbstractOutputHandler<TKey,TData>

Throws:

IOException - If the data cannot be written.

Parameters:

context - The context to use for writing.

data - The data to write.