Package uk.ac.starlink.ttools.plot2.data
Class SingleCoord
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.data.SingleCoord
-
- All Implemented Interfaces:
Coord
- Direct Known Subclasses:
BooleanCoord
,FloatingArrayCoord
,FloatingCoord
,IntegerCoord
,LongCoord
,StringCoord
public abstract class SingleCoord extends java.lang.Object implements Coord
Partial Coord implementation for quantities that are represented as scalars both to the user and internally.- Since:
- 4 Feb 2013
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SingleCoord(InputMeta meta, boolean isRequired, java.lang.Class valueClass, StorageType storageType, java.lang.Class<? extends uk.ac.starlink.table.DomainMapper> domain)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Input
getInput()
Returns the single user data input object.Input[]
getInputs()
Returns specifications of the one or more input values the user supplies to provide the data values for this coord.StorageType
getStorageType()
Returns a code indicating how the quantity defined by this object is stored internally and presented to the plotting classes.boolean
isRequired()
Indicates whether this item must have a non-blank value in order for a plot to be possible.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface uk.ac.starlink.ttools.plot2.data.Coord
inputToStorage
-
-
-
-
Constructor Detail
-
SingleCoord
protected SingleCoord(InputMeta meta, boolean isRequired, java.lang.Class valueClass, StorageType storageType, java.lang.Class<? extends uk.ac.starlink.table.DomainMapper> domain)
Constructor.- Parameters:
meta
- descriptive metadata for single user coordinateisRequired
- true if this coordinate is required for plottingvalueClass
- class of input coordinate quantitystorageType
- storage type objectdomain
- DomainMapper subtype for this coord, or null
-
-
Method Detail
-
getInputs
public Input[] getInputs()
Description copied from interface:Coord
Returns specifications of the one or more input values the user supplies to provide the data values for this coord.
-
getInput
public Input getInput()
Returns the single user data input object.- Returns:
- modifiable info object
-
getStorageType
public StorageType getStorageType()
Description copied from interface:Coord
Returns a code indicating how the quantity defined by this object is stored internally and presented to the plotting classes.- Specified by:
getStorageType
in interfaceCoord
- Returns:
- storage type enum instance
-
isRequired
public boolean isRequired()
Description copied from interface:Coord
Indicates whether this item must have a non-blank value in order for a plot to be possible.- Specified by:
isRequired
in interfaceCoord
- Returns:
- if true, values must be supplied to make a plot
-
-