ikr.simlib.result

Interface ResultReader

All Known Implementing Classes:

XMLResultReader

public interface ResultReader

The result input interface is used to input results in a serial way. This is the most basic way to read results.

The result tree is traversed through a set of events by calling next(). Each event can trigger a state change which changes the set of methods that can be called.

Available methods in a certain state

Event	Available methods
START_RESULTS	next, hasNext
END_RESULTS	hasNext
START_NODE	next, hasNext, getName, getTypeName
END_NODE	next, hasNext
RESULT	next, hasNext, getName, getTypeName, getValue, getInt | getLong | getDouble | getString (depends on the result type)
START_ARRAY	next, hasNext, getName, getTypeName
END_ARRAY	next, hasNext
START_ELEMENT	next, hasNext, getName, getTypeName, getIndex
END_ELEMENT	next, hasNext

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResultReader.Event Read events which occur in a result file.

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 name) 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 name) 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 name) Reads the next string result from the input.

Method Detail

close

void close()
           throws ImportException

Closes the reader and underlying streams.

Throws:

ImportException

next

ResultReader.Event next()
                        throws ImportException

Returns the next result read event.

Returns:

the next read event

Throws:

ImportException

nextResult

ResultReader.Event nextResult()
                              throws ImportException

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

Returns:

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

Throws:

ImportException

hasNext

boolean hasNext()
                throws ImportException

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

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

Returns:

whether any read events remain

Throws:

ImportException

getName

java.lang.String getName()
                         throws ImportException

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

Returns:

the name of the current result or null

Throws:

ImportException

getTypeName

java.lang.String getTypeName()
                             throws ImportException

Returns the type of the current result.

Returns:

the type of the current result

Throws:

ImportException

getIndex

long getIndex()
              throws ImportException

Returns the index of the current result element.

Returns:

the index of the current element

Throws:

ImportException

getValue

java.lang.String getValue()
                          throws ImportException

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

Returns:

the unparsed value of the current result

Throws:

ImportException

readStartResults

void readStartResults()
                      throws ImportException

Reads the start of the result tree.

Throws:

ImportException

readEndResults

void readEndResults()
                    throws ImportException

Reads the end of the result tree.

Throws:

ImportException

readStartArray

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

Reads the next result array.

Parameters:

expectedName - the expected name

Throws:

ImportException

readEndArray

void readEndArray()
                  throws ImportException

Reads the end of the current result array.

Throws:

ImportException

readStartArrayItem

long readStartArrayItem(long expectedIndex)
                        throws ImportException

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.

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

readEndArrayItem

void readEndArrayItem()
                      throws ImportException

Reads the end of the current array element.

Throws:

ImportException

readStartNode

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

Reads the next result node.

Parameters:

expectedType - the expected type name

expectedName - the expected name

Throws:

ImportException

readEndNode

void readEndNode()
                 throws ImportException

Reads the end of the current result node.

Throws:

ImportException

getLong

long getLong()
             throws ImportException

Returns the current long integer result.

Returns:

the current long integer result

Throws:

ImportException

readLong

long readLong(java.lang.String name)
              throws ImportException

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

 nextResult();
 getLong();
 
 

Returns:

the next long integer result

Throws:

ImportException

getDouble

double getDouble()
                 throws ImportException

Returns the current double result.

Returns:

the current double result

Throws:

ImportException

readDouble

double readDouble(java.lang.String name)
                  throws ImportException

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

 nextResult();
 getDouble();
 
 

Returns:

the next double result

Throws:

ImportException

getString

java.lang.String getString()
                           throws ImportException

Returns the current string result.

Returns:

the current string result

Throws:

ImportException

readString

java.lang.String readString(java.lang.String name)
                            throws ImportException

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

 nextResult();
 getString();
 
 

Returns:

the next string result

Throws:

ImportException