de.jstacs.results

Class TextResult

java.lang.Object

de.jstacs.AnnotatedEntity

de.jstacs.results.Result

de.jstacs.results.TextResult

All Implemented Interfaces:

Storable

public class TextResult
extends Result

Class for a result that is basically a text file (or its contents). This is the Result analogon of a FileParameter, but conceptually (though not formally) restricted to text contents.

Author:

Jan Grau

Field Summary

Fields inherited from class de.jstacs.AnnotatedEntity

comment, datatype, name

Constructor Summary

Constructors

Constructor and Description
TextResult(StringBuffer xml) Creates a TextResult from its XML representation.
TextResult(String name, String comment, FileParameter.FileRepresentation file, String mime, String producer, String extendedType, boolean export) Creates a new TextResult with given name, comment, content, mime type, and additional info.

Method Summary

Methods

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).
static boolean	equals(String[] p1, String mime2) Checks if the list of mime types given in p1 contains an element that is equal to one of the mime types given in mime2 (may be multiple, separated by commas).
static boolean	equals(String mime1, String mime2) Checks if the list of mime types given in mime1 (may be multiple, separated by commas) contains an element that is equal to one of the mime types given in mime2.
protected void	extractFurtherInfos(StringBuffer buf) This method can be used in the constructor with parameter StringBuffer to extract the further information.
void	fill(FileParameter par) Fills the supplied FileParameter with a clone of the contents of this TextResult.
boolean	getExport() Returns true if the contents are saved to a separate file in Galaxy.
String	getExtendedType() Returns the extended type of this TextResult.
String	getMime() Returns the mime type of this TextResult.
Object	getProducer() Returns the producer (i.e., the tool/application/program) that created this TextResult.
FileParameter.FileRepresentation	getValue() Returns the value of the AnnotatedEntity.
String	getXMLTag() This method returns a tag used as outer tag of the XML description.
void	setExtendedType(String extendedType) Sets the extended type of this TextResult.

Methods inherited from class de.jstacs.results.Result

checkDatatype, createResult, isCastableResult, isComparableResult

Methods inherited from class de.jstacs.AnnotatedEntity

getComment, getDatatype, getName, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

TextResult

public TextResult(String name,
          String comment,
          FileParameter.FileRepresentation file,
          String mime,
          String producer,
          String extendedType,
          boolean export)

Creates a new TextResult with given name, comment, content, mime type, and additional info.

Parameters:

name - the name of the result

comment - a comment on the result

file - the contents of the result, encapsulated in a FileParameter.FileRepresentation.

mime - the mime type of the content

producer - the producer (may be null)

extendedType - the extended type (may be null)

export - if true, the contents are exported as a separate file when used in Galaxy

TextResult

public TextResult(StringBuffer xml)
           throws NonParsableException

Creates a TextResult from its XML representation.

Parameters:

xml - the XML representation

Throws:

NonParsableException - if XML could not be parsed

Method Detail

getExport

public boolean getExport()

Returns true if the contents are saved to a separate file in Galaxy.

Returns:

if the contents are saved to a separate file

equals

public static boolean equals(String[] p1,
             String mime2)

Checks if the list of mime types given in p1 contains an element that is equal to one of the mime types given in mime2 (may be multiple, separated by commas).

Parameters:

p1 - the reference mime types

mime2 - the mime types to be checked

Returns:

if p1 and mime2 share a mime type

equals

public static boolean equals(String mime1,
             String mime2)

Checks if the list of mime types given in mime1 (may be multiple, separated by commas) contains an element that is equal to one of the mime types given in mime2.

Parameters:

mime1 - the reference mime types

mime2 - the mime types to be checked

Returns:

if mime1 and mime2 share a mime type

fill

public void fill(FileParameter par)
          throws SimpleParameter.IllegalValueException,
                 CloneNotSupportedException

Fills the supplied FileParameter with a clone of the contents of this TextResult.

Parameters:

par - the FileParameter to be filled

Throws:

SimpleParameter.IllegalValueException - if the value of this FileParameter is not accepted by the supplied parameter

CloneNotSupportedException - if the contents of this TextResult could not be cloned.

getMime

public String getMime()

Returns the mime type of this TextResult.

Returns:

the mime type

getExtendedType

public String getExtendedType()

Returns the extended type of this TextResult. May be used for checking compatibility for fill(FileParameter) using FileParameter.getExtendedType().

Returns:

the extended type

setExtendedType

public void setExtendedType(String extendedType)

Sets the extended type of this TextResult.

Parameters:

extendedType - the extended type

See Also:

FileParameter.setExtendedType(String)

getXMLTag

public String getXMLTag()

Description copied from class: AnnotatedEntity

This method returns a tag used as outer tag of the XML description.

Specified by:

getXMLTag in class AnnotatedEntity

Returns:

a tag used as outer tag of the XML description

appendFurtherInfos

protected void appendFurtherInfos(StringBuffer buf)

Description copied from class: AnnotatedEntity

This method can be used in the method Storable.toXML() to extract further information (name, comment, datatype).

Specified by:

appendFurtherInfos in class AnnotatedEntity

Parameters:

buf - a XML representation of the main information as StringBuffer

See Also:

Storable.toXML()

extractFurtherInfos

protected void extractFurtherInfos(StringBuffer buf)
                            throws NonParsableException

Description copied from class: AnnotatedEntity

This method can be used in the constructor with parameter StringBuffer to extract the further information.

Specified by:

extractFurtherInfos in class AnnotatedEntity

Parameters:

buf - a XML represenation of the main information as StringBuffer

Throws:

NonParsableException - if the XML representation is not parsable

See Also:

AnnotatedEntity.AnnotatedEntity(StringBuffer)

getValue

public FileParameter.FileRepresentation getValue()

Description copied from class: AnnotatedEntity

Returns the value of the AnnotatedEntity.

Specified by:

getValue in class AnnotatedEntity

Returns:

the value of the AnnotatedEntity

getProducer

public Object getProducer()

Returns the producer (i.e., the tool/application/program) that created this TextResult.

Returns:

the producer