de.jstacs.results
Class ResultSet

java.lang.Object
  extended by 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
protected  Result[] results
          The set of results as an array of Results
 
Constructor Summary
ResultSet(Collection<? extends Result> results)
          Constructs a new ResultSet from a Collection of type Results.
ResultSet(Result result)
          Constructs a new ResultSet containing one Result.
ResultSet(Result[]... results)
          Constructs a new ResultSet from a 2-dimensional array of Results.
ResultSet(StringBuffer representation)
          Constructs a ResultSet from its XML-representation.
 
Method Summary
 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[] getResults()
          Returns all internal results.
 String toString()
           
 StringBuffer toXML()
          This method returns an XML-representation 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 Result[] results
The set of results as an array of Results

Constructor Detail

ResultSet

public ResultSet(Result result)
Constructs a new ResultSet containing one Result.

Parameters:
result - Result to be contained

ResultSet

public ResultSet(Result[]... results)
Constructs a new ResultSet from a 2-dimensional array of Results.

Parameters:
results - the 2-dimensional array of Results

ResultSet

public ResultSet(Collection<? extends Result> results)
Constructs a new ResultSet from a Collection of type Results.

Parameters:
results - a Collection of Results/code>

ResultSet

public ResultSet(StringBuffer representation)
          throws NonParsableException
Constructs a ResultSet from its XML-representation.

Parameters:
representation - the XML-representation
Throws:
NonParsableException - a NonParsableException is thrown if 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

getResults

public Result[] getResults()
Returns all internal results.

Returns:
all internal 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 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
Throws:
NonParsableException - is thrown 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.