de.jstacs.results

Class PlotGeneratorResult

java.lang.Object

de.jstacs.AnnotatedEntity

de.jstacs.results.Result

de.jstacs.results.PlotGeneratorResult

All Implemented Interfaces:

Storable

public class PlotGeneratorResult
extends Result

Class for a Result that may be used to generate plots for different output formats using GraphicsAdaptor sub-classes. Graphics are generated on demand.

Author:

Jan Grau

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlotGeneratorResult.PlotGenerator Interface for a class that may generate a plot using the specified GraphicsAdaptor.

Field Summary

Fields inherited from class de.jstacs.AnnotatedEntity

comment, datatype, name

Constructor Summary

Constructors

Constructor and Description
PlotGeneratorResult(StringBuffer rep) Creates a new PlotGeneratorResult from its XML representation.
PlotGeneratorResult(String name, String comment, PlotGeneratorResult.PlotGenerator gen, boolean isStatic) Creates a new PlotGeneratorResult with the given name, comment, PlotGeneratorResult.PlotGenerator.

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).
protected void	extractFurtherInfos(StringBuffer buf) This method can be used in the constructor with parameter StringBuffer to extract the further information.
PlotGeneratorResult.PlotGenerator	getValue() Returns the value of the AnnotatedEntity.
String	getXMLTag() This method returns a tag used as outer tag of the XML description.
boolean	isStatic() Returns true if the plot is considered static and may be cached.

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

PlotGeneratorResult

public PlotGeneratorResult(String name,
                   String comment,
                   PlotGeneratorResult.PlotGenerator gen,
                   boolean isStatic)

Creates a new PlotGeneratorResult with the given name, comment, PlotGeneratorResult.PlotGenerator.

Parameters:

name - the name of the result

comment - a comment on the result

gen - the object that may generate the plot

isStatic - if true, the plot is considered static and may be cached.

PlotGeneratorResult

public PlotGeneratorResult(StringBuffer rep)
                    throws NonParsableException

Creates a new PlotGeneratorResult from its XML representation.

Parameters:

rep - the XML representation

Throws:

NonParsableException - if XML could not be parsed

Method Detail

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 PlotGeneratorResult.PlotGenerator getValue()

Description copied from class: AnnotatedEntity

Returns the value of the AnnotatedEntity.

Specified by:

getValue in class AnnotatedEntity

Returns:

the value of the AnnotatedEntity

isStatic

public boolean isStatic()

Returns true if the plot is considered static and may be cached.

Returns:

if the plot is considered static and may be cached.