hep.aida.ref.tuple
Class AbstractTuple.AbstractTupleColumnFactory.ITupleTupleColumn

java.lang.Object
  hep.aida.ref.tuple.AbstractTuple.AbstractTupleColumnFactory.BaseTupleColumn
      hep.aida.ref.tuple.AbstractTuple.AbstractTupleColumnFactory.ITupleTupleColumn

All Implemented Interfaces:

IBaseTupleColumn, ITupleColumn, ITupleColumn.ITuple, FTupleColumn

Enclosing class:

AbstractTuple.AbstractTupleColumnFactory

public static class AbstractTuple.AbstractTupleColumnFactory.ITupleTupleColumn
extends AbstractTuple.AbstractTupleColumnFactory.BaseTupleColumn
implements ITupleColumn.ITuple

Nested Class Summary

Nested classes/interfaces inherited from interface hep.aida.ITupleColumn

ITupleColumn.B, ITupleColumn.C, ITupleColumn.D, ITupleColumn.F, ITupleColumn.I, ITupleColumn.ITuple, ITupleColumn.L, ITupleColumn.Object, ITupleColumn.S, ITupleColumn.String, ITupleColumn.Z

Method Summary

ITuple	defaultValue() Get the column default value.
void	fill(ITuple value) Fill the column.
ITuple	fillableObject() Used when filling.
Class	type() Get the type of a give column.
ITuple	value() Get the object stored in the column at the current cursor's position.

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

defaultValue, hasDefaultValue, maximum, maxValue, mean, meanValue, minimum, minValue, name, rms, rmsValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface hep.aida.IBaseTupleColumn

maximum, mean, minimum, name, rms

Method Detail

type

public Class type()

Description copied from interface: IBaseTupleColumn

Get the type of a give column.

Specified by:

type in interface IBaseTupleColumn

Specified by:

type in interface FTupleColumn

Overrides:

type in class AbstractTuple.AbstractTupleColumnFactory.BaseTupleColumn

Returns:

The column's Class.

fill

public void fill(ITuple value)
          throws IllegalArgumentException

Description copied from interface: ITupleColumn.ITuple

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

Specified by:

fill in interface ITupleColumn.ITuple

Parameters:

value - The base type or object to fill with.

Throws:

IllegalArgumentException

value

public ITuple value()

Description copied from interface: ITupleColumn.ITuple

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

Specified by:

value in interface ITupleColumn.ITuple

Returns:

The object.

defaultValue

public ITuple defaultValue()

Description copied from interface: ITupleColumn.ITuple

Get the column default value.

Specified by:

defaultValue in interface ITupleColumn.ITuple

Returns:

The column's default.

fillableObject

public ITuple fillableObject()

Description copied from interface: ITupleColumn.ITuple

Used when filling. This method returns a prebooked (in general empty) object. This is intended to help the filling of a tuple in case of dealing with complex objects. Reissuing the method after a ITuple::addRow may return the same object but reseted. This method may return zero in case the implementation don't have the necessary material to provide a prebooked object of any kind. In case the column contains tuples (T = ITuple), this methods returns an empty tuple booked according to what had been specified at creation of the main tuple. In case the tuple column is binded to a user variable (done through the bind method), this method returns the pointer passed to the bind method. The user must not delete the returned object.

Specified by:

fillableObject in interface ITupleColumn.ITuple

Returns:

An object.