com.yworks.yfiles.graphml

Class GraphMLWriter

java.lang.Object

com.yworks.yfiles.graphml.GraphMLWriter

public class GraphMLWriter
extends Object

Core writer class for GraphML.

This class allows for low-level customization of the writing process. Usually, it is used by one of GraphMLIOHandler's Write methods which calls one the various Write method overloads. It should rarely be necessary to use this class directly.

See Also:

GraphMLIOHandler

Constructor Summary

Constructors

Constructor and Description
GraphMLWriter()

Method Summary

Modifier and Type	Method and Description
void	addHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent) Adds the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.
void	addQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent) Adds the given listener for the QueryOutputHandlers event that occurs when IOutputHandlers are queried.
void	addQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent) Adds the given listener for the QueryReferenceId event that occurs when a reference is queried.
void	addWritingListener(IEventHandler<WriteEventArgs> writingEvent) Adds the given listener for the Writing event that occurs when the writing of a document is just about to begin.
void	addWrittenListener(IEventHandler<WriteEventArgs> writtenEvent) Adds the given listener for the Written event that occurs when the writing of a document has just been finished.
protected IWriteContext	createWriteContext(IGraph graph, IXmlWriter writer) Create the initial IWriteContext instance.
Iterable<IOutputHandler>	getOutputHandlers(IWriteContext context, KeyScope scope) Dynamically retrieve all IOutputHandler that should be used for the current write process.
<T> T	getSerializationProperty(TypedKey<T> key) Retrieve a serialization property that has been set by setSerializationProperty(TypedKey, Object).
IWriteEvents	getWriteEvents() This property allows to access the events in the internal IWriteEvents implementation.
protected Object	lookup(Class type) Dynamically retrieve an instance of type.
protected void	onHandleSerialization(HandleSerializationEventArgs args) Fires the HandleSerialization event.
protected void	onQueryOutputHandlers(QueryOutputHandlersEventArgs args) Fires the QueryOutputHandlers event.
protected void	onQueryReferenceId(QueryReferenceIdEventArgs args) Fires the QueryReferenceId event.
protected void	onWriting(WriteEventArgs args) Raises the Writing event.
protected void	onWritten(WriteEventArgs args) Raises the Written event.
void	removeHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent) Removes the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.
<T> void	removeLookup(Class<T> tType) Remove an implementation of T that has been set with setLookup(Class, Object).
void	removeQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent) Removes the given listener for the QueryOutputHandlers event that occurs when IOutputHandlers are queried.
void	removeQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent) Removes the given listener for the QueryReferenceId event that occurs when a reference is queried.
<T> void	removeSerializationProperty(TypedKey<T> key) Remove a serialization property that has been set by setSerializationProperty(TypedKey, Object).
void	removeWritingListener(IEventHandler<WriteEventArgs> writingEvent) Removes the given listener for the Writing event that occurs when the writing of a document is just about to begin.
void	removeWrittenListener(IEventHandler<WriteEventArgs> writtenEvent) Removes the given listener for the Written event that occurs when the writing of a document has just been finished.
protected <T> void	serialize(Type targetType, IWriteContext context, T item) Serialize item.
<T> void	setLookup(Class<T> tType, T instance) Register an implementation of T for use with lookup(Class).
<T> void	setSerializationProperty(TypedKey<T> key, T value) Set a serialization property that allows to fine tune the write process.
void	write(IGraph graph, IXmlWriter writer) Write the GraphML representation of graph, using writer for the actual XML generation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLWriter

public GraphMLWriter()

Method Detail

addHandleSerializationListener

public final void addHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent)

Adds the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.

Subscribe to this event to provide custom serialization handling for XML content.

The event handlers added to this event are called in inverse order, i.e. handlers that have been added later are called earlier.

The current item is provided by Item.

Parameters:

handleSerializationEvent - The listener to add.

See Also:

GraphMLIOHandler.addHandleSerializationListener(IEventHandler), removeHandleSerializationListener(IEventHandler)

addQueryOutputHandlersListener

public final void addQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent)

Adds the given listener for the QueryOutputHandlers event that occurs when IOutputHandlers are queried.

Subscribe to this event to dynamically register one or more IOutputHandler instance(s) for a given GraphML attribute key definition.

The event handlers added to this event are called in inverse order, i.e. handlers that have been added later are called earlier.

If you want to register an IOutputHandler for this GraphML attribute, you can add the handler with QueryOutputHandlersEventArgs.addOutputHandler(IOutputHandler).

Parameters:

queryOutputHandlersEvent - The listener to add.

See Also:

GraphMLIOHandler.addQueryOutputHandlersListener(IEventHandler), removeQueryOutputHandlersListener(IEventHandler)

addQueryReferenceIdListener

public final void addQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent)

Adds the given listener for the QueryReferenceId event that occurs when a reference is queried.

This event can be used to provide names of external references for objects.

These reference targets are not serialized to the GraphML file.

Parameters:

queryReferenceIdEvent - The listener to add.

See Also:

GraphMLIOHandler.addQueryReferenceIdListener(IEventHandler), removeQueryReferenceIdListener(IEventHandler)

addWritingListener

public final void addWritingListener(IEventHandler<WriteEventArgs> writingEvent)

Adds the given listener for the Writing event that occurs when the writing of a document is just about to begin.

This event can be used to register to the fine-grained events available in the Context's WriteEvents and to configure the writing process on a per write case.

Parameters:

writingEvent - The listener to add.

See Also:

onWriting(WriteEventArgs), removeWritingListener(IEventHandler)

addWrittenListener

public final void addWrittenListener(IEventHandler<WriteEventArgs> writtenEvent)

Adds the given listener for the Written event that occurs when the writing of a document has just been finished.

Parameters:

writtenEvent - The listener to add.

See Also:

onWritten(WriteEventArgs), removeWrittenListener(IEventHandler)

createWriteContext

protected IWriteContext createWriteContext(IGraph graph,
                                           IXmlWriter writer)

Create the initial IWriteContext instance.

Parameters:

graph - The graph that is written.

writer - The core IXmlWriter instance that does the actual writing of XML content.

Returns:

An IWriteContext instance that is suitable for graph.

getOutputHandlers

public Iterable<IOutputHandler> getOutputHandlers(IWriteContext context,
                                                  KeyScope scope)

Dynamically retrieve all IOutputHandler that should be used for the current write process.

Typically, this method is called only indirectly by the write process. This implementation calls onQueryOutputHandlers(QueryOutputHandlersEventArgs), which in turn raises the QueryOutputHandlers event.

Parameters:

context - The current write context.

scope - The scope to get output handlers for.

Returns:

A dictionary from handler definition ids to IOutputHandlers.

getSerializationProperty

public <T> T getSerializationProperty(TypedKey<T> key)

Retrieve a serialization property that has been set by setSerializationProperty(TypedKey, Object).

The return value is automatically converted to type T.

Type Parameters:

T - The target type of the property.

Parameters:

key - The key for the property.

See Also:

IWriteContext.getSerializationProperty(TypedKey)

getWriteEvents

public final IWriteEvents getWriteEvents()

This property allows to access the events in the internal IWriteEvents implementation.

You can subscribe to any of the events in the returned IWriteEvents instance to react to various steps in the writing process

Returns:

The WriteEvents.

lookup

protected Object lookup(Class type)

Dynamically retrieve an instance of type.

Parameters:

type - The type for which an implementation is needed.

Returns:

An implementation of type, or null.

onHandleSerialization

protected void onHandleSerialization(HandleSerializationEventArgs args)

Fires the HandleSerialization event.

Parameters:

args - The arguments that get passed to the HandleSerialization event.

See Also:

GraphMLIOHandler.onHandleSerialization(HandleSerializationEventArgs)

onQueryOutputHandlers

protected void onQueryOutputHandlers(QueryOutputHandlersEventArgs args)

Fires the QueryOutputHandlers event.

Parameters:

args - The arguments that get passed to the QueryOutputHandlers event.

See Also:

GraphMLIOHandler.onQueryOutputHandlers(QueryOutputHandlersEventArgs)

onQueryReferenceId

protected void onQueryReferenceId(QueryReferenceIdEventArgs args)

Fires the QueryReferenceId event.

Parameters:

args - The arguments that get passed to the QueryReferenceId event.

See Also:

GraphMLIOHandler.onQueryReferenceId(QueryReferenceIdEventArgs)

onWriting

protected void onWriting(WriteEventArgs args)

Raises the Writing event.

This method is called just before the writing starts and before DocumentWriting is called for the first time.

Parameters:

args - The WriteEventArgs instance containing the event data.

See Also:

addWritingListener(IEventHandler)

onWritten

protected void onWritten(WriteEventArgs args)

Raises the Written event.

This method is called just before the writing has been finished and after DocumentWritten is called for the last time.

Parameters:

args - The WriteEventArgs instance containing the event data.

See Also:

addWrittenListener(IEventHandler)

removeHandleSerializationListener

public final void removeHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent)

Removes the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.

Subscribe to this event to provide custom serialization handling for XML content.

The event handlers added to this event are called in inverse order, i.e. handlers that have been added later are called earlier.

The current item is provided by Item.

Parameters:

handleSerializationEvent - The listener to remove.

See Also:

GraphMLIOHandler.addHandleSerializationListener(IEventHandler), addHandleSerializationListener(IEventHandler)

removeLookup

public <T> void removeLookup(Class<T> tType)

Remove an implementation of T that has been set with setLookup(Class, Object).

removeQueryOutputHandlersListener

public final void removeQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent)

Removes the given listener for the QueryOutputHandlers event that occurs when IOutputHandlers are queried.

Subscribe to this event to dynamically register one or more IOutputHandler instance(s) for a given GraphML attribute key definition.

The event handlers added to this event are called in inverse order, i.e. handlers that have been added later are called earlier.

If you want to register an IOutputHandler for this GraphML attribute, you can add the handler with QueryOutputHandlersEventArgs.addOutputHandler(IOutputHandler).

Parameters:

queryOutputHandlersEvent - The listener to remove.

See Also:

GraphMLIOHandler.addQueryOutputHandlersListener(IEventHandler), addQueryOutputHandlersListener(IEventHandler)

removeQueryReferenceIdListener

public final void removeQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent)

Removes the given listener for the QueryReferenceId event that occurs when a reference is queried.

This event can be used to provide names of external references for objects.

These reference targets are not serialized to the GraphML file.

Parameters:

queryReferenceIdEvent - The listener to remove.

See Also:

GraphMLIOHandler.addQueryReferenceIdListener(IEventHandler), addQueryReferenceIdListener(IEventHandler)

removeSerializationProperty

public <T> void removeSerializationProperty(TypedKey<T> key)

Remove a serialization property that has been set by setSerializationProperty(TypedKey, Object).

Parameters:

key - The key for the property.

See Also:

IWriteContext.getSerializationProperty(TypedKey)

removeWritingListener

public final void removeWritingListener(IEventHandler<WriteEventArgs> writingEvent)

Removes the given listener for the Writing event that occurs when the writing of a document is just about to begin.

This event can be used to register to the fine-grained events available in the Context's WriteEvents and to configure the writing process on a per write case.

Parameters:

writingEvent - The listener to remove.

See Also:

onWriting(WriteEventArgs), addWritingListener(IEventHandler)

removeWrittenListener

public final void removeWrittenListener(IEventHandler<WriteEventArgs> writtenEvent)

Removes the given listener for the Written event that occurs when the writing of a document has just been finished.

Parameters:

writtenEvent - The listener to remove.

See Also:

onWritten(WriteEventArgs), addWrittenListener(IEventHandler)

serialize

protected <T> void serialize(Type targetType,
                             IWriteContext context,
                             T item)
                      throws SerializationNotSupportedException

Serialize item.

Typically, this method is called only indirectly by calls to IWriteContext.serialize(Type, IWriteContext, Object) or IWriteContext.serialize(Type, Object). This implementation calls onHandleSerialization(HandleSerializationEventArgs), which in turn raises the HandleSerialization event.

Throws:

SerializationNotSupportedException - SerializationNotSupportedException if item cannot be serialized.

Type Parameters:

T - The desired type of the result.

Parameters:

targetType - The desired type of the result.

context - The current parse context.

item - The object that should be serialized.

See Also:

IWriteContext.serialize(Type, IWriteContext, Object), IWriteContext.serialize(Type, Object), addHandleSerializationListener(IEventHandler)

setLookup

public <T> void setLookup(Class<T> tType,
                          T instance)

Register an implementation of T for use with lookup(Class).

Type Parameters:

T - The type of instance.

Parameters:

tType - The type of instance.

instance - The implementation of T for lookup retrieval.

setSerializationProperty

public <T> void setSerializationProperty(TypedKey<T> key,
                                         T value)

Set a serialization property that allows to fine tune the write process.

Parameters:

key - The key for the property.

value - The property value.

See Also:

IWriteContext.getSerializationProperty(TypedKey)

write

public void write(IGraph graph,
                  IXmlWriter writer)
           throws IOException

Write the GraphML representation of graph, using writer for the actual XML generation.

Typically, this method is called indirectly from GraphMLIOHandler.write(IGraph, java.io.Writer).

Throws:

IOException

Parameters:

graph - The graph instance that is populated.

writer - The writer that actually writes the XML content.

See Also:

GraphMLIOHandler.write(IGraph, java.io.Writer)