anl.aida.data
Interface CoordAxis

All Known Subinterfaces:
StringCoordAxis, TimeCoordAxis
All Known Implementing Classes:
AbstractCoordAxis, AxisRange, DataFrameAxis, DataFrameStringAxis, DataFrameTimeAxis, DefaultStringCoordAxis, RegularTimeAxis

public interface CoordAxis

Interface for classes implementing axis metadata.

Version:
$Revision$ $Date$

Method Summary
 java.lang.String getAttribute(java.lang.String name)
          Gets the value of the named attribute.
 AxisType getAxisType()
          Gets the type of this axis.
 java.lang.String getDescription()
          Gets the description of this CoordAxis.
 java.lang.String getName()
          Gets the name of this CoordAxis.
 Range getRange()
          Gets the range of this axis.
 javax.measure.unit.Unit<?> getUnits()
          Gets the unit of measurement for this coordinate axis.
 double getValue(int index)
          Gets the value at the specified index.
 java.lang.String getValueAsString(int index)
          Gets the value as a String at the specified index.
 boolean isCompatible(CoordAxis axis)
          Gets whether or not the this axis is compatible with the specified axis.
 

Method Detail

getName

java.lang.String getName()
Gets the name of this CoordAxis.

Returns:
the name of this CoordAxis.

getDescription

java.lang.String getDescription()
Gets the description of this CoordAxis.

Returns:
the description of this CoordAxis.

getAttribute

java.lang.String getAttribute(java.lang.String name)
Gets the value of the named attribute.

Parameters:
name - the name of the attribute.
Returns:
the value of the named attribute or null if no such attribute is found.

getRange

Range getRange()
Gets the range of this axis.

Returns:
the range of this axis.

getAxisType

AxisType getAxisType()
Gets the type of this axis.

Returns:
the type of this axis.

getValue

double getValue(int index)
Gets the value at the specified index.

Parameters:
index - the index
Returns:
the value at the specified index.

getValueAsString

java.lang.String getValueAsString(int index)
Gets the value as a String at the specified index.

Parameters:
index - the index of the value to get
Returns:
the value as String at the specified index.

getUnits

javax.measure.unit.Unit<?> getUnits()
Gets the unit of measurement for this coordinate axis.

Returns:
the unit of measurement for this coordinate axis.

isCompatible

boolean isCompatible(CoordAxis axis)
Gets whether or not the this axis is compatible with the specified axis. Two axes are compatible if they can be used together in the same formula.

Parameters:
axis - the axis to check for compatibility
Returns:
true if this axis is compatibilty with the other axis, otherise false.