com.yworks.yfiles.graphml

Class GraphMLParser

java.lang.Object

com.yworks.yfiles.graphml.GraphMLParser

public class GraphMLParser
extends Object

Core parser class for GraphML.

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

See Also:

GraphMLIOHandler

Constructor Summary

Constructors

Constructor and Description
GraphMLParser()

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	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 the document is just about to begin.
void	addQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent) Adds the given listener for the QueryInputHandlers event that occurs when IInputHandlers are queried.
protected IParseContext	createParseContext(IGraph graph) Create the initial IParseContext instance.
<T> T	deserialize(Class<T> targetType, IParseContext context, Node element) Deserialize the content of element.
<T> T	getDeserializationProperty(TypedKey<T> key) Retrieve a deserialization property that has been set by setDeserializationProperty(TypedKey, Object).
List<IInputHandler>	getInputHandlers(IParseContext context, Element keyDefinition) Dynamically retrieve all IInputHandler instances that process a GraphML attribute with key definition keyDefinition.
Object	lookup(Class type) Dynamically retrieve an instance of type.
protected void	onHandleDeserialization(HandleDeserializationEventArgs args) Fires the HandleDeserialization event.
protected void	onParsed(ParseEventArgs args) Raises the Parsed event.
protected void	onParsing(ParseEventArgs args) Raises the Parsing event.
protected void	onQueryInputHandlers(QueryInputHandlersEventArgs args) Fires the QueryInputHandlers event.
void	parse(IGraph graph, Document document, IGraphElementFactory elementFactory) Parse the XML document document into an graph instance, using elementFactory to create the elements.
void	parse(IGraph graph, InputStream stream, IGraphElementFactory elementFactory) Parse the input stream into an graph instance, using elementFactory to create the elements.
void	parse(IGraph graph, InputStream stream, URI baseUri, IGraphElementFactory elementFactory) Parse the input stream into an graph instance, using elementFactory to create the elements.
void	parse(IGraph graph, Reader reader, IGraphElementFactory elementFactory) Parse the input reader into an graph instance, using elementFactory to create the elements.
void	parse(IGraph graph, Reader reader, URI baseUri, IGraphElementFactory elementFactory) Parse the input reader into an graph instance, using elementFactory to create the elements.
void	parse(IGraph graph, String uri, IGraphElementFactory elementFactory) Parse the input uri into an graph instance, using elementFactory to create the elements.
<T> void	removeDeserializationProperty(TypedKey<T> key) Remove a deserialization property that has been set by setDeserializationProperty(TypedKey, Object).
void	removeHandleDeserializationListener(IEventHandler<HandleDeserializationEventArgs> handleDeserializationEvent) Removes the given listener for the HandleDeserialization event that occurs when XML content is about to be deserialized.
<T> void	removeLookup(Class<T> tType) Remove an implementation of T that has been set with setLookup(Class, Object).
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 the document is just about to begin.
void	removeQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent) Removes the given listener for the QueryInputHandlers event that occurs when IInputHandlers are queried.
<T> void	setDeserializationProperty(TypedKey<T> key, T value) Set a deserialization property that allows to fine tune the parsing process.
<T> void	setLookup(Class<T> tType, T instance) Register an implementation of T for use with lookup(Class).

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLParser

public GraphMLParser()

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:

GraphMLIOHandler.addHandleDeserializationListener(IEventHandler), removeHandleDeserializationListener(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), removeParsedListener(IEventHandler)

addParsingListener

public final void addParsingListener(IEventHandler<ParseEventArgs> parsingEvent)

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

Parameters:

parsingEvent - The listener to add.

See Also:

onParsing(ParseEventArgs), removeParsingListener(IEventHandler)

addQueryInputHandlersListener

public final void addQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent)

Adds the given listener for the QueryInputHandlers event that occurs when IInputHandlers are queried.

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).

Parameters:

queryInputHandlersEvent - The listener to add.

See Also:

GraphMLIOHandler.addQueryInputHandlersListener(IEventHandler), removeQueryInputHandlersListener(IEventHandler)

createParseContext

protected IParseContext createParseContext(IGraph graph)

Create the initial IParseContext instance.

Parameters:

graph - The graph that is parsed.

Returns:

An IParseContext instance that is suitable for graph.

deserialize

public <T> T deserialize(Class<T> targetType,
                         IParseContext context,
                         Node element)

Deserialize the content of element.

Typically, this method is called only indirectly by calls to IParseContext.deserialize(Class, IParseContext, Node) or IParseContext.deserialize(Class, Node). This implementation calls onHandleDeserialization(HandleDeserializationEventArgs), which in turn raises the HandleDeserialization event.

Type Parameters:

T - The desired type of the result.

Parameters:

targetType - The desired type of the result.

context - The current parse context.

element - The XML content that should be deserialized.

Returns:

An instance of T that is represented by element.

See Also:

IParseContext.deserialize(Class, IParseContext, Node), IParseContext.deserialize(Class, Node), addHandleDeserializationListener(IEventHandler)

getDeserializationProperty

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

Retrieve a deserialization property that has been set by setDeserializationProperty(TypedKey, Object).

The return value is automatically converted to type T.

Type Parameters:

T - The target type of the property.

Parameters:

tType - The target type of the property.

key - The key for the property.

See Also:

IParseContext.getDeserializationProperty(TypedKey)

getInputHandlers

public List<IInputHandler> getInputHandlers(IParseContext context,
                                            Element keyDefinition)

Dynamically retrieve all IInputHandler instances that process a GraphML attribute with key definition keyDefinition.

Typically, this method is called only indirectly by the parse process. This implementation calls onQueryInputHandlers(QueryInputHandlersEventArgs), which in turn raises the QueryInputHandlers event.

Parameters:

context - The current parse context.

keyDefinition - The key definition element of the GraphML attribute.

Returns:

A list of IInputHandlers that claim to be responsible for handling the given GraphML attribute.

lookup

public 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.

onHandleDeserialization

protected void onHandleDeserialization(HandleDeserializationEventArgs args)

Fires the HandleDeserialization event.

Parameters:

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

See Also:

GraphMLIOHandler.onHandleDeserialization(HandleDeserializationEventArgs)

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)

Fires the QueryInputHandlers event.

Parameters:

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

See Also:

GraphMLIOHandler.onQueryInputHandlers(QueryInputHandlersEventArgs)

parse

public void parse(IGraph graph,
                  Document document,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the XML document document into an graph instance, using elementFactory to create the elements.

Typically, this method is called indirectly from GraphMLIOHandler.read(IGraph, Document).

Throws:

IOException

Parameters:

graph - The graph instance that is populated.

document - The XML document instance to parse.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(IGraph, Document)

parse

public void parse(IGraph graph,
                  InputStream stream,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the input stream into an graph instance, using elementFactory to create the elements.

Typically, this method is called indirectly from GraphMLIOHandler.read(IGraph, InputStream).

Throws:

IOException - If the XML could not be read.

Parameters:

graph - The graph instance that is populated.

stream - The input stream to parse.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.InputStream, java.net.URI)

parse

public void parse(IGraph graph,
                  InputStream stream,
                  URI baseUri,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the input stream into an graph instance, using elementFactory to create the elements. Typically, this method is called indirectly from GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.InputStream, java.net.URI).

Throws:

IOException - If the XML could not be read.

Parameters:

stream - The input stream to parse.

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

graph - The graph instance that is populated.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.InputStream, java.net.URI)

parse

public void parse(IGraph graph,
                  Reader reader,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the input reader into an graph instance, using elementFactory to create the elements.

Typically, this method is called indirectly from GraphMLIOHandler.read(IGraph, Reader).

Throws:

IOException - If the XML could not be read.

Parameters:

graph - The graph instance that is populated.

reader - The input reader to parse.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.Reader, java.net.URI)

parse

public void parse(IGraph graph,
                  Reader reader,
                  URI baseUri,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the input reader into an graph instance, using elementFactory to create the elements. Typically, this method is called indirectly from GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.Reader, java.net.URI).

Throws:

IOException - If the XML could not be read.

Parameters:

reader - The input reader to parse.

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

graph - The graph instance that is populated.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(com.yworks.yfiles.graph.IGraph, java.io.Reader, java.net.URI)

parse

public void parse(IGraph graph,
                  String uri,
                  IGraphElementFactory elementFactory)
           throws IOException

Parse the input uri into an graph instance, using elementFactory to create the elements.

Typically, this method is called indirectly from GraphMLIOHandler.read(IGraph, Reader, java.net.URI).

Throws:

IOException - If the XML could not be read.

Parameters:

graph - The graph instance that is populated.

uri - The URI to the input to parse.

elementFactory - The IGraphElementFactory instance that is used to create the elements.

See Also:

GraphMLIOHandler.read(IGraph, Reader, java.net.URI)

removeDeserializationProperty

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

Remove a deserialization property that has been set by setDeserializationProperty(TypedKey, Object).

Parameters:

key - The key for the property.

See Also:

IParseContext.getDeserializationProperty(TypedKey)

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:

GraphMLIOHandler.addHandleDeserializationListener(IEventHandler), addHandleDeserializationListener(IEventHandler)

removeLookup

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

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

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), addParsedListener(IEventHandler)

removeParsingListener

public final void removeParsingListener(IEventHandler<ParseEventArgs> parsingEvent)

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

Parameters:

parsingEvent - The listener to remove.

See Also:

onParsing(ParseEventArgs), addParsingListener(IEventHandler)

removeQueryInputHandlersListener

public final void removeQueryInputHandlersListener(IEventHandler<QueryInputHandlersEventArgs> queryInputHandlersEvent)

Removes the given listener for the QueryInputHandlers event that occurs when IInputHandlers are queried.

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).

Parameters:

queryInputHandlersEvent - The listener to remove.

See Also:

GraphMLIOHandler.addQueryInputHandlersListener(IEventHandler), addQueryInputHandlersListener(IEventHandler)

setDeserializationProperty

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

Set a deserialization property that allows to fine tune the parsing process.

Parameters:

key - The key for the property.

value - The property value.

See Also:

IParseContext.getDeserializationProperty(TypedKey)

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.