de.jstacs.results

Class ResultSet

java.lang.Object

de.jstacs.results.ResultSet

All Implemented Interfaces:

Storable

Direct Known Subclasses:

NumericalResultSet, SequenceAnnotation

public class ResultSet
extends Object
implements Storable

Class for a set of Results which provides methods to access single Results in the set, to retrieve the number of Results in the set, to get a String representation or an XML representation of all the Results in the set.

Author:

Jan Grau, Jens Keilwagen

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotatedEntityList<Result>	results The internally stores results.

Constructor Summary

Constructors

Constructor and Description
ResultSet(Collection<? extends Result> results) Constructs a new ResultSet from a Collection of type Result.
ResultSet(Result result) Constructs a new ResultSet containing one Result.
ResultSet(Result[]... results) Constructs a new ResultSet from a two-dimensional array of Results.
ResultSet(StringBuffer representation) The standard constructor for the interface Storable.

Method Summary

Methods

Modifier and Type	Method and Description
int	findColumn(String columnName) This method enables you to search for a column.
protected void	fromXML(StringBuffer representation) Parses the contents of a ResultSet from its XML representation as returned by toXML().
int	getNumberOfResults() Returns the number of Results in this ResultSet
Result	getResultAt(int index) Returns Result number index in this ResultSet.
Result	getResultForName(String name) Returns Result with name name in this ResultSet.
Result[]	getResults() Returns all internal results as an array of Results.
String	toString()
StringBuffer	toXML() This method returns an XML representation as StringBuffer of an instance of the implementing class.

Methods inherited from class java.lang.Object

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

Field Detail

results

protected AnnotatedEntityList<Result> results

The internally stores results.

Constructor Detail

ResultSet

public ResultSet(Result result)

Constructs a new ResultSet containing one Result.

Parameters:

result - the Result to be contained

ResultSet

public ResultSet(Result[]... results)

Constructs a new ResultSet from a two-dimensional array of Results.

Parameters:

results - the two-dimensional array of Results

ResultSet

public ResultSet(Collection<? extends Result> results)

Constructs a new ResultSet from a Collection of type Result.

Parameters:

results - a Collection of Results

ResultSet

public ResultSet(StringBuffer representation)
          throws NonParsableException

The standard constructor for the interface Storable. Constructs a ResultSet from its XML representation.

Parameters:

representation - the XML representation as StringBuffer

Throws:

NonParsableException - if the StringBuffer representation could not be parsed

Method Detail

getResultAt

public Result getResultAt(int index)

Returns Result number index in this ResultSet.

Parameters:

index - the index of the Result

Returns:

the Result at index

getResultForName

public Result getResultForName(String name)

Returns Result with name name in this ResultSet.

Parameters:

name - the name of the Result

Returns:

the Result with name name

getResults

public Result[] getResults()

Returns all internal results as an array of Results.

Returns:

all internal results as an array of Results

getNumberOfResults

public int getNumberOfResults()

Returns the number of Results in this ResultSet

Returns:

the number of Results

toXML

public StringBuffer toXML()

Description copied from interface: Storable

This method returns an XML representation as StringBuffer of an instance of the implementing class.

Specified by:

toXML in interface Storable

Returns:

the XML representation

fromXML

protected void fromXML(StringBuffer representation)
                throws NonParsableException

Parses the contents of a ResultSet from its XML representation as returned by toXML().

Parameters:

representation - the XML representation as StringBuffer

Throws:

NonParsableException - if the XML code could not be parsed

toString

public String toString()

Overrides:

toString in class Object

findColumn

public int findColumn(String columnName)

This method enables you to search for a column. It returns the index of the column, if it could be found, otherwise -1.

Parameters:

columnName - the name of the column

Returns:

the index of the column, if it could be found, otherwise -1.