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

NAME

       Lire::Config::Index - Index registry and interface

SYNOPSIS

         use base qw/Lire::Config::Index/;

         sub has_entry { my ($self, $name) = @_; ... }

         sub entries { my $self = $_[0]; ... }

         sub get_ref { my ($self, $name) = @_; ... }

DESCRIPTION

       The Lire::Config::Index interface is used by the Lire::Config::ReferenceSpec(3pm) to
       validate and obtain referenced object.

INDEX REGISTRY

       These are the class methods used to register and obtain Index objects.

   has_index( $name )
       Returns true if an index was registered under $name.

   get_index( $name )
       Retuurns the Index named $name. Croaks if no such index was registered.

   set_index( $name, $index )
       Registers $index under $name. Replaces any previous index registered under the same name.

INDEX INTERFACE

   has_entry( $name )
       Should return true if $name is defined in this index.

   entries()
       Should return all the entries defined in the index.

   get_ref( $name )
       Should return the object indexed under $name. An error should be thrown if there is no
       such entry.;.

SEE ALSO

        Lire::Config::Reference(3pm) Lire::Config::ReferenceSpec(3pm)
        Lire:Config::ReportConfigIndex(3pm)

AUTHOR

         Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: Index.pm,v 1.2 2006/07/23 13:16:30 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.