NAME

LRpt::RKeysRdr - a module for reading definitions of row keys

DESCRIPTION

This class is a part of LRpt library. Object of this class provides an easy interface row keys definition files.

METHODS

In this sections you will find a more or less complete listing of all methods provided by the package. Note that the package itself is not public so none of those methods are guaranteed to be maintained in future (including the package itself).

new

  my $rkr = LRpt::RKeysRdr->new( fname    => $fname,
                                 string   => $string );

Constructor. Meaning of parameters:

fname

Name of a file containing definitions of row keys

string

Definition of a row keys given as one string. This feature is experimantal and you better don't use it.

initialize_keys

  $rkr->initialize_keys( $fname, $string );

Called by the contructor to perform initialization. Meaning of parameters:

$fname

Name of a file containing definitions of row keys

$string

Definition of a row keys given as one string. This feature is experimantal and you better don't use it.

scan_keys_from_cmd

  $rkr->scan_keys_from_cmd( $string );

Scans row key definition given in the command line. If nothing is given, a default row key is assumed. Key parts are separated by commas. The key will be used in all collections, for which a key in a file was not defined.

load_keys

  $rkr->load_keys( $rk_fname );

Loads row keys definitions from jar-record file.

parse_rkey_str

  $rkr->parse_rkey_str( $keys_str );

Parse a definition of one row key given in $keys_str.

find_key

  $key = $rkr->find_key( $name );

Find a row key to be applied to a given file.

SEE ALSO

The project is maintained on Source Forge http://lreport.sourceforge.net. You can find there links to some helpful documentation like tutorial.

AUTHORS

Piotr Kaluski <pkaluski@piotrkaluski.com>

COPYRIGHT

Copyright (c) 2004-2006 Piotr Kaluski. Poland. All rights reserved.

You may distribute under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

cpanm LRpt

perl -MCPAN -e shell
install LRpt