|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.task.PlotContext
public abstract class PlotContext
Aggregates some miscellaneous information required for a plot task that may not be available until execution time.
Constructor Summary | |
---|---|
protected |
PlotContext(PlotType plotType,
DataGeom[] exampleGeoms)
Constructor. |
Method Summary | |
---|---|
static PlotContext |
createFixedContext(PlotType plotType,
DataGeom geom)
Constructs a PlotContext which always uses a fixed given DataGeom. |
static PlotContext |
createStandardContext(PlotType plotType)
Constructs a PlotContext which allows per-layer choice between those known by a given plot type. |
DataGeom[] |
getExampleGeoms()
Returns a list of one or more DataGeom objects to be used for example purposes. |
abstract DataGeom |
getGeom(Environment env,
String layerSuffix)
Returns the DataGeom to use for a given layer in the context of a given execution environment. |
abstract Parameter[] |
getGeomParameters(String layerSuffix)
Returns an array of parameters associated with a particular layer required for determining DataGeom at runtime. |
PlotType |
getPlotType()
Returns the plot type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PlotContext(PlotType plotType, DataGeom[] exampleGeoms)
plotType
- plot typeexampleGeoms
- example data geomsMethod Detail |
---|
public PlotType getPlotType()
public DataGeom[] getExampleGeoms()
public abstract Parameter[] getGeomParameters(String layerSuffix)
layerSuffix
- parameter suffix string identifying a plot layer
public abstract DataGeom getGeom(Environment env, String layerSuffix) throws TaskException
env
- execution environmentlayerSuffix
- parameter suffix string identifying a plot layer
TaskException
public static PlotContext createStandardContext(PlotType plotType)
plotType
- plot type
public static PlotContext createFixedContext(PlotType plotType, DataGeom geom)
plotType
- plot typegeom
- data geom used in all cases
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |