hep.aida.ref.tuple
Class ChainedTuple

java.lang.Object
  hep.aida.ref.event.AIDAObservable
      hep.aida.ref.ManagedObject
          hep.aida.ref.tuple.AbstractTuple
              hep.aida.ref.tuple.ReadOnlyAbstractTuple
                  hep.aida.ref.tuple.ChainedTuple

All Implemented Interfaces:

hep.aida.dev.IDevManagedObject, IManagedObject, ITuple, Connectable, FTuple

public class ChainedTuple
extends ReadOnlyAbstractTuple

Nested Class Summary

Nested classes/interfaces inherited from class hep.aida.ref.tuple.AbstractTuple

AbstractTuple.AbstractTupleColumnFactory

Field Summary

Fields inherited from interface hep.aida.ref.tuple.FTuple

ROWS_UNKNOWN

Constructor Summary

ChainedTuple(String name, String title, ITuple[] set)
Tuple constructor.

Method Summary

String	columnDefaultString(int column)
Object	columnDefaultValue(int column) Get the column default.
double	columnMax(int column) Get the maximum value of a column.
double	columnMean(int column) Get the mean value of a column.
double	columnMin(int column) Get the minimum value of a column.
String	columnName(int column) Get the name of a column from its index
double	columnRms(int column) Get the rms of a column.
int	columns() Get the number of columns in the Tuple.
Class	columnType(int column) Get the type of the column from its index
void	columnValue(int column, org.freehep.util.Value v)
int	findColumn(String name) Convert a name to a column index.
ITuple	findTuple(int column) Return method for tuple variables of type ITuple for a given column.
int	getRow() Get the current row.
boolean	isInMemory()
boolean	next() Positions the cursor at the next row.
boolean	providesColumnDefaultValues()
int	rows() The number of rows currently in the ntuple.
void	setRow(int row) Set the current row.
void	skip(int rows) Skips rows.
void	start() Positions the read cursor immediately before the first row.
boolean	supportsMultipleCursors()
boolean	supportsRandomAccess()

Methods inherited from class hep.aida.ref.tuple.ReadOnlyAbstractTuple

addRow, fill, reset, resetRow

Methods inherited from class hep.aida.ref.tuple.AbstractTuple

annotation, column, column, columnByIndex, columnByName, columnNames, columnTypes, columnValue, cursor, evaluateMax, evaluateMax, evaluateMin, evaluateMin, fill, fill, fill, fill, fill, fill, fill, fill, fill, fill, fill, fill, getBoolean, getByte, getChar, getDouble, getFloat, getInt, getLong, getObject, getOptions, getShort, getString, getTuple, newInternalCursor, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, project, setAnnotation, setTitle, title, tuple

Methods inherited from class hep.aida.ref.ManagedObject

isFillable, name, setFillable, setName, type, typeForClass

Methods inherited from class hep.aida.ref.event.AIDAObservable

addListener, isConnected, removeAllListeners, removeListener, setConnected, setValid, setValidForAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface hep.aida.ref.tuple.FTuple

name

Methods inherited from interface hep.aida.ref.event.Connectable

isConnected, setConnected

Constructor Detail

ChainedTuple

public ChainedTuple(String name,
                    String title,
                    ITuple[] set)

Tuple constructor.

Parameters:

name - the Tuple's name

title - the Tuple's title

set - Array of ITuples to be chained

Method Detail

supportsRandomAccess

public boolean supportsRandomAccess()

Specified by:

supportsRandomAccess in interface FTuple

Overrides:

supportsRandomAccess in class AbstractTuple

supportsMultipleCursors

public boolean supportsMultipleCursors()

Specified by:

supportsMultipleCursors in interface FTuple

Overrides:

supportsMultipleCursors in class AbstractTuple

isInMemory

public boolean isInMemory()

Specified by:

isInMemory in interface FTuple

Overrides:

isInMemory in class AbstractTuple

providesColumnDefaultValues

public boolean providesColumnDefaultValues()

Overrides:

providesColumnDefaultValues in class AbstractTuple

columnValue

public void columnValue(int column,
                        org.freehep.util.Value v)

Specified by:

columnValue in class AbstractTuple

columnDefaultString

public String columnDefaultString(int column)

Specified by:

columnDefaultString in class AbstractTuple

columns

public int columns()

Get the number of columns in the Tuple.

Specified by:

columns in interface ITuple

Specified by:

columns in interface FTuple

Specified by:

columns in class AbstractTuple

Returns:

the number of columns in the Tuple

columnName

public String columnName(int column)

Get the name of a column from its index

Specified by:

columnName in interface ITuple

Specified by:

columnName in interface FTuple

Specified by:

columnName in class AbstractTuple

Parameters:

column - the column's index

Returns:

the column's name

columnType

public Class columnType(int column)

Get the type of the column from its index

Specified by:

columnType in interface ITuple

Specified by:

columnType in interface FTuple

Specified by:

columnType in class AbstractTuple

Parameters:

column - the column's index

Returns:

the column's type

columnMin

public double columnMin(int column)

Get the minimum value of a column.

Specified by:

columnMin in interface ITuple

Specified by:

columnMin in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The minimum value of the column. If the minimum cannot be calculated Double.NaN is returned.

columnMax

public double columnMax(int column)

Get the maximum value of a column.

Specified by:

columnMax in interface ITuple

Specified by:

columnMax in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The maximum value of the column. If the maximum cannot be calculated Double.NaN is returned.

columnMean

public double columnMean(int column)

Get the mean value of a column.

Specified by:

columnMean in interface ITuple

Specified by:

columnMean in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The mean value of the column. If the mean cannot be calculated Double.NaN is returned.

columnRms

public double columnRms(int column)

Get the rms of a column.

Specified by:

columnRms in interface ITuple

Specified by:

columnRms in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The rms of the column. If the rms cannot be calculated Double.NaN is returned.

rows

public int rows()

The number of rows currently in the ntuple.

Specified by:

rows in interface ITuple

Specified by:

rows in interface FTuple

Specified by:

rows in class AbstractTuple

Returns:

-1 if cannot be determined.

getRow

public int getRow()

Get the current row.

Overrides:

getRow in class AbstractTuple

Returns:

The current row;

findTuple

public ITuple findTuple(int column)

Description copied from interface: ITuple

Return method for tuple variables of type ITuple for a given column. This method can be used in order to fill a tuple variable in the master tuple.

Specified by:

findTuple in interface ITuple

Specified by:

findTuple in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The ITuple representing the structure of this column.

setRow

public void setRow(int row)

Set the current row.

Specified by:

setRow in interface ITuple

Overrides:

setRow in class AbstractTuple

Parameters:

row - The current row;

start

public void start()

Positions the read cursor immediately before the first row.

Specified by:

start in interface ITuple

Overrides:

start in class AbstractTuple

skip

public void skip(int rows)

Skips rows.

Specified by:

skip in interface ITuple

Overrides:

skip in class AbstractTuple

Parameters:

rows - number of rows to skip, greater than 0.

next

public boolean next()

Positions the cursor at the next row.

Specified by:

next in interface ITuple

Overrides:

next in class AbstractTuple

Returns:

false if there is no next row.

findColumn

public int findColumn(String name)
               throws IllegalArgumentException

Convert a name to a column index. Note: C++ version may return -1 if column not found

Specified by:

findColumn in interface ITuple

Specified by:

findColumn in class AbstractTuple

Parameters:

name - The colum's name.

Returns:

the column number for a given name

Throws:

IllegalArgumentException

columnDefaultValue

public Object columnDefaultValue(int column)

Description copied from interface: ITuple

Get the column default. For primitive types (int, double, ...) their respective class is returned (Int, Double, ...)

Specified by:

columnDefaultValue in interface ITuple

Overrides:

columnDefaultValue in class AbstractTuple

Parameters:

column - The column's index.

Returns:

The column's default.