ikr.simlib.result.xml

Class XMLResultReader

java.lang.Object

ikr.simlib.result.xml.XMLResultReader

All Implemented Interfaces:

ResultReader

public class XMLResultReader
extends java.lang.Object
implements ResultReader

Nested Class Summary

Nested classes/interfaces inherited from interface ikr.simlib.result.ResultReader

ResultReader.Event

Constructor Summary

Constructors

Constructor and Description
XMLResultReader(java.io.InputStream input, java.lang.String fileNameForErrorMessages)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the reader and underlying streams.
double	getDouble() Returns the current double result.
long	getIndex() Returns the index of the current result element.
long	getLong() Returns the current long integer result.
java.lang.String	getName() Returns the name of the current result.
java.lang.String	getString() Returns the current string result.
java.lang.String	getTypeName() Returns the type of the current result.
java.lang.String	getValue() Reads the unparsed value of the current result from the input.
boolean	hasNext() Returns whether any read events remain or the result tree has been fully traversed.
ResultReader.Event	next() Returns the next result read event.
ResultReader.Event	nextResult() Reads the next result (item, node or array).
double	readDouble(java.lang.String expectedName) Reads the next double result from the input.
void	readEndArray() Reads the end of the current result array.
void	readEndArrayItem() Reads the end of the current array element.
void	readEndNode() Reads the end of the current result node.
void	readEndResults() Reads the end of the result tree.
long	readLong(java.lang.String expectedName) Reads the next long integer result from the input.
void	readStartArray(java.lang.String expectedName) Reads the next result array.
long	readStartArrayItem(long expectedIndex) Reads the next array element.
void	readStartNode(java.lang.String expectedType, java.lang.String expectedName) Reads the next result node.
void	readStartResults() Reads the start of the result tree.
java.lang.String	readString(java.lang.String expectedName) Reads the next string result from the input.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLResultReader

public XMLResultReader(java.io.InputStream input,
               java.lang.String fileNameForErrorMessages)
                throws ImportException

Throws:

ImportException

Method Detail

close

public void close()
           throws ImportException

Description copied from interface: ResultReader

Closes the reader and underlying streams.

Specified by:

close in interface ResultReader

Throws:

ImportException

getDouble

public double getDouble()
                 throws ImportException

Description copied from interface: ResultReader

Returns the current double result.

Specified by:

getDouble in interface ResultReader

Returns:

the current double result

Throws:

ImportException

getIndex

public long getIndex()
              throws ImportException

Description copied from interface: ResultReader

Returns the index of the current result element.

Specified by:

getIndex in interface ResultReader

Returns:

the index of the current element

Throws:

ImportException

getLong

public long getLong()
             throws ImportException

Description copied from interface: ResultReader

Returns the current long integer result.

Specified by:

getLong in interface ResultReader

Returns:

the current long integer result

Throws:

ImportException

getName

public java.lang.String getName()
                         throws ImportException

Description copied from interface: ResultReader

Returns the name of the current result. If the current result has no name null is returned.

Specified by:

getName in interface ResultReader

Returns:

the name of the current result or null

Throws:

ImportException

getString

public java.lang.String getString()
                           throws ImportException

Description copied from interface: ResultReader

Returns the current string result.

Specified by:

getString in interface ResultReader

Returns:

the current string result

Throws:

ImportException

getTypeName

public java.lang.String getTypeName()
                             throws ImportException

Description copied from interface: ResultReader

Returns the type of the current result.

Specified by:

getTypeName in interface ResultReader

Returns:

the type of the current result

Throws:

ImportException

getValue

public java.lang.String getValue()
                          throws ImportException

Description copied from interface: ResultReader

Reads the unparsed value of the current result from the input.

Specified by:

getValue in interface ResultReader

Returns:

the unparsed value of the current result

Throws:

ImportException

hasNext

public boolean hasNext()

Description copied from interface: ResultReader

Returns whether any read events remain or the result tree has been fully traversed.

Calling ResultReader.next() after this mehtod returned false will result in an exception.

Specified by:

hasNext in interface ResultReader

Returns:

whether any read events remain

next

public ResultReader.Event next()
                        throws ImportException

Description copied from interface: ResultReader

Returns the next result read event.

Specified by:

next in interface ResultReader

Returns:

the next read event

Throws:

ImportException

readStartResults

public void readStartResults()
                      throws ImportException

Description copied from interface: ResultReader

Reads the start of the result tree.

Specified by:

readStartResults in interface ResultReader

Throws:

ImportException

readEndResults

public void readEndResults()
                    throws ImportException

Description copied from interface: ResultReader

Reads the end of the result tree.

Specified by:

readEndResults in interface ResultReader

Throws:

ImportException

readEndArrayItem

public void readEndArrayItem()
                      throws ImportException

Description copied from interface: ResultReader

Reads the end of the current array element.

Specified by:

readEndArrayItem in interface ResultReader

Throws:

ImportException

readEndNode

public void readEndNode()
                 throws ImportException

Description copied from interface: ResultReader

Reads the end of the current result node.

Specified by:

readEndNode in interface ResultReader

Throws:

ImportException

readStartNode

public void readStartNode(java.lang.String expectedType,
                 java.lang.String expectedName)
                   throws ImportException

Description copied from interface: ResultReader

Reads the next result node.

Specified by:

readStartNode in interface ResultReader

Parameters:

expectedType - the expected type name

expectedName - the expected name

Throws:

ImportException

readEndArray

public void readEndArray()
                  throws ImportException

Description copied from interface: ResultReader

Reads the end of the current result array.

Specified by:

readEndArray in interface ResultReader

Throws:

ImportException

readStartArray

public void readStartArray(java.lang.String expectedName)
                    throws ImportException

Description copied from interface: ResultReader

Reads the next result array.

Specified by:

readStartArray in interface ResultReader

Parameters:

expectedName - the expected name

Throws:

ImportException

nextResult

public ResultReader.Event nextResult()
                              throws ImportException

Description copied from interface: ResultReader

Reads the next result (item, node or array).

Specified by:

nextResult in interface ResultReader

Returns:

either ResultReader.Event.RESULT, ResultReader.Event.START_NODE or ResultReader.Event.START_ARRAY

Throws:

ImportException

readStartArrayItem

public long readStartArrayItem(long expectedIndex)
                        throws ImportException

Description copied from interface: ResultReader

Reads the next array element. If the end of the array has been reached -1 is returned. If called after the end of the array, an exception will be thrown.

Specified by:

readStartArrayItem in interface ResultReader

Parameters:

expectedIndex - the expected index (to be compared with the index read from the result file)

Returns:

the index of the next element or -1

Throws:

ImportException

readDouble

public double readDouble(java.lang.String expectedName)
                  throws ImportException

Description copied from interface: ResultReader

Reads the next double result from the input. This method is equivalent of calling

 nextResult();
 getDouble();
 
 

Specified by:

readDouble in interface ResultReader

Returns:

the next double result

Throws:

ImportException

readLong

public long readLong(java.lang.String expectedName)
              throws ImportException

Description copied from interface: ResultReader

Reads the next long integer result from the input. This method is equivalent of calling

 nextResult();
 getLong();
 
 

Specified by:

readLong in interface ResultReader

Returns:

the next long integer result

Throws:

ImportException

readString

public java.lang.String readString(java.lang.String expectedName)
                            throws ImportException

Description copied from interface: ResultReader

Reads the next string result from the input. This method is equivalent of calling

 nextResult();
 getString();
 
 

Specified by:

readString in interface ResultReader

Returns:

the next string result

Throws:

ImportException