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.
int	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() Reads the next result array.
int	readStartArrayItem() Reads the next array element.
void	readStartNode() Reads the next result node.
void	readStartNode(java.lang.String expectedType) Reads the next result node.
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 ResultException

Closes the reader and underlying streams.

Throws:

ResultException

next

ResultReader.Event next()
                        throws ResultException

Returns the next result read event.

Returns:

the next read event

Throws:

java.lang.IllegalStateException - if no events remain

ResultException

nextResult

ResultReader.Event nextResult()
                              throws ResultException

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

Returns:

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

Throws:

java.lang.IllegalStateException - if not in an result node or array element

ResultException

hasNext

boolean hasNext()
                throws ResultException

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:

ResultException

getName

java.lang.String getName()
                         throws ResultException

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:

java.lang.IllegalStateException - if not called in a result item, node or array

ResultException

getTypeName

java.lang.String getTypeName()
                             throws ResultException

Returns the type of the current result.

Returns:

the type of the current result

Throws:

java.lang.IllegalStateException - if not called in a result item or node

ResultException

getIndex

int getIndex()
             throws ResultException

Returns the index of the current result element.

Returns:

the index of the current element

Throws:

java.lang.IllegalStateException - if not in an array element

ResultException

getValue

java.lang.String getValue()
                          throws ResultException

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

Returns:

the unparsed value of the current result

Throws:

java.lang.IllegalStateException - if not in a result item

ResultException

readStartResults

void readStartResults()
                      throws ResultException

Reads the start of the result tree.

Throws:

java.lang.IllegalStateException - if the start of the result tree has been read already

ResultException

readEndResults

void readEndResults()
                    throws ResultException

Reads the end of the result tree.

Throws:

java.lang.IllegalStateException - if the next event is not the end of the result tree

ResultException

readStartArray

void readStartArray()
                    throws ResultException

Reads the next result array.

Throws:

ResultException

readEndArray

void readEndArray()
                  throws ResultException

Reads the end of the current result array.

Throws:

java.lang.IllegalStateException - if not in an result array

ResultException

readStartArrayItem

int readStartArrayItem()
                       throws ResultException

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.

Returns:

the index of the next element or -1

Throws:

java.lang.IllegalStateException - if not in an array or if the last call returned -1

ResultException

readEndArrayItem

void readEndArrayItem()
                      throws ResultException

Reads the end of the current array element.

Throws:

java.lang.IllegalStateException - if not in an array element

ResultException

readStartNode

void readStartNode()
                   throws ResultException

Reads the next result node.

Throws:

ResultException

readStartNode

void readStartNode(java.lang.String expectedType)
                   throws ResultException

Reads the next result node.

Parameters:

expectedType - the expected type name

Throws:

ResultException

readStartNode

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

Reads the next result node.

Parameters:

expectedType - the expected type name

expectedName - the expected name

Throws:

ResultException

readEndNode

void readEndNode()
                 throws ResultException

Reads the end of the current result node.

Throws:

java.lang.IllegalStateException - if not in an result node

ResultException

getLong

long getLong()
             throws ResultException

Returns the current long integer result.

Returns:

the current long integer result

Throws:

java.lang.IllegalStateException - if not in a long result item

ResultException

readLong

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

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

 nextResult();
 getLong();
 
 

Returns:

the next long integer result

Throws:

java.lang.IllegalStateException - if the next result is not a long

ResultException

getDouble

double getDouble()
                 throws ResultException

Returns the current double result.

Returns:

the current double result

Throws:

java.lang.IllegalStateException - if not in a double result item

ResultException

readDouble

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

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

 nextResult();
 getDouble();
 
 

Returns:

the next double result

Throws:

java.lang.IllegalStateException - if the next result is not a double

ResultException

getString

java.lang.String getString()
                           throws ResultException

Returns the current string result.

Returns:

the current string result

Throws:

java.lang.IllegalStateException - if not in a string result item

ResultException

readString

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

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

 nextResult();
 getString();
 
 

Returns:

the next string result

Throws:

java.lang.IllegalStateException - if the next result is not a string

ResultException