// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition          
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it. 
// =========================================================================

//  This file is part of the AIDA library
//  Copyright (C) 2002 by the AIDA team.  All rights reserved.
//  This library is free software and under the terms of the
//  GNU Library General Public License described in the LGPL.txt 
package hep.aida;


/**
 * User level interface to a Tuple column.
 *
 * @author The AIDA team (http://aida.freehep.org/)
 *
 */

public abstract interface ITupleColumn extends IBaseTupleColumn {

    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface Z extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(boolean value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public boolean value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public boolean defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public boolean fillableObject();
    } //ITupleColumn.Z


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface F extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(float value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public float value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public float defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public float fillableObject();
    } //ITupleColumn.F


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface D extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(double value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public double value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public double defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public double fillableObject();
    } //ITupleColumn.D


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface B extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(byte value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public byte value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public byte defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public byte fillableObject();
    } //ITupleColumn.B


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface S extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(short value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public short value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public short defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public short fillableObject();
    } //ITupleColumn.S


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface I extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(int value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public int value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public int defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public int fillableObject();
    } //ITupleColumn.I


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface L extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(long value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public long value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public long defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public long fillableObject();
    } //ITupleColumn.L


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface C extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(char value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public char value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public char defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public char fillableObject();
    } //ITupleColumn.C


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface String extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(java.lang.String value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public java.lang.String value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public java.lang.String defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public java.lang.String fillableObject();
    } //ITupleColumn.String


    /**
    /* Template Instantiated Interface: ITupleColumn
    */
    public static interface ITuple extends ITupleColumn {

        /**
         * 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.
         * @param value  The base type or object to fill with.
         *
         */
        public void fill(hep.aida.ITuple value) throws IllegalArgumentException;

        /**
         * Get the object stored in the column 
         * at the current cursor's position.
         * @return       The object.
         *
         */
        public hep.aida.ITuple value();

       /** 
        * Get the column default value.
        * @return       The column's default.
        *
        */
        public hep.aida.ITuple defaultValue();

       /** 
        * 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.
        *
        * @return       An object.
        *
        */
        public hep.aida.ITuple fillableObject();
    } //ITupleColumn.ITuple


    /**
    /* Template Instantiated Interface: ITupleColumn