BooleanCoord
, FloatingArrayCoord
, FloatingCoord
, IntegerCoord
, LongCoord
, SingleCoord
, SkyCoord
, StringCoord
public interface Coord
inputToStorage(java.lang.Object[], uk.ac.starlink.table.DomainMapper[])
method translates between these
two representations.
An implementation of this class defines an additional
read*Coord(Tuple,int)
method which is able to
read appropriate coordinate values from a suitable field of a
Tuple
. That behaviour is not enforced or defined in this
interface using generic types, partly in order to allow use of
primitive types and eliminate unnecessary use of wrapper classes.
In many cases, both the input and the plotting views will be a scalar,
in which case there will be only one Input.
One notable case for which this is not true is for SkyCoord
,
which has two input coordinates (lat + long) and three storage coordinates
(x, y, z vector).
Modifier and Type | Method | Description |
---|---|---|
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.
|
java.lang.Object |
inputToStorage(java.lang.Object[] inputValues,
uk.ac.starlink.table.DomainMapper[] inputMappers) |
Turns a quantity in the user view to a plotting view object.
|
boolean |
isRequired() |
Indicates whether this item must have a non-blank value in order
for a plot to be possible.
|
Input[] getInputs()
boolean isRequired()
StorageType getStorageType()
java.lang.Object inputToStorage(java.lang.Object[] inputValues, uk.ac.starlink.table.DomainMapper[] inputMappers)
The supplied parameters both correspond (have the same length as)
this object's Inputs array.
For each Input, the corresponding element of the
inputValues
array gives the value obtained from
the user-supplied data (matching Input.getValueClass()
),
and the corresponding element of the inputMappers
array gives a DomainMapper object
(consistent with Input.getDomain()
).
InputMappers may be null however, and in many cases,
coordinates are not sensitive to domains,
and for those cases implementations will ignore
inputMappers
.
inputValues
- per-input valuesinputMappers
- per-input domain mappers, each may be nullgetStorageType()
; not nullCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.