hep.aida.ref.tuple
Class AbstractTuple

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ReadOnlyAbstractTuple, Tuple

public abstract class AbstractTuple
extends ManagedObject
implements ITuple, FTuple

Base class for Tuple, ChainedTuple etc. This implements all methods which modify the tuple to throw exceptions.

Nested Class Summary

static class

AbstractTuple.AbstractTupleColumnFactory

Field Summary

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

ROWS_UNKNOWN

Constructor Summary

AbstractTuple(String name, String options)

AbstractTuple(String name, String title, String options)

Method Summary

abstract void	addRow() Add the current row to the ITuple.
IAnnotation	annotation() Get the IAnnotation corresponding to this ITuple.
IBaseTupleColumn	column(int index) Return a IBaseTupleColumn knowing its index.
IBaseTupleColumn	column(String name) Return a IBaseTupleColumn knowing its name.
FTupleColumn	columnByIndex(int index)
FTupleColumn	columnByName(String name)
abstract String	columnDefaultString(int column)
Object	columnDefaultValue(int column) Get the column default.
abstract double	columnMax(int index) Get the maximum value of a given column (if it can be converted to a double).
abstract double	columnMean(int index) Get the mean value of a given column (if it can be converted to a double).
abstract double	columnMin(int index) Get the minimum value of a given column (if it can be converted to a double).
abstract String	columnName(int index) Get the name of a column from its index.
String[]	columnNames() Get the names of all the columns.
abstract double	columnRms(int index) Get the RMS of a given column (if it can be converted to a double).
abstract int	columns() Get the number of columns in the ITuple
abstract Class	columnType(int index) Get the type of a give column.
Class[]	columnTypes() Get the types of all the columns.
void	columnValue(int index, FTupleCursor c, org.freehep.util.Value v)
abstract void	columnValue(int param, org.freehep.util.Value value)
FTupleCursor	cursor()
double	evaluateMax(IEvaluator evaluator) Get the maximum of an evaulation.
double	evaluateMax(IEvaluator evaluator, IFilter filter) Get the maximum of an evaulation.
double	evaluateMin(IEvaluator evaluator) Get the minimum of an evaulation.
double	evaluateMin(IEvaluator evaluator, IFilter filter) Get the minimum of an evaulation.
void	fill(double[] values) Fill all the columns at once with doubles.
void	fill(float[] values) Fill all the columns at once with floats.
void	fill(int index, boolean value) Fill a given column with a boolean.
void	fill(int index, byte value) Fill a given column with a byte.
void	fill(int index, char value) Fill a given column with a char.
void	fill(int index, double value) Fill a given column with a double.
void	fill(int index, float value) Fill a given column with a float.
void	fill(int index, int value) Fill a given column with an integer.
void	fill(int index, long value) Fill a given column with a long.
void	fill(int index, Object obj) Fill a given column with an object.
void	fill(int index, short value) Fill a given column with a short.
void	fill(int index, String str) Fill a given column with a string.
abstract void	fill(int param, org.freehep.util.Value value)
abstract int	findColumn(String str) Get the index within the ITuple of a given column.
abstract ITuple	findTuple(int index) Return method for tuple variables of type ITuple for a given column.
boolean	getBoolean(int index) Get the boolean stored in a given column at the current cursor's position.
byte	getByte(int index) Get the byte stored in a given column at the current cursor's position.
char	getChar(int index) Get the character stored in a given column at the current cursor's position.
double	getDouble(int index) Get the double stored in a given column at the current cursor's position.
float	getFloat(int index) Get the float stored in a given column at the current cursor's position.
int	getInt(int index) Get the integer stored in a given column at the current cursor's position.
long	getLong(int index) Get the long stored in a given column at the current cursor's position.
Object	getObject(int index) Get the object stored in a given column at the current cursor's position.
String	getOptions()
int	getRow()
short	getShort(int index) Get the short stored in a given column at the current cursor's position.
String	getString(int index) Get the string stored in a given column at the current cursor's position.
ITuple	getTuple(int col) Return method for tuple variables of type ITuple for a given column.
boolean	isInMemory()
void	newInternalCursor()
boolean	next() Positions the cursor at the next row.
void	project(ICloud1D cloud, IEvaluator evaluator) Fill an ICloud1D from the tuple.
void	project(ICloud1D cloud, IEvaluator evaluator, IEvaluator weightEvaluator) Fill an ICloud1D from the tuple.
void	project(ICloud1D cloud, IEvaluator evaluator, IFilter filter) Fill an ICloud1D from the tuple.
void	project(ICloud1D cloud, IEvaluator evaluator, IFilter filter, IEvaluator weightEvaluator) Fill an ICloud1D from the tuple.
void	project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY) Fill an ICloud2D from the tuple.
void	project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weightEvaluator) Fill an ICloud2D from the tuple.
void	project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter) Fill an ICloud2D from the tuple.
void	project(ICloud2D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weightEvaluator) Fill an ICloud2D from the tuple.
void	project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ) Fill an ICloud3D from the tuple.
void	project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weightEvaluator) Fill an ICloud3D from the tuple.
void	project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter) Fill an ICloud3D from the tuple.
void	project(ICloud3D cloud, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weightEvaluator) Fill an ICloud3D from the tuple.
void	project(IHistogram1D histogram, IEvaluator evaluator) Fill an IHistogram1D from the tuple.
void	project(IHistogram1D histogram, IEvaluator evaluator, IEvaluator weightEvaluator) Fill an IHistogram1D from the tuple.
void	project(IHistogram1D histogram, IEvaluator evaluator, IFilter filter) Fill an IHistogram1D from the tuple.
void	project(IHistogram1D histogram, IEvaluator evaluator, IFilter filter, IEvaluator weightEvaluator) Fill an IHistogram1D from the tuple.
void	project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY) Fill an IHistogram2D from the tuple.
void	project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weightEvaluator) Fill an IHistogram2D from the tuple.
void	project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter) Fill an IHistogram2D from the tuple.
void	project(IHistogram2D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weightEvaluator) Fill an IHistogram2D from the tuple.
void	project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ) Fill an IHistogram3D from the tuple.
void	project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weightEvaluator) Fill an IHistogram3D from the tuple.
void	project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter) Fill an IHistogram3D from the tuple.
void	project(IHistogram3D histogram, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weightEvaluator) Fill an IHistogram3D from the tuple.
void	project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY) Fill an IProfile1D from the tuple.
void	project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator weightEvaluator) Fill an IProfile1D from the tuple.
void	project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter) Fill an IProfile1D from the tuple.
void	project(IProfile1D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IFilter filter, IEvaluator weightEvaluator) Fill an IProfile1D from the tuple.
void	project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ) Fill an IProfile2D from the tuple.
void	project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IEvaluator weightEvaluator) Fill an IProfile2D from the tuple.
void	project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter) Fill an IProfile2D from the tuple.
void	project(IProfile2D profile, IEvaluator evaluatorX, IEvaluator evaluatorY, IEvaluator evaluatorZ, IFilter filter, IEvaluator weightEvaluator) Fill an IProfile2D from the tuple.
boolean	providesColumnDefaultValues()
abstract void	reset() Reset the ITuple.
abstract void	resetRow() Clear the current(not yet added) row.
abstract int	rows() Get the number of rows currently filled in the ITuple.
void	setAnnotation(IAnnotation annotation)
void	setRow(int row) Position the cursor at a give row.
void	setTitle(String title) Set the title of the ITuple.
void	skip(int rows) Skips a given number of rows.
void	start() Positions the read cursor immediately before the first row.
boolean	supportsMultipleCursors()
boolean	supportsRandomAccess()
String	title() Get the title of this ITuple.
FTuple	tuple(int index)

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

AbstractTuple

public AbstractTuple(String name,
                     String options)

AbstractTuple

public AbstractTuple(String name,
                     String title,
                     String options)

Method Detail

columnMax

public abstract double columnMax(int index)
                          throws IllegalArgumentException

Description copied from interface: ITuple

Get the maximum value of a given column (if it can be converted to a double).

Specified by:

columnMax in interface ITuple

Parameters:

index - The column's index.

Returns:

The column's maximum value. In Java Double.NaN might be returned.

Throws:

IllegalArgumentException - For a wrong column's index.

columnMean

public abstract double columnMean(int index)
                           throws IllegalArgumentException

Description copied from interface: ITuple

Get the mean value of a given column (if it can be converted to a double).

Specified by:

columnMean in interface ITuple

Parameters:

index - The column's index.

Returns:

The column's mean value. In Java Double.NaN might be returned.

Throws:

IllegalArgumentException - For a wrong column's index.

columnMin

public abstract double columnMin(int index)
                          throws IllegalArgumentException

Description copied from interface: ITuple

Get the minimum value of a given column (if it can be converted to a double).

Specified by:

columnMin in interface ITuple

Parameters:

index - The column's index.

Returns:

The column's minimum value. In Java Double.NaN might be returned.

Throws:

IllegalArgumentException - For a wrong column's index.

columnName

public abstract String columnName(int index)
                           throws IllegalArgumentException

Description copied from interface: ITuple

Get the name of a column from its index.

Specified by:

columnName in interface ITuple

Specified by:

columnName in interface FTuple

Parameters:

index - The column's index.

Returns:

The column's name.

Throws:

IllegalArgumentException - For a wrong column's index.

columnRms

public abstract double columnRms(int index)
                          throws IllegalArgumentException

Description copied from interface: ITuple

Get the RMS of a given column (if it can be converted to a double).

Specified by:

columnRms in interface ITuple

Parameters:

index - The column's index.

Returns:

The column's RMS. In Java Double.NaN might be returned.

Throws:

IllegalArgumentException - For a wrong column's index.

columnType

public abstract Class columnType(int index)
                          throws IllegalArgumentException

Description copied from interface: ITuple

Get the type of a give column.

Specified by:

columnType in interface ITuple

Specified by:

columnType in interface FTuple

Parameters:

index - The column's index.

Returns:

The column's Class.

Throws:

IllegalArgumentException - For a wrong column's index.

columns

public abstract int columns()

Description copied from interface: ITuple

Get the number of columns in the ITuple

Specified by:

columns in interface ITuple

Specified by:

columns in interface FTuple

Returns:

The number of columns.

columnDefaultString

public abstract String columnDefaultString(int column)

addRow

public abstract void addRow()
                     throws OutOfStorageException

Description copied from interface: ITuple

Add the current row to the ITuple. This method should be called after fill has been called for the columns; unfilled columns will be filled with their default value.

Specified by:

addRow in interface ITuple

Throws:

OutOfStorageException - When the ITuple runs out of storage space.

findColumn

public abstract int findColumn(String str)
                        throws IllegalArgumentException

Description copied from interface: ITuple

Get the index within the ITuple of a given column.

Specified by:

findColumn in interface ITuple

Parameters:

str - The colum's name.

Returns:

The corresponding column's index. Note: in C++ -1 may be returned if the column does not exist.

Throws:

IllegalArgumentException

findTuple

public abstract ITuple findTuple(int index)

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

Parameters:

index - The column's index.

Returns:

The ITuple representing the structure of this column.

rows

public abstract int rows()

Description copied from interface: ITuple

Get the number of rows currently filled in the ITuple.

Specified by:

rows in interface ITuple

Specified by:

rows in interface FTuple

Returns:

The number of rows. -1 if empty or if it cannot be determined.

reset

public abstract void reset()

Description copied from interface: ITuple

Reset the ITuple. All the rows are reset. The ITuple is as just created.

Specified by:

reset in interface ITuple

resetRow

public abstract void resetRow()

Description copied from interface: ITuple

Clear the current(not yet added) row.

Specified by:

resetRow in interface ITuple

columnValue

public abstract void columnValue(int param,
                                 org.freehep.util.Value value)

fill

public abstract void fill(int param,
                          org.freehep.util.Value value)

tuple

public FTuple tuple(int index)

Specified by:

tuple in interface FTuple

isInMemory

public boolean isInMemory()

Specified by:

isInMemory in interface FTuple

providesColumnDefaultValues

public boolean providesColumnDefaultValues()

supportsMultipleCursors

public boolean supportsMultipleCursors()

Specified by:

supportsMultipleCursors in interface FTuple

supportsRandomAccess

public boolean supportsRandomAccess()

Specified by:

supportsRandomAccess in interface FTuple

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

Parameters:

column - The column's index.

Returns:

The column's default.

getOptions

public String getOptions()

cursor

public FTupleCursor cursor()

Specified by:

cursor in interface FTuple

newInternalCursor

public void newInternalCursor()

setRow

public void setRow(int row)

Description copied from interface: ITuple

Position the cursor at a give row.

Specified by:

setRow in interface ITuple

Parameters:

row - The row where the cursor has to be positioned.

start

public void start()

Description copied from interface: ITuple

Positions the read cursor immediately before the first row.

Specified by:

start in interface ITuple

skip

public void skip(int rows)

Description copied from interface: ITuple

Skips a given number of rows.

Specified by:

skip in interface ITuple

Parameters:

rows - The number of rows to skip.

next

public boolean next()

Description copied from interface: ITuple

Positions the cursor at the next row.

Specified by:

next in interface ITuple

Returns:

false if there is no next row.

getRow

public int getRow()

columnValue

public void columnValue(int index,
                        FTupleCursor c,
                        org.freehep.util.Value v)

Specified by:

columnValue in interface FTuple

getBoolean

public boolean getBoolean(int index)
                   throws ClassCastException

Description copied from interface: ITuple

Get the boolean stored in a given column at the current cursor's position.

Specified by:

getBoolean in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The boolean.

Throws:

ClassCastException - If there is a mismatch of types.

getByte

public byte getByte(int index)
             throws ClassCastException

Description copied from interface: ITuple

Get the byte stored in a given column at the current cursor's position.

Specified by:

getByte in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The byte.

Throws:

ClassCastException - If there is a mismatch of types.

getChar

public char getChar(int index)
             throws ClassCastException

Description copied from interface: ITuple

Get the character stored in a given column at the current cursor's position.

Specified by:

getChar in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The character.

Throws:

ClassCastException - If there is a mismatch of types.

getDouble

public double getDouble(int index)
                 throws ClassCastException

Description copied from interface: ITuple

Get the double stored in a given column at the current cursor's position.

Specified by:

getDouble in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The double.

Throws:

ClassCastException - If there is a mismatch of types.

getFloat

public float getFloat(int index)
               throws ClassCastException

Description copied from interface: ITuple

Get the float stored in a given column at the current cursor's position.

Specified by:

getFloat in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The float.

Throws:

ClassCastException - If there is a mismatch of types.

getInt

public int getInt(int index)
           throws ClassCastException

Description copied from interface: ITuple

Get the integer stored in a given column at the current cursor's position.

Specified by:

getInt in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The integer.

Throws:

ClassCastException - If there is a mismatch of types.

getLong

public long getLong(int index)
             throws ClassCastException

Description copied from interface: ITuple

Get the long stored in a given column at the current cursor's position.

Specified by:

getLong in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The long.

Throws:

ClassCastException - If there is a mismatch of types.

getObject

public Object getObject(int index)
                 throws ClassCastException

Description copied from interface: ITuple

Get the object stored in a given column at the current cursor's position.

Specified by:

getObject in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The object.

Throws:

ClassCastException - If there is a mismatch of types.

getShort

public short getShort(int index)
               throws ClassCastException

Description copied from interface: ITuple

Get the short stored in a given column at the current cursor's position.

Specified by:

getShort in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The short.

Throws:

ClassCastException - If there is a mismatch of types.

getString

public String getString(int index)
                 throws ClassCastException

Description copied from interface: ITuple

Get the string stored in a given column at the current cursor's position.

Specified by:

getString in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The string.

Throws:

ClassCastException - If there is a mismatch of types.

fill

public void fill(double[] values)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill all the columns at once with doubles.

Specified by:

fill in interface ITuple

Parameters:

values - The array of doubles.

Throws:

IllegalArgumentException - If any column is not of type double or if the array has the wrong dimension.

fill

public void fill(float[] values)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill all the columns at once with floats.

Specified by:

fill in interface ITuple

Parameters:

values - The array of floats.

Throws:

IllegalArgumentException - If any column is not of type float or if the array has the wrong dimension.

fill

public void fill(int index,
                 boolean value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a boolean.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The boolean.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 byte value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a byte.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The byte.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 char value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a char.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The char.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 double value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a double. If the value is NaN the entry will be recorded but it will not contribue to the column's statistics.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The double.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 float value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a float. If the value is NaN the entry will be recorded but it will not contribue to the column's statistics.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The float.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 int value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with an integer.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The integer.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 Object obj)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with an object.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

obj - The object.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 String str)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a string.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

str - The string.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 long value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a long.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The long.

Throws:

IllegalArgumentException - If the column is of the wrong type.

fill

public void fill(int index,
                 short value)
          throws IllegalArgumentException

Description copied from interface: ITuple

Fill a given column with a short.

Specified by:

fill in interface ITuple

Parameters:

index - The column's index within the ITuple.

value - The short.

Throws:

IllegalArgumentException - If the column is of the wrong type.

columnNames

public String[] columnNames()

Description copied from interface: ITuple

Get the names of all the columns.

Specified by:

columnNames in interface ITuple

Returns:

The column names.

columnTypes

public Class[] columnTypes()

Description copied from interface: ITuple

Get the types of all the columns.

Specified by:

columnTypes in interface ITuple

Returns:

The column Classes.

title

public String title()

Description copied from interface: ITuple

Get the title of this ITuple.

Specified by:

title in interface ITuple

Specified by:

title in interface FTuple

Returns:

The ITuple's title.

setTitle

public void setTitle(String title)

Description copied from interface: ITuple

Set the title of the ITuple.

Specified by:

setTitle in interface ITuple

Parameters:

title - The new ITuple's title.

annotation

public IAnnotation annotation()

Description copied from interface: ITuple

Get the IAnnotation corresponding to this ITuple.

Specified by:

annotation in interface ITuple

Returns:

The ITuple's IAnnotation.

setAnnotation

public void setAnnotation(IAnnotation annotation)

getTuple

public ITuple getTuple(int col)

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:

getTuple in interface ITuple

Parameters:

col - The column's index.

Returns:

The ITuple representing the structure of this column.

column

public IBaseTupleColumn column(int index)

Description copied from interface: ITuple

Return a IBaseTupleColumn knowing its index.

Specified by:

column in interface ITuple

Parameters:

index - The column's index within the ITuple.

Returns:

The IBaseTupleColumn. In C++, return 0 if not found.

column

public IBaseTupleColumn column(String name)

Description copied from interface: ITuple

Return a IBaseTupleColumn knowing its name.

Specified by:

column in interface ITuple

Parameters:

name - The colum's name.

Returns:

The IBaseTupleColumn. In C++, return 0 if not found.

columnByIndex

public FTupleColumn columnByIndex(int index)

Specified by:

columnByIndex in interface FTuple

columnByName

public FTupleColumn columnByName(String name)

Specified by:

columnByName in interface FTuple

evaluateMin

public double evaluateMin(IEvaluator evaluator)
                   throws IllegalArgumentException

Description copied from interface: ITuple

Get the minimum of an evaulation. Usefull to guess histogram booking.

Specified by:

evaluateMin in interface ITuple

Parameters:

evaluator - The evaluator used to compute the value to take min.

Throws:

IllegalArgumentException - If something goes wrong.

evaluateMin

public double evaluateMin(IEvaluator evaluator,
                          IFilter filter)
                   throws IllegalArgumentException

Description copied from interface: ITuple

Get the minimum of an evaulation. Usefull to guess histogram booking.

Specified by:

evaluateMin in interface ITuple

Parameters:

evaluator - The evaluator used to compute the value to take min.

filter - The filter object used to accept or not the current row.

Throws:

IllegalArgumentException - If something goes wrong.

evaluateMax

public double evaluateMax(IEvaluator evaluator)
                   throws IllegalArgumentException

Description copied from interface: ITuple

Get the maximum of an evaulation. Usefull to guess histogram booking.

Specified by:

evaluateMax in interface ITuple

Parameters:

evaluator - The evaluator used to compute the value to take max.

Throws:

IllegalArgumentException - If something goes wrong.

evaluateMax

public double evaluateMax(IEvaluator evaluator,
                          IFilter filter)
                   throws IllegalArgumentException

Description copied from interface: ITuple

Get the maximum of an evaulation. Usefull to guess histogram booking.

Specified by:

evaluateMax in interface ITuple

Parameters:

evaluator - The evaluator used to compute the value to take max.

filter - The filter object used to accept or not the current row.

Throws:

IllegalArgumentException - If something goes wrong.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluator)

Description copied from interface: ITuple

Fill an IHistogram1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluator - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluator,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluator - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluator,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluator - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IHistogram1D histogram,
                    IEvaluator evaluator,
                    IFilter filter)

Description copied from interface: ITuple

Fill an IHistogram1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluator - The evaluator used to compute the value to be filled in the histogram. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)

Description copied from interface: ITuple

Fill an IHistogram2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)

Description copied from interface: ITuple

Fill an IHistogram2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IHistogram2D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)

Description copied from interface: ITuple

Fill an IHistogram3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)

Description copied from interface: ITuple

Fill an IHistogram3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IHistogram3D histogram,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IHistogram3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

histogram - The histogram to fill.

evaluatorX - The evaluator used to compute the value to be filled in the histogram along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the histogram along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the histogram along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the histogram is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluator)

Description copied from interface: ITuple

Fill an ICloud1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluator - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluator,
                    IFilter filter)

Description copied from interface: ITuple

Fill an ICloud1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluator - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluator,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluator - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud1D cloud,
                    IEvaluator evaluator,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluator - The evaluator used to compute the value to be filled in the cloud. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)

Description copied from interface: ITuple

Fill an ICloud2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)

Description copied from interface: ITuple

Fill an ICloud2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

project

public void project(ICloud2D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)

Description copied from interface: ITuple

Fill an ICloud3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)

Description copied from interface: ITuple

Fill an ICloud3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(ICloud3D cloud,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an ICloud3D from the tuple.

Specified by:

project in interface ITuple

Parameters:

cloud - The cloud to fill.

evaluatorX - The evaluator used to compute the value to be filled in the cloud along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the cloud along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the cloud along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the cloud is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY)

Description copied from interface: ITuple

Fill an IProfile1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter)

Description copied from interface: ITuple

Fill an IProfile1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IProfile1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IProfile1D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IProfile1D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ)

Description copied from interface: ITuple

Fill an IProfile2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IProfile2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.

weightEvaluator - The evaluator which determines the weight which is used during the filling.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter)

Description copied from interface: ITuple

Fill an IProfile2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.

project

public void project(IProfile2D profile,
                    IEvaluator evaluatorX,
                    IEvaluator evaluatorY,
                    IEvaluator evaluatorZ,
                    IFilter filter,
                    IEvaluator weightEvaluator)

Description copied from interface: ITuple

Fill an IProfile2D from the tuple.

Specified by:

project in interface ITuple

Parameters:

profile - The profile to fill.

evaluatorX - The evaluator used to compute the value to be filled in the profile along the x axis. The value is computed from the current row of the tuple.

evaluatorY - The evaluator used to compute the value to be filled in the profile along the y axis. The value is computed from the current row of the tuple.

evaluatorZ - The evaluator used to compute the value to be filled in the profile along the z axis. The value is computed from the current row of the tuple.

filter - The filter object used to accept or not the current row. If rejected, the profile is not filled.

weightEvaluator - The evaluator which determines the weight which is used during the filling.