Eric Wilhelm > dotReader > dtRdr::Library

Download:
dotReader-v0.11.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source  

NAME ^

dtRdr::Library - library class frontend/base

SYNOPSIS ^

This module is still in need of some major hacking to get the plugin loader worked out. Metadata and other API aspects are also undecided.

Name ^

dtRdr::Library.pm - Library interface

Class Methods ^

class_by_type

  dtRdr::Library->class_by_type($type);

Constructor ^

new

Create a new empty library object.

  my $library = dtRdr::Library->new();

load_uri

Load the library stored at URI and set the location property.

get_books

Return a list of book objects for the books stored in a library object

get_metadata

Return a list of all the metadata objects stored in this library

get_book_info

Return a list of book info objects.

  my @infos = $lib->get_book_info;

open_book

Return a book object matching a given key/value lookup pair.

  $lib->open_book(intid => $id);

or

  $lib->open_book(title => $title);

or

  $lib->open_book(book_id => $book_id);

find_book_by

Virtual: find a book for a given $key/$value match.

  $info = $lib->find_book_by($key, $value);

add_metadata

Add the metadata object to the book, stored in the library

delete_metadata

Remove the metadata from the specified book, as it's stored in the library.

  $lib->delete_metadata($book, $metadata);

add_book

remove_book

Remove the book.

All metadata for the book will be deleted from the library.

AUTHOR ^

Dan Sugalski, <dan@sidhe.org>

Eric Wilhelm <ewilhelm at cpan dot org>

COPYRIGHT ^

Copyright (C) 2006-2007 by Dan Sugalski, Eric L. Wilhelm, and OSoft, All Rights Reserved.

NO WARRANTY ^

Absolutely, positively NO WARRANTY, neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned.

LICENSE ^

The dotReader(TM) is OSI Certified Open Source Software licensed under the GNU General Public License (GPL) Version 2, June 1991. Non-encrypted and encrypted packages are usable in connection with the dotReader(TM). The ability to create, edit, or otherwise modify content of such encrypted packages is self-contained within the packages, and NOT provided by the dotReader(TM), and is addressed in a separate commercial license.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

syntax highlighting: