public class ListResult extends Result
Result
that contains a list or a matrix, respectively, of
ResultSet
s. This class provides a way to build a hierarchy of
Result
s and ResultSet
s, or to create multi-dimensional
Result
.Modifier and Type | Field and Description |
---|---|
protected ResultSet[] |
list
The internal list of
ResultSet s that are part of this
ListResult |
comment, datatype, name
Constructor and Description |
---|
ListResult(StringBuffer representation)
The standard constructor for the interface
Storable . |
ListResult(String name,
String comment,
ResultSet annotation,
Collection<ResultSet> coll)
Creates a new
ListResult from a Collection of ResultSet s and
a ResultSet of annotations, which may provide additional
information on this ListResult . |
ListResult(String name,
String comment,
ResultSet annotation,
ResultSet... results)
Creates a new
ListResult from an array of ResultSet s and
a ResultSet of annotations, which may provide additional
information on this ListResult . |
Modifier and Type | Method and Description |
---|---|
protected void |
appendFurtherInfos(StringBuffer buf)
This method can be used in the method
Storable.toXML() to extract
further information (name, comment, datatype). |
protected void |
extractFurtherInfos(StringBuffer representation)
This method can be used in the constructor with parameter
StringBuffer to
extract the further information. |
ResultSet |
getAnnotation()
Returns a reference to the annotation of this
ListResult . |
boolean |
getExport()
Returns if this
ListResult is exported in Galaxy . |
int |
getNumberOfResultSets()
Returns the number of
ResultSet s in this ListResult |
ResultSet[] |
getRawResult()
Returns a copy of the internal list of
ResultSet s. |
ResultSet[] |
getValue()
Returns the value of the
AnnotatedEntity . |
String |
getXMLTag()
This method returns a tag used as outer tag of the XML description.
|
void |
print(PrintWriter writer)
Prints the information of this
ListResult to the provided
PrintWriter . |
void |
setExport(boolean export)
Sets if this
ListResult will be exported in Galaxy . |
ListResult |
sort(String columnName)
This method enables you to sort the entries of this container by a
specified column.
|
String |
toString() |
checkDatatype, createResult, getOriginalName, isCastableResult, isComparableResult, rename
getComment, getDatatype, getName, toXML
protected ResultSet[] list
ResultSet
s that are part of this
ListResult
public ListResult(String name, String comment, ResultSet annotation, ResultSet... results)
ListResult
from an array of ResultSet
s and
a ResultSet
of annotations, which may provide additional
information on this ListResult
.name
- the name of the ListResult
comment
- the comment on the ListResult
annotation
- an annotation on this ListResult
results
- the array of ResultSet
spublic ListResult(String name, String comment, ResultSet annotation, Collection<ResultSet> coll)
ListResult
from a Collection
of ResultSet
s and
a ResultSet
of annotations, which may provide additional
information on this ListResult
.name
- the name of the ListResult
comment
- the comment on the ListResult
annotation
- an annotation on this ListResult
coll
- the Collection
of ResultSet
spublic ListResult(StringBuffer representation) throws NonParsableException
Storable
.
Creates a new ListResult
from the corresponding XML
representation.representation
- the XML representation as StringBuffer
NonParsableException
- if the StringBuffer
representation
could
not be parsedpublic ResultSet[] getValue()
AnnotatedEntity
AnnotatedEntity
.getValue
in class AnnotatedEntity
AnnotatedEntity
public ResultSet[] getRawResult()
ResultSet
s. The references
to the ResultSet
s in the array are not cloned.ResultSet
spublic int getNumberOfResultSets()
ResultSet
s in this ListResult
ResultSet
spublic ResultSet getAnnotation()
ListResult
.ListResult
public String getXMLTag()
AnnotatedEntity
getXMLTag
in class AnnotatedEntity
protected void appendFurtherInfos(StringBuffer buf)
AnnotatedEntity
Storable.toXML()
to extract
further information (name, comment, datatype).appendFurtherInfos
in class Result
buf
- a XML representation of the main information as
StringBuffer
Storable.toXML()
protected void extractFurtherInfos(StringBuffer representation) throws NonParsableException
AnnotatedEntity
StringBuffer
to
extract the further information.extractFurtherInfos
in class Result
representation
- a XML represenation of the main information as
StringBuffer
NonParsableException
- if the XML representation is not parsableAnnotatedEntity.AnnotatedEntity(StringBuffer)
public void print(PrintWriter writer)
ListResult
to the provided
PrintWriter
.writer
- the PrintWriter
public ListResult sort(String columnName) throws IllegalArgumentException
columnName
- the name of the column to be sortedListResult
, where the entries of the specified
column are sortedIllegalArgumentException
- if not all entries have a column with this namepublic boolean getExport()
ListResult
is exported in Galaxy
.public void setExport(boolean export)
ListResult
will be exported in Galaxy
.export
- if exported