org.graphstream.stream.file

Class FileSourceXML.Parser

java.lang.Object

org.graphstream.stream.file.FileSourceXML.Parser

Direct Known Subclasses:

FileSourceGEXF.GEXFParser, FileSourceGPX.GPXParser

Enclosing class:

FileSourceXML

protected class FileSourceXML.Parser
extends java.lang.Object

Base for parsers, providing some usefull features.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSourceXML.Parser()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	__characters() Read a sequence of characters and return these characters as a string.
protected <T extends java.lang.Enum<T>> void	checkRequiredAttributes(javax.xml.stream.events.XMLEvent e, java.util.EnumMap<T,java.lang.String> attributes, T... required) Check if all required attributes are present.
protected <T extends java.lang.Enum<T>> java.util.EnumMap<T,java.lang.String>	getAttributes(java.lang.Class<T> cls, javax.xml.stream.events.StartElement e) Get attributes of a start element in a map.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSourceXML.Parser

protected FileSourceXML.Parser()

Method Detail

__characters

protected java.lang.String __characters()
                                 throws java.io.IOException,
                                        javax.xml.stream.XMLStreamException

Read a sequence of characters and return these characters as a string. Characters are read until a non-character event is reached.

Returns:

a sequence of characters

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

getAttributes

protected <T extends java.lang.Enum<T>> java.util.EnumMap<T,java.lang.String> getAttributes(java.lang.Class<T> cls,
                                                                                javax.xml.stream.events.StartElement e)

Get attributes of a start element in a map. Attributes should be described in an enumeration such that FileSourceXML.toConstantName(Attribute) correspond to names of enumeration constants.

Type Parameters:

T - type of the enumeration describing attributes

Parameters:

cls - class of the enumeration T

e - start event from which attributes have to be extracted

Returns:

a mapping between enum constants and attribute values.

checkRequiredAttributes

protected <T extends java.lang.Enum<T>> void checkRequiredAttributes(javax.xml.stream.events.XMLEvent e,
                                                         java.util.EnumMap<T,java.lang.String> attributes,
                                                         T... required)
                                throws javax.xml.stream.XMLStreamException

Check if all required attributes are present.

Type Parameters:

T - type of the enumeration describing attributes

Parameters:

e - the event

attributes - extracted attributes

required - array of required attributes

Throws:

javax.xml.stream.XMLStreamException - if at least one required attribute is not found