Provided by: lire-devel-doc_2.1.1-2.1_all bug

NAME

       Lire::Config::VariableIndex - Index of the available variables in a TableInfo

SYNOPSIS

         <lrcsml:reference name="name" index="categorical_variables" />
         <lrcsml:reference name="name" index="numerical_variables" />
         <lrcsml:reference name="name" index="variables" />

DESCRIPTION

       This object make it possible to select a variable defined in a TableInfo (usually created
       from a Lire::ReportSpec or coming from a Lire::Report object).

   new( $table_info, [ $type ] )
       Creates a new VariableIndex which wraps the $table_info Lire::Report::TableInfo object.
       The $type parameter can be either 'both', 'categorical' or 'numerical' depending on the
       kind of variables one wants to select. Default to 'both'.

   table_info()
       Returns the Lire::Report::TableInfo object wrapped by this Index.

   type()
       Returns the type attribute.

SEE ALSO

        Lire::ReportSpec(3pm) Lire::Report::TableInfo(3pm) Lire:Config::Index(3pm)

AUTHOR

         Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: VariableIndex.pm,v 1.3 2006/07/23 13:16:31 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       Lire is free software; you can redistribute it and/or modify it under the terms of the GNU
       General Public License as published by the Free Software Foundation; either version 2 of
       the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
       without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
       See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program
       (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.