trusty (3) Lire::Report::GroupInfo.3pm.gz

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

NAME
       Lire::Report::GroupInfo - Object that groups columns created by the same aggregator. .


SYNOPSIS
           my $info = $subreport->group_info( 0 );
           print "Group's name: ", $info->name(),   "\n";
           print "Group's columns starts at: ", $info->index(), "\n";


DESCRIPTION
       The Lire::Report::GroupInfo object holds the ColumnInfo objects that were created by the same aggregator.


CONSTRUCTOR
   new( $name )
       You create a new Lire::Report::GroupInfo object by calling the create_group_info() method on one
       Lire::Report::TableInfo object or another Lire::Report::GroupInfo object.


OBJECT METHODS
   name()
       Returns the name of this group. This name can be used to find the aggregator (from the report
       specification) that is responsible for the data held in this group.

   row_idx()
       Returns the row index in which this group's categorical column's labels should be displayed in the table
       header.

   max_row_idx()
   parent_group_info()
       Returns the GroupInfo which contains this GroupInfo. This will be undef for the top-level TableInfo
       object.

   index()
       Returns the column's index in the table at which the columns of this group starts. This will be undef
       until the group info object is added to a Lire::Subreport or another Lire::Group object.

   children()
       Returns as an array, the Lire::Report::ColumnInfo and Lire::Report::GroupInfo objects contained in this
       group.

   info_by_index( $idx )
       Returns the ColumnInfo or GroupInfo that is at index $idx among this GroupInfo children.

   group_children
       Returns as an array, only the Lire::Report::GroupInfo contained in this GroupInfo.

   column_children
       Returns as an array, only the Lire::Report::ColumnInfo contained in this GroupInfo.

   categorical_names()
       Returns the categorical columns' names as an array ref.

   create_column_info( $name, $class, $type, [$label]])
       Creates a new Lire::Report::ColumnInfo object as a child of this GroupInfo. The column info attributes
       are initialized based on $name, $class, $type and $label.

       This will set the index of the ColumnInfo object.

       Returns the created ColumnInfo object.

   create_group_info( $name )
       Create a Lire::Report::GroupInfo which as a child of this group. This will also set the starting column
       index on the GroupInfo object. The $name parameter should contain the name of the report specification
       aggregator that is responsible for the content of this group.

       Returns the created GroupInfo object.

   column_info_by_name( $name )
       Returns the Lire::Report::ColumnInfo object that has the name $name. This method searches in the current
       group as well as in its subgroups.

       Returns undef if the column isn't found.

   column_info_by_col_start( $col_idx )
       Returns the Lire::Report::ColumnInfo object that starts in column index $col_idx. This method searches in
       the current group as well as in its subgroups.

       Returns undef if the column isn't found in the current group.

   group_info( $name )
       Returns the Lire::Report::GroupInfo object that has the name $name.  This will be undef if it cannot be
       found in this group info.


SEE ALSO
       Lire::Report::Subreport(3pm) Lire::Report::ColumnInfo(3pm)


VERSION
       $Id: GroupInfo.pm,v 1.22 2006/07/23 13:16:31 vanbaal Exp $


AUTHOR
       Francis J. Lacoste <flacoste@logreport.org>


       Copyright (C) 2002 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.