com.yworks.yfiles.graphml

Class GraphMLIOHandler

java.lang.Object

com.yworks.yfiles.graphml.GraphMLIOHandler

public class GraphMLIOHandler
extends Object

Class for reading/writing graphs from/to GraphML format.

For more information about the GraphML file format please refer to the GraphML Primer.

Constructor Summary

Constructors

Constructor and Description
GraphMLIOHandler() Creates a new instance of GraphMLIOHandler.

Method Summary

Modifier and Type	Method and Description
void	addHandleDeserializationListener(IEventHandler<HandleDeserializationEventArgs> handleDeserializationEvent) Adds the given listener for the HandleDeserialization event that occurs when XML content is about to be deserialized.
void	addHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent) Adds the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.
Future<IInputHandler>	addInputHandlerFactory(Predicate<Element> keyDefinitionPredicate, IGenericInputHandlerFactory factory) Create a Future instance that wraps an IInputHandler that is dynamically created by factory.
<TKey,TData> void	addInputMapper(Class<TKey> keyType, Class<TData> dataType, Predicate<Element> keyDefinitionPredicate, IMapper<TKey,TData> mapper, IEventHandler<HandleDeserializationEventArgs> deserializationCallback) Register a IMapper instance for use as an input data target.
<TKey,TData> void	addInputMapper(Class<TKey> keyType, Class<TData> dataType, String name, IMapper<TKey,TData> mapper) Register a IMapper instance for use as an input data target.
<TKey,TData> Future<IMapper<TKey,TData>>	addInputMapperFuture(Class<TKey> keyType, Class<TData> dataType, Predicate<Element> keyDefinitionPredicate, IEventHandler<HandleDeserializationEventArgs> deserializationCallback) Create a Future instance that wraps an IMapper for use as an input data target.
<TKey,TData> Future<IMapper<TKey,TData>>	addInputMapperFuture(Class<TKey> keyType, Class<TData> dataType, String name) Create a Future instance that wraps an IMapper for use as an input data target.
void	addNamespace(String namespaceURI, String shortName) Adds a namespace to the header of a GraphML file.
void	addNamespaceMapping(String xmlNamespace, Class type) Adds a mapping for a xmlNamespace to the package of the given type.
void	addNamespaceMapping(String xmlNamespace, String namespacePrefix, Class type) Adds a mapping for a xmlNamespace with a custom prefix to the package of the given type.
void	addNamespaceMapping(String xmlNamespace, String packageName, ClassLoader classLoader) Adds a mapping for a xmlNamespace to a packageName and its classLoader.
void	addNamespaceMapping(String xmlNamespace, String namespacePrefix, String packageName, ClassLoader classLoader) Adds a mapping for a xmlNamespace with a custom prefix to a packageName and its classLoader.
<TModelItem,TValue> void	addOutputMapper(Class<TModelItem> modelItemType, Class<TValue> valueType, String name, IMapper<TModelItem,TValue> mapper) Register a IMapper instance for use as an output data source.
<TModelItem,TValue> void	addOutputMapper(Class<TModelItem> modelItemType, Class<TValue> valueType, String name, String uri, IMapper<TModelItem,TValue> mapper, IEventHandler<HandleSerializationEventArgs> serializationCallback, KeyType declaredKeyType) Register a IMapper instance for use as an output data source.
void	addOverrideResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> overrideResolveReferenceEvent) Adds the given listener for the OverrideResolveReference event that occurs before inline references are evaluated.
void	addParsedListener(IEventHandler<ParseEventArgs> parsedEvent) Adds the given listener for the Parsed event that occurs when the the document has been parsed.
void	addParsingListener(IEventHandler<ParseEventArgs> parsingEvent) Adds the given listener for the Parsing event that occurs when the parsing of a document is just about to begin.
void	addQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent) Adds the given listener for the QueryInputHandlers event that occurs when a GraphML attribute is about to be read.
void	addQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent) Adds the given listener for the QueryOutputHandlers event that occurs when a GraphML attribute is about to be written.
void	addQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent) Adds the given listener for the QueryReferenceId event that occurs when a reference is queried.
<TKey,TData> Future<IMapper<TKey,TData>>	addRegistryInputMapper(Class<TKey> keyType, Class<TData> dataType, Object tag, Predicate<Element> keyDefinitionPredicate, IEventHandler<HandleDeserializationEventArgs> deserializationCallback) Create a Future instance that wraps an IInputHandler that stores the data in an IMapper that will be created in the graph's IMapperRegistry.
<TKey,TData> Future<IMapper<TKey,TData>>	addRegistryInputMapper(Class<TKey> keyType, Class<TData> dataType, String name) Create a Future instance that wraps an IInputHandler that stores the data in an IMapper that will be created in the graph's IMapperRegistry.
<TModelItem,TValue> void	addRegistryOutputMapper(Class<TModelItem> modelItemType, Class<TValue> valueType, String name, Object tag) Use a registered IMapper instance as source for the given GraphML attribute.
<TModelItem,TValue> void	addRegistryOutputMapper(Class<TModelItem> modelItemType, Class<TValue> valueType, String name, String uri, Object tag, IEventHandler<HandleSerializationEventArgs> serializationCallback, KeyType declaredKeyType) Use a registered IMapper instance as source for the given GraphML attribute.
void	addRegistryOutputMapper(String name, Object tag) Use a registered IMapper instance as source for the given GraphML attribute.
void	addRegistryOutputMapper(String name, String uri, Object tag, IEventHandler<HandleSerializationEventArgs> serializationCallback) Use a registered IMapper instance as source for the given GraphML attribute.
void	addResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> resolveReferenceEvent) Adds the given listener for the ResolveReference event that occurs after references are evaluated.
void	addSchemaLocation(String schemaNamespace, String schemaLocation) Adds a schema location to the header of a GraphML file.
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 been finished.
protected void	configureDeserializationHandlers(IGraph graph, GraphMLParser parser) Configure the predefined handlers for the HandleDeserialization event.
protected void	configureDeserializationPropertyOverrides(GraphMLParser parser) Configures the deserialization property overrides for the given parser.
protected void	configureGraphMLParser(GraphMLParser parser, IGraph graph) Configures a given instance of GraphMLParser that can handle the given graph.
protected void	configureGraphMLWriter(GraphMLWriter writer, IGraph graph) Configures a given GraphMLWriter that is used for writing graph.
protected void	configureInputHandlers(GraphMLParser parser) Configures default event handlers for the QueryInputHandlers event.
protected void	configureLookup(GraphMLParser parser) Configures the lookup of the given parser.
protected void	configureLookup(IGraph graph, GraphMLWriter writer) Configure the lookup map of writer.
protected void	configureNamespaces(GraphMLWriter writer) Configures writer to use the namespace declarations set with addNamespace(String, String).
protected void	configureOutputHandlers(IGraph graph, GraphMLWriter writer) Configures default event handlers for the QueryOutputHandlers event.
protected void	configureSchemaLocations(GraphMLWriter writer) Configures writer to use the schema locations set with addSchemaLocation(String, String).
protected void	configureSerializationHandlers(IGraph graph, GraphMLWriter writer) Configures the predefined handlers for the HandleSerialization event.
protected void	configureSerializationProperties(IGraph graph, GraphMLWriter writer) Configure important serialization properties from properties of GraphMLIOHandler.
protected void	configureSerializationPropertyOverrides(GraphMLWriter writer) Configures the serialization property overrides for the given writer.
protected void	configureXMLWriter(IXmlWriter writer) Configure writer.
protected IValueSerializerContext	createDefaultValueSerializerContext() Creates the default value serializer context and returns it.
protected IGraphElementFactory	createGraphElementFactory(GraphMLParser parser, IGraph graph) Create an IGraphElementFactory instance that creates the graph elements for the graph instance.
protected GraphMLParser	createGraphMLParser(IGraph graph) Create a suitable instance of GraphMLParser that can handle the given graph.
protected GraphMLWriter	createGraphMLWriter(IGraph graph) Create and configure a new GraphMLWriter that is used for writing graph.
protected <TKey,TData> IMapper<TKey,TData>	createMapper(Class<TKey> keyType, Class<TData> dataType, IParseContext context, Object registryTag) Callback used by addRegistryInputMapper(Class, Class, String) and its overloads to creates the mapper instance.
static <TKey,TData> MapperInputHandler<TKey,TData>	createMapperInputHandler(Class<TKey> modelItemType, Class<TData> dataType, IMapper<TKey,TData> mapper, IEventHandler<HandleDeserializationEventArgs> deserializationCallback) Convenience factory method that can create an instance of several predefined IInputHandler implementations that match the provided TKey and TData.
static <TKey,TData> MapperOutputHandler<TKey,TData>	createMapperOutputHandler(Class<TKey> modelItemType, Class<TData> dataType, String name, IMapper<TKey,TData> mapper, IEventHandler<HandleSerializationEventArgs> serializationCallback) Convenience factory method that can create an instance of several predefined IOutputHandler implementations that match the provided TKey and TData.
protected IXamlNameMapper	createXamlNameMapper() Configure mappings from package to XML names.
protected IXamlPrefixMapper	createXamlPrefixMapper() Configure mappings from XML namespaces to prefixes.
protected IXmlWriter	createXMLWriter(OutputStream os, Charset encoding) Factory method that creates and configures a suitable IXmlWriter implementation that can write the graph to the given InputStream with the given settings.
protected IXmlWriter	createXMLWriter(Writer os) Factory method that creates and configures a suitable IXmlWriter implementation that can write the graph to the given Writer with the given settings.
TypedKeyMapper	getDeserializationPropertyOverrides() Gets the mapper for the overrides of the deserialization properties.
TypedKeyMapper	getSerializationPropertyOverrides() Gets the mapper for the overrides of the serialization properties.
protected void	handleArraySerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of arrays.
protected void	handleListSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of Iterable instances.
protected void	handleMarkupExtensionBasedSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of MarkupExtension convertible instances.
protected void	handleNullSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of null references.
protected void	handlePrimitivesDeserialization(Object sender, HandleDeserializationEventArgs e) Handle the serialization of primitive types, enums and strings.
protected void	handleReferenceHandleSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of IReferenceHandle instances.
protected void	handleTextConvertibleSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of instances that can be serialized through a ValueSerializer.
protected void	handleTextNodeDeserialization(Object source, HandleDeserializationEventArgs args) Callback for the HandleDeserialization event.
protected void	handleTypeExtensionSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of TypeExtensions.
protected void	handleTypeSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of Types.
protected void	handleXamlDeserialization(Object source, HandleDeserializationEventArgs args) Callback for the HandleDeserialization event.
protected void	handleXamlSerialization(Object sender, HandleSerializationEventArgs e) Handle the serialization of complex objects that are not handled by other callbacks.
boolean	isClearingGraphBeforeReadEnabled() Whether to clear an existing graph instance before reading.
boolean	isWritingSharedReferencesEnabled() Whether to support object sharing on output.
boolean	isWritingXMLSchemaEnabled() true if schema descriptions should be written.
static boolean	matchesName(Element definition, String name) Checks whether the name attribute in definition matches name.
static boolean	matchesScope(Element definition, KeyScope scope) Checks whether the scope attribute in definition matches scope.
static boolean	matchesType(Element definition, KeyType type) Checks whether the type attribute in definition matches type.
static boolean	matchesUri(Element definition, String uri) Checks whether the uri attribute in definition matches uri.
protected void	onGraphMLParserHandleDeserialization(Object sender, HandleDeserializationEventArgs e) Event handler for the HandleDeserialization event.
protected void	onGraphMLParserQueryInputHandlers(Object sender, QueryInputHandlersEventArgs e) Event handler for the QueryInputHandlers event.
protected void	onGraphMLWriterHandleSerialization(Object sender, HandleSerializationEventArgs e) Event handler for the HandleSerialization event.
protected void	onGraphMLWriterQueryOutputHandlers(Object sender, QueryOutputHandlersEventArgs e) Event handler for the QueryOutputHandlers event.
protected void	onHandleDeserialization(HandleDeserializationEventArgs args) Raises the HandleDeserialization event.
protected void	onHandleSerialization(HandleSerializationEventArgs args) Raises the HandleSerialization event.
protected void	onOverrideResolveReference(ResolveReferenceEventArgs args) Fires the OverrideResolveReference event.
protected void	onParsed(ParseEventArgs args) Raises the Parsed event.
protected void	onParsing(ParseEventArgs args) Raises the Parsing event.
protected void	onQueryInputHandlers(QueryInputHandlersEventArgs args) Raises the QueryInputHandlers event.
protected void	onQueryOutputHandlers(QueryOutputHandlersEventArgs args) Raises the QueryOutputHandlers event.
protected void	onQueryReferenceId(QueryReferenceIdEventArgs args) Fires the QueryReferenceId event.
protected void	onResolveReference(ResolveReferenceEventArgs args) Fires the ResolveReference event.
protected void	onWriting(WriteEventArgs args) Raises the Writing event.
protected void	onWritten(WriteEventArgs args) Raises the Written event.
void	read(IGraph graph, Document document) Read GraphML from an existing XML document.
void	read(IGraph graph, InputStream stream) Reads GraphML content from the given input stream and populates the Graph object.
void	read(IGraph graph, InputStream stream, URI baseUri) Reads GraphML content from the given input stream and populates the Graph object.
void	read(IGraph graph, Reader reader) Reads GraphML content from the given reader and populates the Graph object.
void	read(IGraph graph, Reader reader, URI baseUri) Reads GraphML content from the given reader and populates the Graph object.
void	read(IGraph graph, String filename) Reads a GraphML file from the given GraphML file and populates the IGraph object.
void	read(IGraph graph, URL url) Reads a GraphML file from the given url inside the applications xap file and populates the Graph object.
protected void	registerEdgeBendsInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads edge bends.
protected void	registerEdgeBendsOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes edge bends.
protected void	registerEdgeLabelsInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads edge labels.
protected void	registerEdgeLabelsOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes edge labels.
protected void	registerEdgeStyleInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads edge styles.
protected void	registerEdgeStyleOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes edge styles.
protected void	registerGraphSettingsInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads IGraph graph default settings.
protected void	registerGraphSettingsOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes the settings of a graph.
protected void	registerNodeLabelsInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads node labels.
protected void	registerNodeLabelsOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes node labels.
protected void	registerNodeLayoutInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads node layouts.
protected void	registerNodeLayoutOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes node layouts.
protected void	registerNodeStyleInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads node styles.
protected void	registerNodeStyleOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes node styles.
protected void	registerPortLocationInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads port locations.
protected void	registerPortLocationOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes port locations.
protected void	registerPortStyleInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads port styles.
protected void	registerPortStyleOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes port styles.
protected void	registerTagInputHandler(Object sender, QueryInputHandlersEventArgs e) Predefined input handler that reads ITagOwner tags.
protected void	registerTagOutputHandler(Object sender, QueryOutputHandlersEventArgs e) Predefined output handler that writes ITagOwner tags.
void	removeHandleDeserializationListener(IEventHandler<HandleDeserializationEventArgs> handleDeserializationEvent) Removes the given listener for the HandleDeserialization event that occurs when XML content is about to be deserialized.
void	removeHandleSerializationListener(IEventHandler<HandleSerializationEventArgs> handleSerializationEvent) Removes the given listener for the HandleSerialization event that occurs when XML content is about to be serialized.
void	removeOverrideResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> overrideResolveReferenceEvent) Removes the given listener for the OverrideResolveReference event that occurs before inline references are evaluated.
void	removeParsedListener(IEventHandler<ParseEventArgs> parsedEvent) Removes the given listener for the Parsed event that occurs when the the document has been parsed.
void	removeParsingListener(IEventHandler<ParseEventArgs> parsingEvent) Removes the given listener for the Parsing event that occurs when the parsing of a document is just about to begin.
void	removeQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent) Removes the given listener for the QueryInputHandlers event that occurs when a GraphML attribute is about to be read.
void	removeQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent) Removes the given listener for the QueryOutputHandlers event that occurs when a GraphML attribute is about to be written.
void	removeQueryReferenceIdListener(IEventHandler<QueryReferenceIdEventArgs> queryReferenceIdEvent) Removes the given listener for the QueryReferenceId event that occurs when a reference is queried.
void	removeResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> resolveReferenceEvent) Removes the given listener for the ResolveReference event that occurs after references are evaluated.
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 been finished.
void	setClearingGraphBeforeReadEnabled(boolean value) Whether to clear an existing graph instance before reading.
void	setWritingSharedReferencesEnabled(boolean value) Whether to support object sharing on output.
void	setWritingXMLSchemaEnabled(boolean value) true if schema descriptions should be written.
void	write(IGraph graph, OutputStream os) Writes the given graph object to the output stream creating a GraphML file.
void	write(IGraph graph, OutputStream os, Charset encoding) Writes the given graph object to the output stream creating a GraphML file.
void	write(IGraph graph, String filename) Writes the given graph object to a GraphML file with a given filename.
void	write(IGraph graph, Writer os) Writes the given graph object to the output writer creating a GraphML file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLIOHandler

public GraphMLIOHandler()

Creates a new instance of GraphMLIOHandler.

Method Detail

addHandleDeserializationListener

public final void addHandleDeserializationListener(IEventHandler<HandleDeserializationEventArgs> handleDeserializationEvent)

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

Subscribe to this event to provide custom deserialization 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 XML content is provided by XmlNode. If you want to return deserialized content, set the value of the Result property.

Parameters:

handleDeserializationEvent - The listener to add.

See Also:

GraphMLParser.addHandleDeserializationListener(IEventHandler), removeHandleDeserializationListener(IEventHandler)

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:

removeHandleSerializationListener(IEventHandler)

addInputHandlerFactory

public final Future<IInputHandler> addInputHandlerFactory(Predicate<Element> keyDefinitionPredicate,
                                                          IGenericInputHandlerFactory factory)

Create a Future instance that wraps an IInputHandler that is dynamically created by factory.

The return value will only contain a value if a matching GraphML attribute has been read, which can be queried with HasValue. The validity is determined by keyDefinitionPredicate. This methods creates and configures the necessary handler itself.

Parameters:

keyDefinitionPredicate - The predicate that matches the key definition.

factory - A factory to create IInputHandler instances.

Returns:

A Future instance that wraps an IInputHandler that actually parses the data.

addInputMapper

public final <TKey,TData> void addInputMapper(Class<TKey> keyType,
                                              Class<TData> dataType,
                                              Predicate<Element> keyDefinitionPredicate,
                                              IMapper<TKey,TData> mapper,
                                              IEventHandler<HandleDeserializationEventArgs> deserializationCallback)

Register a IMapper instance for use as an input data target.

This method uses a custom IEventHandler for the actual deserialization.

This methods creates and configures the necessary handler itself.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper values

Parameters:

dataType - The type of the mapper values

keyType - The type of the mapper keys

keyDefinitionPredicate - The predicate function that will determine whether to create an IInputHandler for the given key definition.

mapper - the mapper that serves as data source

deserializationCallback - custom deserialization callback.

addInputMapper

public final <TKey,TData> void addInputMapper(Class<TKey> keyType,
                                              Class<TData> dataType,
                                              String name,
                                              IMapper<TKey,TData> mapper)

Register a IMapper instance for use as an input data target.

This methods creates and configures the necessary handler itself.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper values

Parameters:

dataType - The type of the mapper values

keyType - The type of the mapper keys

name - The name of the attribute

mapper - the mapper that serves as data source

addInputMapperFuture

public final <TKey,TData> Future<IMapper<TKey,TData>> addInputMapperFuture(Class<TKey> keyType,
                                                                           Class<TData> dataType,
                                                                           Predicate<Element> keyDefinitionPredicate,
                                                                           IEventHandler<HandleDeserializationEventArgs> deserializationCallback)

Create a Future instance that wraps an IMapper for use as an input data target.

The return value will only contain a value if a matching GraphML attribute has been read, which can be queried with HasValue This methods creates and configures the necessary handler itself.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper values

Parameters:

dataType - The type of the mapper values

keyType - The type of the mapper keys

deserializationCallback - custom deserialization callback.

keyDefinitionPredicate - The predicate function that will determine whether to create an IInputHandler for the given key definition.

Returns:

A Future instance that wraps an IMapper that actually holds the data.

addInputMapperFuture

public final <TKey,TData> Future<IMapper<TKey,TData>> addInputMapperFuture(Class<TKey> keyType,
                                                                           Class<TData> dataType,
                                                                           String name)

Create a Future instance that wraps an IMapper for use as an input data target.

The return value will only contain a value if a matching GraphML attribute has been read, which can be queried with HasValue This methods creates and configures the necessary handler itself.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper values

Parameters:

dataType - The type of the mapper values

keyType - The type of the mapper keys

name - The name of the attribute

Returns:

A Future instance that wraps an IMapper that actually holds the data.

addNamespace

public void addNamespace(String namespaceURI,
                         String shortName)

Adds a namespace to the header of a GraphML file.

Parameters:

namespaceURI - The namespace URI

shortName - The namespace prefix

addNamespaceMapping

public void addNamespaceMapping(String xmlNamespace,
                                Class type)

Adds a mapping for a xmlNamespace to the package of the given type.

The mapping is added to the createXamlNameMapper() IXamlNameMapper} to determining type information from XML elements and to lookup the xmlNamespace that should be used for a class in type`s package.

Parameters:

xmlNamespace - The XML namespace to map.

type - A class in the package that should be mapped.

addNamespaceMapping

public void addNamespaceMapping(String xmlNamespace,
                                String namespacePrefix,
                                Class type)

Adds a mapping for a xmlNamespace with a custom prefix to the package of the given type.

The mapping is added to the createXamlNameMapper() IXamlNameMapper} to determining type information from XML elements and to lookup the xmlNamespace that should be used for a class in type`s package.

Parameters:

xmlNamespace - The XML namespace to map.

namespacePrefix - The prefix of the namespace to map.

type - A class in the package that should be mapped.

addNamespaceMapping

public void addNamespaceMapping(String xmlNamespace,
                                String packageName,
                                ClassLoader classLoader)

Adds a mapping for a xmlNamespace to a packageName and its classLoader.

The mapping is added to the createXamlNameMapper() IXamlNameMapper} to determining type information from XML elements and to lookup the xmlNamespace that should be used for a class in packageName.

Parameters:

xmlNamespace - The XML namespace to map.

packageName - The package name.

classLoader - The ClassLoader to load the classes in the given package.

addNamespaceMapping

public void addNamespaceMapping(String xmlNamespace,
                                String namespacePrefix,
                                String packageName,
                                ClassLoader classLoader)

Adds a mapping for a xmlNamespace with a custom prefix to a packageName and its classLoader.

The mapping is added to the createXamlNameMapper() IXamlNameMapper} to determining type information from XML elements and to lookup the xmlNamespace that should be used for a class in packageName.

Parameters:

xmlNamespace - The XML namespace to map.

packageName - The package name.

classLoader - The ClassLoader to load the classes in the given package.

addOutputMapper

public final <TModelItem,TValue> void addOutputMapper(Class<TModelItem> modelItemType,
                                                      Class<TValue> valueType,
                                                      String name,
                                                      IMapper<TModelItem,TValue> mapper)

Register a IMapper instance for use as an output data source.

This methods creates and configures the necessary handler itself

Type Parameters:

TModelItem - The type of the mapper keys

TValue - The type of the mapper values

Parameters:

valueType - The type of the mapper values

modelItemType - The type of the mapper keys

name - The name of the attribute

mapper - the mapper that serves as data source

addOutputMapper

public final <TModelItem,TValue> void addOutputMapper(Class<TModelItem> modelItemType,
                                                      Class<TValue> valueType,
                                                      String name,
                                                      String uri,
                                                      IMapper<TModelItem,TValue> mapper,
                                                      IEventHandler<HandleSerializationEventArgs> serializationCallback,
                                                      KeyType declaredKeyType)

Register a IMapper instance for use as an output data source.

This method uses a custom IEventHandler for the actual serialization.

This methods creates and configures the necessary handler itself.

Type Parameters:

TModelItem - The type of the mapper keys

TValue - The type of the mapper values

Parameters:

valueType - The type of the mapper values

modelItemType - The type of the mapper keys

name - The name of the attribute

uri - The URI to add to the key definition to disambiguate keys.

mapper - the mapper that serves as data source

serializationCallback - custom serialization callback.

declaredKeyType - The key type to write in the declaration.

addOverrideResolveReferenceListener

public final void addOverrideResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> overrideResolveReferenceEvent)

Adds the given listener for the OverrideResolveReference event that occurs before inline references are evaluated.

Subscribe to this event to customize resolving of GraphML object references. This event is fired before the framework tries to resolve internal references and can therefore be used to override internal references, for example.

Parameters:

overrideResolveReferenceEvent - The listener to add.

See Also:

addResolveReferenceListener(IEventHandler), removeOverrideResolveReferenceListener(IEventHandler)

addParsedListener

public final void addParsedListener(IEventHandler<ParseEventArgs> parsedEvent)

Adds the given listener for the Parsed event that occurs when the the document has been parsed.

Parameters:

parsedEvent - The listener to add.

See Also:

onParsed(ParseEventArgs), GraphMLParser.addParsedListener(IEventHandler), removeParsedListener(IEventHandler)

addParsingListener

public final void addParsingListener(IEventHandler<ParseEventArgs> parsingEvent)

Adds the given listener for the Parsing event that occurs when the parsing 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 ParseEvents and to configure the parsing process on a per parse case.

Parameters:

parsingEvent - The listener to add.

See Also:

onParsing(ParseEventArgs), GraphMLParser.addParsingListener(IEventHandler), removeParsingListener(IEventHandler)

addQueryInputHandlersListener

public final void addQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent)

Adds the given listener for the QueryInputHandlers event that occurs when a GraphML attribute is about to be read.

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

The current key definition is provided by KeyDefinition. If you want to register an IInputHandler for this GraphML attribute, you can add the handler with QueryInputHandlersEventArgs.addInputHandler(IInputHandler) method. Implementations should also consider the Handled property.

Parameters:

queryInputHandlersEvent - The listener to add.

See Also:

GraphMLParser.addQueryInputHandlersListener(IEventHandler), removeQueryInputHandlersListener(IEventHandler)

addQueryOutputHandlersListener

public final void addQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent)

Adds the given listener for the QueryOutputHandlers event that occurs when a GraphML attribute is about to be written.

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:

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 or internal references for objects.

The reference targets are not serialized to the GraphML file if they are set to GraphMLReferenceType.EXTERNAL. To resolve these references when parsing, you typically have to subscribe to the ResolveReference event.

Parameters:

queryReferenceIdEvent - The listener to add.

See Also:

QueryReferenceIdEventArgs.getReferenceId(), QueryReferenceIdEventArgs.getReferenceType(), removeQueryReferenceIdListener(IEventHandler)

addRegistryInputMapper

public final <TKey,TData> Future<IMapper<TKey,TData>> addRegistryInputMapper(Class<TKey> keyType,
                                                                             Class<TData> dataType,
                                                                             Object tag,
                                                                             Predicate<Element> keyDefinitionPredicate,
                                                                             IEventHandler<HandleDeserializationEventArgs> deserializationCallback)

Create a Future instance that wraps an IInputHandler that stores the data in an IMapper that will be created in the graph's IMapperRegistry.

The return value will only contain a value if a matching GraphML attribute has been read, which can be queried with HasValue. This methods creates and configures the necessary handler itself and creates an IMapper in the IMapperRegistry with name tag.

Parameters:

tag - The name of the key in the IMapperRegistry.

keyDefinitionPredicate - A predicate to determine whether the key definition is valid.

deserializationCallback - The custom deserialization callback, can be null which will result in default deserialization.

Returns:

A Future instance that wraps an IMapper that actually holds the data.

addRegistryInputMapper

public final <TKey,TData> Future<IMapper<TKey,TData>> addRegistryInputMapper(Class<TKey> keyType,
                                                                             Class<TData> dataType,
                                                                             String name)

Create a Future instance that wraps an IInputHandler that stores the data in an IMapper that will be created in the graph's IMapperRegistry.

The return value will only contain a value if a matching GraphML attribute has been read, which can be queried with HasValue. The attribute must be registered under the attribute name name. This methods creates and configures the necessary handler itself and creates an IMapper in the IMapperRegistry with name name.

Parameters:

name - The name of the GraphML attribute and the key in the IMapperRegistry.

Returns:

A Future instance that wraps an IMapper that actually holds the data.

addRegistryOutputMapper

public final <TModelItem,TValue> void addRegistryOutputMapper(Class<TModelItem> modelItemType,
                                                              Class<TValue> valueType,
                                                              String name,
                                                              Object tag)

Use a registered IMapper instance as source for the given GraphML attribute.

Parameters:

name - The GraphML name of the attribute

tag - The tag name of the mapper in the IMapperRegistry

addRegistryOutputMapper

public final <TModelItem,TValue> void addRegistryOutputMapper(Class<TModelItem> modelItemType,
                                                              Class<TValue> valueType,
                                                              String name,
                                                              String uri,
                                                              Object tag,
                                                              IEventHandler<HandleSerializationEventArgs> serializationCallback,
                                                              KeyType declaredKeyType)

Use a registered IMapper instance as source for the given GraphML attribute.

Parameters:

name - The GraphML name of the attribute

uri - The URI to add to the key definition to disambiguate keys.

tag - The tag name of the mapper in the IMapperRegistry

serializationCallback - custom serialization callback.

declaredKeyType - The key type to write in the declaration.

addRegistryOutputMapper

public final void addRegistryOutputMapper(String name,
                                          Object tag)

Use a registered IMapper instance as source for the given GraphML attribute.

The type arguments of the mapper are determined automatically.

Parameters:

name - The GraphML name of the attribute

tag - The tag name of the mapper in the IMapperRegistry

addRegistryOutputMapper

public final void addRegistryOutputMapper(String name,
                                          String uri,
                                          Object tag,
                                          IEventHandler<HandleSerializationEventArgs> serializationCallback)

Use a registered IMapper instance as source for the given GraphML attribute.

The type arguments of the mapper are determined automatically.

Parameters:

name - The GraphML name of the attribute

uri - The optional URI of the attribute

tag - The tag name of the mapper in the IMapperRegistry

serializationCallback - An optional serialization handler

addResolveReferenceListener

public final void addResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> resolveReferenceEvent)

Adds the given listener for the ResolveReference event that occurs after references are evaluated.

Subscribe to this event to customize resolving of GraphML object references. This event is fired when the framework could not resolve an object reference by an internal one.

Parameters:

resolveReferenceEvent - The listener to add.

See Also:

addOverrideResolveReferenceListener(IEventHandler), removeResolveReferenceListener(IEventHandler)

addSchemaLocation

public void addSchemaLocation(String schemaNamespace,
                              String schemaLocation)

Adds a schema location to the header of a GraphML file.

Parameters:

schemaNamespace - The namespace URI for this schema location

schemaLocation - The schema location

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), GraphMLWriter.addWritingListener(IEventHandler), 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 been finished.

Parameters:

writtenEvent - The listener to add.

See Also:

onWritten(WriteEventArgs), GraphMLWriter.addWrittenListener(IEventHandler), removeWrittenListener(IEventHandler)

configureDeserializationHandlers

protected void configureDeserializationHandlers(IGraph graph,
                                                GraphMLParser parser)

Configure the predefined handlers for the HandleDeserialization event.

Except for text content and primitive types, this implementation delegates all work to handleXamlDeserialization(Object, HandleDeserializationEventArgs)

This method is called for each parse process.

Parameters:

graph - The graph that will be parsed.

parser - The parser to configure.

See Also:

handlePrimitivesDeserialization(Object, HandleDeserializationEventArgs), handleXamlDeserialization(Object, HandleDeserializationEventArgs), handleTextNodeDeserialization(Object, HandleDeserializationEventArgs)

configureDeserializationPropertyOverrides

protected void configureDeserializationPropertyOverrides(GraphMLParser parser)

Configures the deserialization property overrides for the given parser.

This method is called for each parse process.

Parameters:

parser - The parser to set the deserialization properties.

configureGraphMLParser

protected void configureGraphMLParser(GraphMLParser parser,
                                      IGraph graph)

Configures a given instance of GraphMLParser that can handle the given graph.

This method is called by createGraphMLParser(IGraph).

Parameters:

parser - The parser to configure

graph - The graph that should be filled by the parser

configureGraphMLWriter

protected void configureGraphMLWriter(GraphMLWriter writer,
                                      IGraph graph)

Configures a given GraphMLWriter that is used for writing graph.

This method is called by createGraphMLWriter(IGraph).

Parameters:

writer - The writer to configure

graph - The graph that will be written.

configureInputHandlers

protected void configureInputHandlers(GraphMLParser parser)

Configures default event handlers for the QueryInputHandlers event.

This implementation configures several input handlers for the standard yFiles for JavaFX GraphML attributes (styles, folding state, labels, geometry).

This method is called for each parse process.

Parameters:

parser - The parser that should be configured.

configureLookup

protected void configureLookup(GraphMLParser parser)

Configures the lookup of the given parser.

This method is called for each parse process.

Parameters:

parser - The parser to configure.

configureLookup

protected void configureLookup(IGraph graph,
                               GraphMLWriter writer)

Configure the lookup map of writer.

This method is called for each write process.

Parameters:

graph - The graph that will be written.

writer - The writer to configure.

See Also:

GraphMLWriter.setLookup(Class, Object)

configureNamespaces

protected void configureNamespaces(GraphMLWriter writer)

Configures writer to use the namespace declarations set with addNamespace(String, String).

In addition to the namespace declarations provided with addNamespace(String, String), the default GraphMLWriter implementation also automatically places all namespace declarations that have occurred

This method is called for each write process.

Parameters:

writer - The writer to configure.

configureOutputHandlers

protected void configureOutputHandlers(IGraph graph,
                                       GraphMLWriter writer)

Configures default event handlers for the QueryOutputHandlers event.

This implementation configures several output handlers for the standard yFiles GraphML attributes (styles, folding state, labels, geometry).

This method is called for each write process.

Parameters:

graph - The graph that will be written.

writer - The writer that should be configured.

configureSchemaLocations

protected void configureSchemaLocations(GraphMLWriter writer)

Configures writer to use the schema locations set with addSchemaLocation(String, String).

This method is called for each write process.

Parameters:

writer - The writer to configure.

configureSerializationHandlers

protected void configureSerializationHandlers(IGraph graph,
                                              GraphMLWriter writer)

Configures the predefined handlers for the HandleSerialization event.

This method is called for each write process.

Parameters:

graph - The graph that will be written.

writer - The writer to configure.

configureSerializationProperties

protected void configureSerializationProperties(IGraph graph,
                                                GraphMLWriter writer)

Configure important serialization properties from properties of GraphMLIOHandler.

This method is called for each write process.

Parameters:

graph - The graph to write.

writer - The writer to configure.

See Also:

GraphMLWriter.setSerializationProperty(TypedKey, Object)

configureSerializationPropertyOverrides

protected void configureSerializationPropertyOverrides(GraphMLWriter writer)

Configures the serialization property overrides for the given writer.

This method is called for each write process.

Parameters:

writer - The writer to set the serialization properties.

configureXMLWriter

protected void configureXMLWriter(IXmlWriter writer)

Configure writer.

This method is called for each write process.

This implementation does nothing.

Parameters:

writer - The writer to configure.

createDefaultValueSerializerContext

protected IValueSerializerContext createDefaultValueSerializerContext()

Creates the default value serializer context and returns it.

This factory method can be used to provide custom ValueSerializers in cases where no ValueSerializer can be used.

Returns:

An implementation of the IValueSerializerContext interface.

createGraphElementFactory

protected IGraphElementFactory createGraphElementFactory(GraphMLParser parser,
                                                         IGraph graph)

Create an IGraphElementFactory instance that creates the graph elements for the graph instance.

This method is called for each parse process.

Parameters:

parser - The parser to use.

graph - The graph that is populated.

Returns:

An IGraphElementFactory instance that is configured for the given parameters.

createGraphMLParser

protected GraphMLParser createGraphMLParser(IGraph graph)

Create a suitable instance of GraphMLParser that can handle the given graph.

This method is called for each parse process.

It delegates the configuration of the parser to configureGraphMLParser(GraphMLParser, IGraph).

Parameters:

graph - The graph that should be filled by this instance

Returns:

a suitable instance of GraphMLParser that can handle the given graph

createGraphMLWriter

protected GraphMLWriter createGraphMLWriter(IGraph graph)

Create and configure a new GraphMLWriter that is used for writing graph.

This method is called for each write process. It delegates the configuration of the writer to configureGraphMLWriter(GraphMLWriter, IGraph).

Parameters:

graph - The graph that will be written.

Returns:

A new GraphMLWriter instance that is configured for graph.

createMapper

protected <TKey,TData> IMapper<TKey,TData> createMapper(Class<TKey> keyType,
                                                        Class<TData> dataType,
                                                        IParseContext context,
                                                        Object registryTag)

Callback used by addRegistryInputMapper(Class, Class, String) and its overloads to creates the mapper instance.

This method creates the mapper instance, unless there is an existing mapper in the target graph with a matching type. In this case the existing mapper is returned. In all other cases a new mapper will be created using IMapperRegistry.createWeakMapper(Class, Class, Object) and returned. If a mapper is already registered with the same registryTag but wrong types it will be replaced.

Type Parameters:

TKey - The type of the keys.

TData - The type of the data.

Parameters:

dataType - The type of the data.

keyType - The type of the keys.

registryTag - The tag for the mapper in the registry.

Returns:

The mapper instance to use.

createMapperInputHandler

public static final <TKey,TData> MapperInputHandler<TKey,TData> createMapperInputHandler(Class<TKey> modelItemType,
                                                                                         Class<TData> dataType,
                                                                                         IMapper<TKey,TData> mapper,
                                                                                         IEventHandler<HandleDeserializationEventArgs> deserializationCallback)

Convenience factory method that can create an instance of several predefined IInputHandler implementations that match the provided TKey and TData.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper entries

Parameters:

dataType - The type of the mapper entries

modelItemType - The type of the mapper keys

mapper - The mapper to use.

deserializationCallback - Optional deserialization callback for complex data.

Returns:

A suitable MapperInputHandler implementation

createMapperOutputHandler

public static final <TKey,TData> MapperOutputHandler<TKey,TData> createMapperOutputHandler(Class<TKey> modelItemType,
                                                                                           Class<TData> dataType,
                                                                                           String name,
                                                                                           IMapper<TKey,TData> mapper,
                                                                                           IEventHandler<HandleSerializationEventArgs> serializationCallback)

Convenience factory method that can create an instance of several predefined IOutputHandler implementations that match the provided TKey and TData.

Type Parameters:

TKey - The type of the mapper keys

TData - The type of the mapper entries

Parameters:

dataType - The type of the mapper entries

modelItemType - The type of the mapper keys

name - The name of the graphml attribute

mapper - The mapper to use.

serializationCallback - Optional serialization callback for complex data.

Returns:

A suitable MapperOutputHandler implementation

createXamlNameMapper

protected IXamlNameMapper createXamlNameMapper()

Configure mappings from package to XML names.

This method is called for each read or write process.

createXamlPrefixMapper

protected IXamlPrefixMapper createXamlPrefixMapper()

Configure mappings from XML namespaces to prefixes.

This method is called for each write process.

createXMLWriter

protected IXmlWriter createXMLWriter(OutputStream os,
                                     Charset encoding)

Factory method that creates and configures a suitable IXmlWriter implementation that can write the graph to the given InputStream with the given settings.

This method is called for each write process. The IXmlWriter implementation is used by default for all low-level write operations.

Parameters:

os - The serialization destination

encoding - The encoding of the stream

Returns:

A suitable IXmlWriter instance for the serialization

See Also:

IWriteContext.getWriter()

createXMLWriter

protected IXmlWriter createXMLWriter(Writer os)

Factory method that creates and configures a suitable IXmlWriter implementation that can write the graph to the given Writer with the given settings.

This method is called for each write process. The IXmlWriter implementation is used by default for all low-level write operations.

Parameters:

os - The serialization destination

Returns:

A suitable IXmlWriter instance for the serialization

See Also:

IWriteContext.getWriter()

getDeserializationPropertyOverrides

public final TypedKeyMapper getDeserializationPropertyOverrides()

Gets the mapper for the overrides of the deserialization properties.

Using this mapper deserialization properties can be specified.

Returns:

The DeserializationPropertyOverrides.

See Also:

configureDeserializationPropertyOverrides(GraphMLParser)

getSerializationPropertyOverrides

public final TypedKeyMapper getSerializationPropertyOverrides()

Gets the mapper for the overrides of the serialization properties.

Using this mapper serialization properties can be specified.

Returns:

The SerializationPropertyOverrides.

See Also:

configureSerializationPropertyOverrides(GraphMLWriter)

handleArraySerialization

protected void handleArraySerialization(Object sender,
                                        HandleSerializationEventArgs e)

Handle the serialization of arrays.

This sets Handled to true iff Item is an array. This handler is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleListSerialization

protected void handleListSerialization(Object sender,
                                       HandleSerializationEventArgs e)

Handle the serialization of Iterable instances.

This sets Handled to true iff Item is an Iterable instance. This handler is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleMarkupExtensionBasedSerialization

protected void handleMarkupExtensionBasedSerialization(Object sender,
                                                       HandleSerializationEventArgs e)

Handle the serialization of MarkupExtension convertible instances.

This sets Handled to true iff Item can be converted to a MarkupExtension instance. This handler is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleNullSerialization

protected void handleNullSerialization(Object sender,
                                       HandleSerializationEventArgs e)

Handle the serialization of null references.

This sets Handled to true iff Item is a null reference. This handler is registered by default and is only used to write null references in XML element syntax.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handlePrimitivesDeserialization

protected void handlePrimitivesDeserialization(Object sender,
                                               HandleDeserializationEventArgs e)

Handle the serialization of primitive types, enums and strings.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleReferenceHandleSerialization

protected void handleReferenceHandleSerialization(Object sender,
                                                  HandleSerializationEventArgs e)

Handle the serialization of IReferenceHandle instances.

This sets Handled to true iff Item is a IReferenceHandle instance. This handler is registered by default and should not be removed if WritingSharedReferencesEnabled is enabled.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleTextConvertibleSerialization

protected void handleTextConvertibleSerialization(Object sender,
                                                  HandleSerializationEventArgs e)

Handle the serialization of instances that can be serialized through a ValueSerializer.

This sets Handled to true iff Item can be converted to a string with a ValueSerializer. This serializer is only called from element property syntax and is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleTextNodeDeserialization

protected void handleTextNodeDeserialization(Object source,
                                             HandleDeserializationEventArgs args)

Callback for the HandleDeserialization event.

Parameters:

source - The source of the event.

args - The event arguments.

See Also:

HandleDeserializationEventArgs

handleTypeExtensionSerialization

protected void handleTypeExtensionSerialization(Object sender,
                                                HandleSerializationEventArgs e)

Handle the serialization of TypeExtensions.

This sets Handled to true iff Item is an array. This handler is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleTypeSerialization

protected void handleTypeSerialization(Object sender,
                                       HandleSerializationEventArgs e)

Handle the serialization of Types.

This sets Handled to true iff Item is an array. This handler is registered by default.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

handleXamlDeserialization

protected void handleXamlDeserialization(Object source,
                                         HandleDeserializationEventArgs args)

Callback for the HandleDeserialization event.

Parameters:

source - The source of the event.

args - The event arguments.

See Also:

HandleDeserializationEventArgs

handleXamlSerialization

protected void handleXamlSerialization(Object sender,
                                       HandleSerializationEventArgs e)

Handle the serialization of complex objects that are not handled by other callbacks.

This sets Handled to true iff Item is not a null reference. This handler is registered by default and uses XamlSerializer to create XAML output.

Parameters:

sender - The origin of the event.

e - The event handler arguments.

isClearingGraphBeforeReadEnabled

public final boolean isClearingGraphBeforeReadEnabled()

Whether to clear an existing graph instance before reading.

If set totrue, an existing graph instance will be cleared before the graph is read into this instance, otherwise the loaded graph will be merged into the existing one.

Returns:

Default value is true

See Also:

setClearingGraphBeforeReadEnabled(boolean)

isWritingSharedReferencesEnabled

public final boolean isWritingSharedReferencesEnabled()

Whether to support object sharing on output.

If enabled, multiple object references will be correctly represented in the output document, otherwise, each object reference will be serialized independently.

Note: Reading of shared references is always supported

Returns:

Default value is true

See Also:

setWritingSharedReferencesEnabled(boolean)

isWritingXMLSchemaEnabled

public final boolean isWritingXMLSchemaEnabled()

true if schema descriptions should be written.

Returns:

Default is true

See Also:

setWritingXMLSchemaEnabled(boolean)

matchesName

public static final boolean matchesName(Element definition,
                                        String name)

Checks whether the name attribute in definition matches name.

Parameters:

definition - The key definition to check

name - The name that should be matched

Returns:

true if the name attribute in definition matches name

matchesScope

public static final boolean matchesScope(Element definition,
                                         KeyScope scope)

Checks whether the scope attribute in definition matches scope.

Parameters:

definition - The key definition to check

scope - The scope that should be matched

Returns:

true if the scope attribute in definition matches scope

matchesType

public static final boolean matchesType(Element definition,
                                        KeyType type)

Checks whether the type attribute in definition matches type.

Parameters:

definition - The key definition to check

type - The type that should be matched

Returns:

true if the type attribute in definition matches type

matchesUri

public static final boolean matchesUri(Element definition,
                                       String uri)

Checks whether the uri attribute in definition matches uri.

Parameters:

definition - The key definition to check

uri - The uri that should be matched

Returns:

true if the uri attribute in definition matches uri

onGraphMLParserHandleDeserialization

protected void onGraphMLParserHandleDeserialization(Object sender,
                                                    HandleDeserializationEventArgs e)

Event handler for the HandleDeserialization event.

This event handler is used to propagate the HandleDeserialization event to subscribers of HandleDeserialization. This implementation just calls onHandleDeserialization(HandleDeserializationEventArgs), which in turn raises the HandleDeserialization event.

onGraphMLParserQueryInputHandlers

protected void onGraphMLParserQueryInputHandlers(Object sender,
                                                 QueryInputHandlersEventArgs e)

Event handler for the QueryInputHandlers event.

This event handler is used to propagate the QueryInputHandlers event to subscribers of QueryInputHandlers. This implementation just calls onQueryInputHandlers(QueryInputHandlersEventArgs), which in turn raises the QueryInputHandlers event.

onGraphMLWriterHandleSerialization

protected void onGraphMLWriterHandleSerialization(Object sender,
                                                  HandleSerializationEventArgs e)

Event handler for the HandleSerialization event.

This event handler is used to propagate the HandleSerialization event to subscribers of HandleSerialization. This implementation just calls onHandleSerialization(HandleSerializationEventArgs), which in turn raises the HandleSerialization event.

onGraphMLWriterQueryOutputHandlers

protected void onGraphMLWriterQueryOutputHandlers(Object sender,
                                                  QueryOutputHandlersEventArgs e)

Event handler for the QueryOutputHandlers event.

This event handler is used to propagate the QueryOutputHandlers event to subscribers of QueryOutputHandlers. This implementation just calls onQueryOutputHandlers(QueryOutputHandlersEventArgs), which in turn raises the QueryOutputHandlers event.

onHandleDeserialization

protected void onHandleDeserialization(HandleDeserializationEventArgs args)

Raises the HandleDeserialization event.

Parameters:

args - The arguments for the HandleDeserialization event.

onHandleSerialization

protected void onHandleSerialization(HandleSerializationEventArgs args)

Raises the HandleSerialization event.

Parameters:

args - The arguments for the HandleSerialization event.

onOverrideResolveReference

protected void onOverrideResolveReference(ResolveReferenceEventArgs args)

Fires the OverrideResolveReference event.

Parameters:

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

onParsed

protected void onParsed(ParseEventArgs args)

Raises the Parsed event.

This method is called when the document has been parsed and after DocumentParsed is called.

Parameters:

args - The ParseEventArgs instance containing the event data.

See Also:

addParsedListener(IEventHandler)

onParsing

protected void onParsing(ParseEventArgs args)

Raises the Parsing event.

This method is called just before the parsing starts and before DocumentParsing is called.

Parameters:

args - The ParseEventArgs instance containing the event data.

See Also:

addParsingListener(IEventHandler)

onQueryInputHandlers

protected void onQueryInputHandlers(QueryInputHandlersEventArgs args)

Raises the QueryInputHandlers event.

Parameters:

args - The arguments for the QueryInputHandlers event.

onQueryOutputHandlers

protected void onQueryOutputHandlers(QueryOutputHandlersEventArgs args)

Raises the QueryOutputHandlers event.

Parameters:

args - The arguments for the QueryOutputHandlers event.

onQueryReferenceId

protected void onQueryReferenceId(QueryReferenceIdEventArgs args)

Fires the QueryReferenceId event.

Throws:

NullPointerException - args is null.

Parameters:

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

See Also:

GraphMLWriter.onQueryReferenceId(QueryReferenceIdEventArgs)

onResolveReference

protected void onResolveReference(ResolveReferenceEventArgs args)

Fires the ResolveReference event.

Parameters:

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

onWriting

protected void onWriting(WriteEventArgs args)

Raises the Writing event.

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

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 after the writing finishes and after DocumentWritten is called.

Parameters:

args - The WriteEventArgs instance containing the event data.

See Also:

addWrittenListener(IEventHandler)

read

public void read(IGraph graph,
                 Document document)
          throws IOException

Read GraphML from an existing XML document.

Throws:

NullPointerException - doc is null.

NullPointerException - graph is null.

IOException

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from the document.

document - The XML document.

read

public void read(IGraph graph,
                 InputStream stream)
          throws IOException

Reads GraphML content from the given input stream and populates the Graph object.

Note this method only supports GraphML with absolute paths. For importing GraphML with relative paths, use read(com.yworks.yfiles.graph.IGraph, java.io.InputStream, java.net.URI) instead.

Throws:

NullPointerException - stream is null.

NullPointerException - graph is null.

IOException - If the graph could not be read.

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from the stream.

stream - The input stream that holds the GraphML file to be read.

read

public void read(IGraph graph,
                 InputStream stream,
                 URI baseUri)
          throws IOException

Reads GraphML content from the given input stream and populates the Graph object.

Throws:

NullPointerException - stream is null.

NullPointerException - graph is null.

IOException - If the graph could not be read.

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from the stream.

stream - The input stream that holds the GraphML file to be read.

baseUri - The base URI which is used for the GraphML file being parsed to resolve relative paths.

read

public void read(IGraph graph,
                 Reader reader)
          throws IOException

Reads GraphML content from the given reader and populates the Graph object.

Note this method only supports GraphML with absolute paths. For importing GraphML with relative paths, use read(com.yworks.yfiles.graph.IGraph, java.io.Reader, java.net.URI) instead.

Throws:

NullPointerException - reader is null.

NullPointerException - graph is null.

IOException - If the graph could not be read.

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from reader.

reader - The input stream that holds the GraphML file to be read.

read

public void read(IGraph graph,
                 Reader reader,
                 URI baseUri)
          throws IOException

Reads GraphML content from the given reader and populates the Graph object.

Throws:

NullPointerException - reader is null.

NullPointerException - graph is null.

IOException - If the graph could not be read.

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from reader.

reader - The input stream that holds the GraphML file to be read.

baseUri - The base URI which is used for the GraphML file being parsed to resolve relative paths.

read

public void read(IGraph graph,
                 String filename)
          throws IOException

Reads a GraphML file from the given GraphML file and populates the IGraph object.

Throws:

NullPointerException - filename is null.

NullPointerException - graph is null.

IOException - If the graph could not be read.

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from the GraphML file.

filename - The name of the file to be read.

read

public void read(IGraph graph,
                 URL url)
          throws IOException

Reads a GraphML file from the given url inside the applications xap file and populates the Graph object.

Throws:

NullPointerException - graph is null.

IOException - If the graph could not be read.

URISyntaxException - if the url is not formatted to be convertible into uri

Parameters:

graph - The Graph object that is to be populated with nodes and edges as read from the GraphML file.

url - The url of the file to be read from the applications xap.

registerEdgeBendsInputHandler

protected void registerEdgeBendsInputHandler(Object sender,
                                             QueryInputHandlersEventArgs e)

Predefined input handler that reads edge bends.

This handler is by default registered for the QueryInputHandlers event

registerEdgeBendsOutputHandler

protected void registerEdgeBendsOutputHandler(Object sender,
                                              QueryOutputHandlersEventArgs e)

Predefined output handler that writes edge bends.

This handler is by default registered for the QueryOutputHandlers event

registerEdgeLabelsInputHandler

protected void registerEdgeLabelsInputHandler(Object sender,
                                              QueryInputHandlersEventArgs e)

Predefined input handler that reads edge labels.

This handler is by default registered for the QueryInputHandlers event

registerEdgeLabelsOutputHandler

protected void registerEdgeLabelsOutputHandler(Object sender,
                                               QueryOutputHandlersEventArgs e)

Predefined output handler that writes edge labels.

This handler is by default registered for the QueryOutputHandlers event

registerEdgeStyleInputHandler

protected void registerEdgeStyleInputHandler(Object sender,
                                             QueryInputHandlersEventArgs e)

Predefined input handler that reads edge styles.

This handler is by default registered for the QueryInputHandlers event

registerEdgeStyleOutputHandler

protected void registerEdgeStyleOutputHandler(Object sender,
                                              QueryOutputHandlersEventArgs e)

Predefined output handler that writes edge styles.

This handler is by default registered for the QueryOutputHandlers event

registerGraphSettingsInputHandler

protected void registerGraphSettingsInputHandler(Object sender,
                                                 QueryInputHandlersEventArgs e)

Predefined input handler that reads IGraph graph default settings.

This handler is by default registered for the QueryInputHandlers event

registerGraphSettingsOutputHandler

protected void registerGraphSettingsOutputHandler(Object sender,
                                                  QueryOutputHandlersEventArgs e)

Predefined output handler that writes the settings of a graph.

This handler is by default registered for the QueryOutputHandlers event.

See Also:

SerializationProperties.DISABLE_GRAPH_SETTINGS

registerNodeLabelsInputHandler

protected void registerNodeLabelsInputHandler(Object sender,
                                              QueryInputHandlersEventArgs e)

Predefined input handler that reads node labels.

This handler is by default registered for the QueryInputHandlers event

registerNodeLabelsOutputHandler

protected void registerNodeLabelsOutputHandler(Object sender,
                                               QueryOutputHandlersEventArgs e)

Predefined output handler that writes node labels.

This handler is by default registered for the QueryOutputHandlers event

registerNodeLayoutInputHandler

protected void registerNodeLayoutInputHandler(Object sender,
                                              QueryInputHandlersEventArgs e)

Predefined input handler that reads node layouts.

This handler is by default registered for the QueryInputHandlers event

registerNodeLayoutOutputHandler

protected void registerNodeLayoutOutputHandler(Object sender,
                                               QueryOutputHandlersEventArgs e)

Predefined output handler that writes node layouts.

This handler is by default registered for the QueryOutputHandlers event

registerNodeStyleInputHandler

protected void registerNodeStyleInputHandler(Object sender,
                                             QueryInputHandlersEventArgs e)

Predefined input handler that reads node styles.

This handler is by default registered for the QueryInputHandlers event

registerNodeStyleOutputHandler

protected void registerNodeStyleOutputHandler(Object sender,
                                              QueryOutputHandlersEventArgs e)

Predefined output handler that writes node styles.

This handler is by default registered for the QueryOutputHandlers event

registerPortLocationInputHandler

protected void registerPortLocationInputHandler(Object sender,
                                                QueryInputHandlersEventArgs e)

Predefined input handler that reads port locations.

This handler is by default registered for the QueryInputHandlers event

registerPortLocationOutputHandler

protected void registerPortLocationOutputHandler(Object sender,
                                                 QueryOutputHandlersEventArgs e)

Predefined output handler that writes port locations.

This handler is by default registered for the QueryOutputHandlers event

registerPortStyleInputHandler

protected void registerPortStyleInputHandler(Object sender,
                                             QueryInputHandlersEventArgs e)

Predefined input handler that reads port styles.

This handler is by default registered for the QueryInputHandlers event

registerPortStyleOutputHandler

protected void registerPortStyleOutputHandler(Object sender,
                                              QueryOutputHandlersEventArgs e)

Predefined output handler that writes port styles.

This handler is by default registered for the QueryOutputHandlers event

registerTagInputHandler

protected void registerTagInputHandler(Object sender,
                                       QueryInputHandlersEventArgs e)

Predefined input handler that reads ITagOwner tags.

This handler is by default registered for the QueryInputHandlers event

registerTagOutputHandler

protected void registerTagOutputHandler(Object sender,
                                        QueryOutputHandlersEventArgs e)

Predefined output handler that writes ITagOwner tags.

This handler is by default registered for the QueryOutputHandlers event

removeHandleDeserializationListener

public final void removeHandleDeserializationListener(IEventHandler<HandleDeserializationEventArgs> handleDeserializationEvent)

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

Subscribe to this event to provide custom deserialization 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 XML content is provided by XmlNode. If you want to return deserialized content, set the value of the Result property.

Parameters:

handleDeserializationEvent - The listener to remove.

See Also:

GraphMLParser.addHandleDeserializationListener(IEventHandler), addHandleDeserializationListener(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:

addHandleSerializationListener(IEventHandler)

removeOverrideResolveReferenceListener

public final void removeOverrideResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> overrideResolveReferenceEvent)

Removes the given listener for the OverrideResolveReference event that occurs before inline references are evaluated.

Subscribe to this event to customize resolving of GraphML object references. This event is fired before the framework tries to resolve internal references and can therefore be used to override internal references, for example.

Parameters:

overrideResolveReferenceEvent - The listener to remove.

See Also:

addResolveReferenceListener(IEventHandler), addOverrideResolveReferenceListener(IEventHandler)

removeParsedListener

public final void removeParsedListener(IEventHandler<ParseEventArgs> parsedEvent)

Removes the given listener for the Parsed event that occurs when the the document has been parsed.

Parameters:

parsedEvent - The listener to remove.

See Also:

onParsed(ParseEventArgs), GraphMLParser.addParsedListener(IEventHandler), addParsedListener(IEventHandler)

removeParsingListener

public final void removeParsingListener(IEventHandler<ParseEventArgs> parsingEvent)

Removes the given listener for the Parsing event that occurs when the parsing 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 ParseEvents and to configure the parsing process on a per parse case.

Parameters:

parsingEvent - The listener to remove.

See Also:

onParsing(ParseEventArgs), GraphMLParser.addParsingListener(IEventHandler), addParsingListener(IEventHandler)

removeQueryInputHandlersListener

public final void removeQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent)

Removes the given listener for the QueryInputHandlers event that occurs when a GraphML attribute is about to be read.

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

The current key definition is provided by KeyDefinition. If you want to register an IInputHandler for this GraphML attribute, you can add the handler with QueryInputHandlersEventArgs.addInputHandler(IInputHandler) method. Implementations should also consider the Handled property.

Parameters:

queryInputHandlersEvent - The listener to remove.

See Also:

GraphMLParser.addQueryInputHandlersListener(IEventHandler), addQueryInputHandlersListener(IEventHandler)

removeQueryOutputHandlersListener

public final void removeQueryOutputHandlersListener(IEventHandler<QueryOutputHandlersEventArgs> queryOutputHandlersEvent)

Removes the given listener for the QueryOutputHandlers event that occurs when a GraphML attribute is about to be written.

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:

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 or internal references for objects.

The reference targets are not serialized to the GraphML file if they are set to GraphMLReferenceType.EXTERNAL. To resolve these references when parsing, you typically have to subscribe to the ResolveReference event.

Parameters:

queryReferenceIdEvent - The listener to remove.

See Also:

QueryReferenceIdEventArgs.getReferenceId(), QueryReferenceIdEventArgs.getReferenceType(), addQueryReferenceIdListener(IEventHandler)

removeResolveReferenceListener

public final void removeResolveReferenceListener(IEventHandler<ResolveReferenceEventArgs> resolveReferenceEvent)

Removes the given listener for the ResolveReference event that occurs after references are evaluated.

Subscribe to this event to customize resolving of GraphML object references. This event is fired when the framework could not resolve an object reference by an internal one.

Parameters:

resolveReferenceEvent - The listener to remove.

See Also:

addOverrideResolveReferenceListener(IEventHandler), addResolveReferenceListener(IEventHandler)

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), GraphMLWriter.addWritingListener(IEventHandler), 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 been finished.

Parameters:

writtenEvent - The listener to remove.

See Also:

onWritten(WriteEventArgs), GraphMLWriter.addWrittenListener(IEventHandler), addWrittenListener(IEventHandler)

setClearingGraphBeforeReadEnabled

public final void setClearingGraphBeforeReadEnabled(boolean value)

Whether to clear an existing graph instance before reading.

If set totrue, an existing graph instance will be cleared before the graph is read into this instance, otherwise the loaded graph will be merged into the existing one.

Parameters:

value - Default value is true

See Also:

isClearingGraphBeforeReadEnabled()

setWritingSharedReferencesEnabled

public final void setWritingSharedReferencesEnabled(boolean value)

Whether to support object sharing on output.

If enabled, multiple object references will be correctly represented in the output document, otherwise, each object reference will be serialized independently.

Note: Reading of shared references is always supported

Parameters:

value - Default value is true

See Also:

isWritingSharedReferencesEnabled()

setWritingXMLSchemaEnabled

public final void setWritingXMLSchemaEnabled(boolean value)

true if schema descriptions should be written.

Parameters:

value - Default is true

See Also:

isWritingXMLSchemaEnabled()

write

public final void write(IGraph graph,
                        OutputStream os)
                 throws IOException

Writes the given graph object to the output stream creating a GraphML file.

Throws:

NullPointerException - graph is null.

NullPointerException - os is null.

IOException

Parameters:

graph - The Graph object that is to be written to a GraphML file.

os - The output stream where the output is written.

write

public void write(IGraph graph,
                  OutputStream os,
                  Charset encoding)
           throws IOException

Writes the given graph object to the output stream creating a GraphML file.

Throws:

NullPointerException - graph is null.

NullPointerException - os is null.

IOException

Parameters:

graph - The Graph object that is to be written to a GraphML file.

os - The output stream where the output is written.

encoding - The encoding that should be used for writing

write

public void write(IGraph graph,
                  String filename)
           throws IOException

Writes the given graph object to a GraphML file with a given filename.

Throws:

NullPointerException - graph is null.

IllegalArgumentException - Need a non-empty filename

IOException

Parameters:

graph - The Graph object that is to be written to a GraphML file.

filename - The filename where the output is written.

write

public void write(IGraph graph,
                  Writer os)
           throws IOException

Writes the given graph object to the output writer creating a GraphML file.

Throws:

NullPointerException - graph is null.

NullPointerException - os is null.

IOException

Parameters:

graph - The Graph object that is to be written to a GraphML file.

os - The text writer where the output is written.