de.jstacs.results
Class ImageResult

java.lang.Object
  extended by de.jstacs.AnnotatedEntity
      extended by de.jstacs.results.Result
          extended by de.jstacs.results.ImageResult
All Implemented Interfaces:
Storable
Direct Known Subclasses:
GalaxyAdaptor.LinkedImageResult

public class ImageResult
extends Result

A class for results that are images of the PNG format. The images themselves cannot be stored to an XML representation and thus only the description (name, etc.) is stored.

Author:
Jan Grau, Jens Keilwagen

Field Summary
 
Fields inherited from class de.jstacs.AnnotatedEntity
comment, datatype, name
 
Constructor Summary
ImageResult(StringBuffer xml)
          The standard constructor for the interface Storable.
ImageResult(String name, String comment, BufferedImage image)
          Constructs a new ImageResult from a BufferedImage.
 
Method Summary
protected  void appendFurtherInfos(StringBuffer xml)
          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.
 BufferedImage getValue()
          Returns the value of the AnnotatedEntity.
 String getXMLTag()
          This method returns a tag used as outer tag of the XML description.
 String toString()
           
 
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, wait, wait, wait
 

Constructor Detail

ImageResult

public ImageResult(String name,
                   String comment,
                   BufferedImage image)
Constructs a new ImageResult from a BufferedImage.

Parameters:
name - the name of the image
comment - a comment on the image
image - the image itself

ImageResult

public ImageResult(StringBuffer xml)
            throws NonParsableException
The standard constructor for the interface Storable. Constructs a ImageResult out of an XML representation.

Parameters:
xml - the XML representation as StringBuffer
Throws:
NonParsableException - if the ImageResult could not be reconstructed out of the StringBuffer xml
Method Detail

getValue

public BufferedImage getValue()
Description copied from class: AnnotatedEntity
Returns the value of the AnnotatedEntity.

Specified by:
getValue in class AnnotatedEntity
Returns:
the value of the AnnotatedEntity

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 xml)
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:
xml - a XML representation of the main information as StringBuffer
See Also:
Storable.toXML()

extractFurtherInfos

protected void extractFurtherInfos(StringBuffer representation)
                            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:
representation - a XML represenation of the main information as StringBuffer
Throws:
NonParsableException - if the XML representation is not parsable
See Also:
AnnotatedEntity.AnnotatedEntity(StringBuffer)

toString

public String toString()
Overrides:
toString in class Object