dtRdr::Annotation::IO::YAML - read/write annotations from/to yml files


dotReader documentation  | view source Contained in the dotReader distribution.

Index


NAME

Top

dtRdr::Annotation::IO::YAML - read/write annotations from/to yml files

SYNOPSIS

Top

Methods

Top

init

  $io->init;

_read_store

  %store = $self->_read_store($ext);

items

Return hashrefs for everything. This gets called by base class methods if it can't find a smarter way to search.

  @items = $io->items;

items_for

Return the hashrefs for a given book.

  @items = $io->items_for($book);

Likely to be replaced by something more general.

deleted

  @items = $io->deleted;

insert

  $io->insert($object, %args);

delete

  $io->delete($object, %args);

update

  $io->update($object, %args);

Sync/Backend Methods

Top

Intended for non-object manipulations of the data-store, but keeping the internal IO object's state intact.

These should behave roughly like DBI operations with autocommit and raise_error.

s_insert

  $io->s_insert($id, $hashref, $book);

s_update

  $io->s_update($id, $hashref, $book);

s_delete

  $io->s_delete($id, $book);

x_read

  my $hashref = $io->x_read($id);

x_insert

  $io->x_insert($id, $hashref);

x_update

  $io->x_update($id, $hashref);

x_delete

  $object = $io->x_delete($id);

x_finish_delete

  $self->x_finish_delete($id);

Small Parts

Top

_filename

  $self->_filename($id);

AUTHOR

Top

Eric Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com/

COPYRIGHT

Top

NO WARRANTY

Top

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

Top

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.


dotReader documentation  | view source Contained in the dotReader distribution.