---
name: "Lire::Report::GroupInfo"
section: "3pm"
platform: "linux"
package: "lire"
version: "2.1.1-8"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Lire::Report::GroupInfo"
---

# Lire::Report::GroupInfo(3pm)

Object that groups columns created by the same aggregator. .

## 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::Subreport/3pm.md) [**Lire::Report::ColumnInfo**(3pm)](/Lire::Report::ColumnInfo/3pm.md)

## VERSION

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

## AUTHOR

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

## COPYRIGHT

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.