man Lire::Config::Index () - Index registry and interface

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. Returns true if an index was registered under CW$name. Retuurns the Index named CW$name. Croaks if no such index was registered. Registers CW$index under CW$name. Replaces any previous index registered under the same name.

INDEX INTERFACE

Should return true if CW$name is defined in this index.

entries()

Should return all the entries defined in the index. Should return the object indexed under CW$name. An error should be thrown if there is no such entry.;.

SEE ALSO

AUTHOR

  Francis J. Lacoste <flacoste@logreport.org>

VERSION

$Id: Index.pm,v 1.1 2004/07/10 23:39:53 flacoste 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 or write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.