uk.ac.starlink.ttools.plot2.data
Class BooleanCoord

java.lang.Object
  uk.ac.starlink.ttools.plot2.data.SingleCoord
      uk.ac.starlink.ttools.plot2.data.BooleanCoord

All Implemented Interfaces:

Coord

public class BooleanCoord
extends SingleCoord

Coord implementation for single boolean values.

Since:

4 Feb 2013

Author:

Mark Taylor

Constructor Summary

BooleanCoord(InputMeta meta, boolean isRequired)
Constructor.

Method Summary

Object	inputToStorage(Object[] inputValues, uk.ac.starlink.table.DomainMapper[] mappers) Turns a quantity in the user view to a plotting view object.
boolean	readBooleanCoord(Tuple tuple, int icol) Reads a boolean value from an appropriate tuple column.

Methods inherited from class uk.ac.starlink.ttools.plot2.data.SingleCoord

getInput, getInputs, getStorageType, isRequired

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BooleanCoord

public BooleanCoord(InputMeta meta,
                    boolean isRequired)

Constructor.

Parameters:

meta - input value metadata

isRequired - true if this coordinate is required for plotting

Method Detail

inputToStorage

public Object inputToStorage(Object[] inputValues,
                             uk.ac.starlink.table.DomainMapper[] mappers)

Description copied from interface: Coord

Turns a quantity in the user view to a plotting view object. The return value is never null.

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.

Parameters:

inputValues - per-input values

mappers - per-input domain mappers, each may be null

Returns:

object of the type corresponding to the result of Coord.getStorageType(); not null

readBooleanCoord

public boolean readBooleanCoord(Tuple tuple,
                                int icol)

Reads a boolean value from an appropriate tuple column.

Parameters:

tuple - tuple

icol - index of field in tuple corresponding to this Coord

Returns:

value of boolean field