anl.aida.data
Class DataFrameAxis

java.lang.Object
  extended by anl.aida.data.AxisRange
      extended by anl.aida.data.DataFrameAxis
All Implemented Interfaces:
CoordAxis
Direct Known Subclasses:
DataFrameStringAxis, DataFrameTimeAxis

public class DataFrameAxis
extends AxisRange

Metadata for the axes / dimensions of a dataframe.

Version:
$Revision$ $Date$

Field Summary
private  int index
           
 
Fields inherited from class anl.aida.data.AxisRange
axis, range
 
Constructor Summary
protected DataFrameAxis(CoordAxis axis, int index)
          Creates a DataFrameAxis for the specified axis with origin and extent equal to that of the axis.
protected DataFrameAxis(CoordAxis axis, int origin, int extent, int index)
          Creates a DataFrameAxis for the specified axis with the specified origin and extent.
protected DataFrameAxis(DataFrameAxis axis, int index)
          Creates a DataFrameAxis from the specified axis and index.
 
Method Summary
static DataFrameAxis createDataFrameAxis(CoordAxis axis, int index)
          Creates a DataFrameAxis for the specified axis with origin and extent equal to that of the axis.
static DataFrameAxis createDataFrameAxis(CoordAxis axis, int origin, int extent, int index)
          Creates a DataFrameAxis for the specified axis with the specified origin and extent.
static DataFrameAxis createDataFrameAxis(DataFrameAxis axis, int index)
          Creates a DataFrameAxis from the specified axis and index.
 int getArrayIndex()
          Gets the index of the array dimension that corresponds to this axis.
 
Methods inherited from class anl.aida.data.AxisRange
getAttribute, getAxis, getAxisType, getDescription, getExtent, getName, getOrigin, getRange, getUnits, getValue, getValueAsString, isCompatible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

index

private int index
Constructor Detail

DataFrameAxis

protected DataFrameAxis(CoordAxis axis,
                        int index)
Creates a DataFrameAxis for the specified axis with origin and extent equal to that of the axis.

Parameters:
axis - the axis
index - the array index of this axis

DataFrameAxis

protected DataFrameAxis(CoordAxis axis,
                        int origin,
                        int extent,
                        int index)
Creates a DataFrameAxis for the specified axis with the specified origin and extent.

Parameters:
origin - the origin of the range
extent - the extent of the range
axis - the axis
index - the array index of this axis

DataFrameAxis

protected DataFrameAxis(DataFrameAxis axis,
                        int index)
Creates a DataFrameAxis from the specified axis and index. This DataFrameAxis will have the same origin and extent as the specified axis.

Parameters:
axis - the axis to create this DataFrameAxis from
index - the array index of this axis
Method Detail

createDataFrameAxis

public static DataFrameAxis createDataFrameAxis(CoordAxis axis,
                                                int index)
Creates a DataFrameAxis for the specified axis with origin and extent equal to that of the axis.

Parameters:
axis - the axis
index - the array index of this axis
Returns:
the created DataFrameAxis

createDataFrameAxis

public static DataFrameAxis createDataFrameAxis(CoordAxis axis,
                                                int origin,
                                                int extent,
                                                int index)
Creates a DataFrameAxis for the specified axis with the specified origin and extent.

Parameters:
origin - the origin of the range
extent - the extent of the range
axis - the axis
index - the array index of this axis
Returns:
the create axis.

createDataFrameAxis

public static DataFrameAxis createDataFrameAxis(DataFrameAxis axis,
                                                int index)
Creates a DataFrameAxis from the specified axis and index. This DataFrameAxis will have the same origin and extent as the specified axis.

Parameters:
axis - the axis to create this DataFrameAxis from
index - the array index of this axis
Returns:
the create axis

getArrayIndex

public int getArrayIndex()
Gets the index of the array dimension that corresponds to this axis.

Returns:
the index of the array dimension that corresponds to this axis.