NAME

Class::DBI::ColumnGrouper - Columns and Column Groups

SYNOPSIS

my $colg = Class::DBI::ColumnGrouper->new;
   $colg->add_group(People => qw/star director producer/);

my @cols = $colg->group_cols($group);

my @all            = $colg->all_columns;
my @pri_col        = $colg->primary;
my @essential_cols = $colg->essential;

DESCRIPTION

Each Class::DBI class maintains a list of its columns as class data. This provides an interface to that. You probably don't want to be dealing with this directly.

METHODS

new

my $colg = Class::DBI::ColumnGrouper->new;

A new blank ColumnnGrouper object.

add_group

$colg->add_group(People => qw/star director producer/);

This adds a list of columns as a column group.

column

my Class::DBI::Column $col = $cols->column($name);

Return a Column object for the given column name.

group_cols

my @colg = $cols->group_cols($group);

This returns a list of all columns which are in the given group.

all_columns

my @all = $colg->all_columns;

This returns a list of all the real columns.

primary

my $pri_col = $colg->primary;

This returns a list of the columns in the Primary group.

essential

my @essential_cols = $colg->essential;

This returns a list of the columns in the Essential group.