org.graphstream.stream.file

Class FileSourceXML

java.lang.Object

org.graphstream.stream.SourceBase

org.graphstream.stream.file.FileSourceXML

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, FileSource, Source

Direct Known Subclasses:

FileSourceGEXF, FileSourceGPX, FileSourceGraphML

public abstract class FileSourceXML
extends SourceBase
implements FileSource, javax.xml.stream.XMLStreamConstants

Base for XML-based file format. It uses an xml events stream ( javax.xml.stream). One who want to define a new xml-based fiel source has to define actions after the document start and before the document end. The nextEvents(), called between start and end, has to be defined too.

Author:

Guilhelm Savin

Nested Class Summary

Nested classes/interfaces inherited from class org.graphstream.stream.SourceBase

SourceBase.ElementType

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Method Summary

Modifier and Type	Method and Description
void	begin(java.io.InputStream stream) Begin reading the file stopping as soon as possible.
void	begin(java.io.Reader reader) Begin reading the file stopping as soon as possible.
void	begin(java.lang.String fileName) Begin reading the file stopping as soon as possible.
void	begin(java.net.URL url) Begin reading the file stopping as soon as possible.
void	end() Finish the reading process (even if FileSource.nextEvents() or FileSource.nextStep() did not returned false).
boolean	isStrictMode() If strict mode is enabled, will produce errors while encountering unexpected attributes or elements.
abstract boolean	nextEvents() Try to process one graph event, or as few as possible, if more must be read at once.
boolean	nextStep() Try to process all the events occurring during one time step.
void	readAll(java.io.InputStream stream) Read the whole file in one big non-interruptible operation.
void	readAll(java.io.Reader reader) Read the whole file in one big non-interruptible operation.
void	readAll(java.lang.String fileName) Read the whole file in one big non-interruptible operation.
void	readAll(java.net.URL url) Read the whole file in one big non-interruptible operation.
void	setStrictMode(boolean strictMode)

Methods inherited from class org.graphstream.stream.SourceBase

addAttributeSink, addElementSink, addSink, attributeSinks, clearAttributeSinks, clearElementSinks, clearSinks, elementSinks, removeAttributeSink, removeElementSink, removeSink, sendAttributeChangedEvent, sendAttributeChangedEvent, sendEdgeAdded, sendEdgeAdded, sendEdgeAttributeAdded, sendEdgeAttributeAdded, sendEdgeAttributeChanged, sendEdgeAttributeChanged, sendEdgeAttributeRemoved, sendEdgeAttributeRemoved, sendEdgeRemoved, sendEdgeRemoved, sendGraphAttributeAdded, sendGraphAttributeAdded, sendGraphAttributeChanged, sendGraphAttributeChanged, sendGraphAttributeRemoved, sendGraphAttributeRemoved, sendGraphCleared, sendGraphCleared, sendNodeAdded, sendNodeAdded, sendNodeAttributeAdded, sendNodeAttributeAdded, sendNodeAttributeChanged, sendNodeAttributeChanged, sendNodeAttributeRemoved, sendNodeAttributeRemoved, sendNodeRemoved, sendNodeRemoved, sendStepBegins, sendStepBegins

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graphstream.stream.Source

addAttributeSink, addElementSink, addSink, clearAttributeSinks, clearElementSinks, clearSinks, removeAttributeSink, removeElementSink, removeSink

Method Detail

isStrictMode

public boolean isStrictMode()

If strict mode is enabled, will produce errors while encountering unexpected attributes or elements. This is enabled by default.

Returns:

true if strict mode is enabled

setStrictMode

public void setStrictMode(boolean strictMode)

readAll

public void readAll(java.lang.String fileName)
             throws java.io.IOException

Description copied from interface: FileSource

Read the whole file in one big non-interruptible operation.

Specified by:

readAll in interface FileSource

Parameters:

fileName - Name of the file to read.

Throws:

java.io.IOException - If an I/O error occurs while reading.

readAll

public void readAll(java.net.URL url)
             throws java.io.IOException

Description copied from interface: FileSource

Read the whole file in one big non-interruptible operation.

Specified by:

readAll in interface FileSource

Parameters:

url - The URL of the file to read.

Throws:

java.io.IOException - If an I/O error occurs while reading.

readAll

public void readAll(java.io.InputStream stream)
             throws java.io.IOException

Description copied from interface: FileSource

Read the whole file in one big non-interruptible operation.

Specified by:

readAll in interface FileSource

Parameters:

stream - The input stream to use for reading.

Throws:

java.io.IOException - If an I/O error occurs while reading.

readAll

public void readAll(java.io.Reader reader)
             throws java.io.IOException

Description copied from interface: FileSource

Read the whole file in one big non-interruptible operation.

Specified by:

readAll in interface FileSource

Parameters:

reader - The reader to use.

Throws:

java.io.IOException - If an I/O error occurs while reading.

begin

public void begin(java.lang.String fileName)
           throws java.io.IOException

Description copied from interface: FileSource

Begin reading the file stopping as soon as possible. Next graph events stored in the file will be sent by calling FileSource.nextEvents() or FileSource.nextStep(). Once begin() has been called, you must finish the reading process using FileSource.end(). You cannot call begin() twice without having called FileSource.end() in between.

Specified by:

begin in interface FileSource

Parameters:

fileName - Name of the file to read.

Throws:

java.io.IOException - If an I/O error occurs while reading.

begin

public void begin(java.net.URL url)
           throws java.io.IOException

Description copied from interface: FileSource

Begin reading the file stopping as soon as possible. Next graph events stored in the file will be sent by calling FileSource.nextEvents() or FileSource.nextStep(). Once begin() has been called, you must finish the reading process using FileSource.end(). You cannot call begin() twice without having called FileSource.end() in between.

Specified by:

begin in interface FileSource

Parameters:

url - The URL of the file to read.

Throws:

java.io.IOException - If an I/O error occurs while reading.

begin

public void begin(java.io.InputStream stream)
           throws java.io.IOException

Description copied from interface: FileSource

Begin reading the file stopping as soon as possible. Next graph events stored in the file will be sent by calling FileSource.nextEvents() or FileSource.nextStep(). Once begin() has been called, you must finish the reading process using FileSource.end(). You cannot call begin() twice without having called FileSource.end() in between.

Specified by:

begin in interface FileSource

Parameters:

stream - The input stream to use for reading.

Throws:

java.io.IOException - If an I/O error occurs while reading.

begin

public void begin(java.io.Reader reader)
           throws java.io.IOException

Description copied from interface: FileSource

Begin reading the file stopping as soon as possible. Next graph events stored in the file will be sent by calling FileSource.nextEvents() or FileSource.nextStep(). Once begin() has been called, you must finish the reading process using FileSource.end(). You cannot call begin() twice without having called FileSource.end() in between.

Specified by:

begin in interface FileSource

Parameters:

reader - The file reader to use.

Throws:

java.io.IOException - If an I/O error occurs while reading.

nextEvents

public abstract boolean nextEvents()
                            throws java.io.IOException

Description copied from interface: FileSource

Try to process one graph event, or as few as possible, if more must be read at once. For this method to work, you must have called FileSource.begin(InputStream) or FileSource.begin(String) before. This method return true while there are still events to read.

Specified by:

nextEvents in interface FileSource

Returns:

true if there are still events to read, false as soon as the file is finished.

Throws:

java.io.IOException - If an I/O error occurs while reading.

nextStep

public boolean nextStep()
                 throws java.io.IOException

Description copied from interface: FileSource

Try to process all the events occurring during one time step. In GraphStream, a time step is a group of events that are considered occurring at the same time. Most file formats do not have this notion of step. The DGS format designed for GraphStream handles steps. This method return true while there are still events to read.

Specified by:

nextStep in interface FileSource

Returns:

true if there are still events to read, false as soon as the file is finished.

Throws:

java.io.IOException - If an I/O error occurs while reading.

end

public void end()
         throws java.io.IOException

Description copied from interface: FileSource

Finish the reading process (even if FileSource.nextEvents() or FileSource.nextStep() did not returned false). You must call this method after reading.

Specified by:

end in interface FileSource

Throws:

java.io.IOException - If an I/O error occurs while closing the file.