dtRdr::Annotation::IO - Base class for annotation I/O

dotReader documentation Contained in the dotReader distribution.

Index

Code Index:

NAME

Top

dtRdr::Annotation::IO - Base class for annotation I/O

SYNOPSIS

Top

  use dtRdr::Annotation::IO;
  my $anno_io = dtRdr::Annotation::IO->new(uri => $directory);
  $anno_io->apply_to($book);

new

Constructor / Factory method.

  dtRdr::Annotation::IO->new(uri => $uri);

class_for

  dtRdr::Annotation::IO->class_for($uri);

Methods

Top

TODO/subclasses $io->init; $io->insert($object, %args); $io->delete($object, %args); $io->update($object, %args);

apply_to

  $io->apply_to($book);

_tell_book

Deserialize the annotation and tell the book to $action ('add', 'change', or 'delete') it.

  $self->_tell_book($action, $hashref, $book);

_anno_type

Caches annotation type and loads annotation class as needed.

  my $anno_type = $package_or_self->_anno_type($type);

AUTHOR

Top

Eric Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com/

BUGS

Top

If you found this module on CPAN, please report any bugs or feature requests through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

If you pulled this development version from my /svn/, please contact me directly.

COPYRIGHT

Top

Copyright (C) 2006 Eric L. Wilhelm and Osoft, All Rights Reserved.

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 Contained in the dotReader distribution. 
package dtRdr::Annotation::IO;
$VERSION = eval{require version}?version::qv($_):$_ for(0.10.1);

use warnings;
use strict;
use Carp;


use Class::Accessor::Classy;
ro 'uri';
no  Class::Accessor::Classy;


sub new {
  my $package = shift;
  (@_ % 2) and croak('odd number of elements in argument list');
  my (%args) = @_;

  my $caller = caller;

  if(defined($caller) and $caller->isa(__PACKAGE__)) {
    # constructor
    my $self = {%args};
    bless($self, $package);

    # let it setup itself
    $self->init;

    return($self);
  }
  else {
    # be a factory
    my $uri = $args{uri};
    defined($uri) or croak("cannot dispatch without uri argument");
    my $class = $package->class_for($args{uri});
    $class->new(%args);
  }
} # end subroutine new definition
########################################################################


sub class_for {
  my $package = shift;
  my ($uri) = @_;
  # TODO either plugins or maybe just leave hardcoded for now
  use dtRdr::Annotation::IO::YAML;
  return('dtRdr::Annotation::IO::YAML'); # easy answer
} # end subroutine class_for definition
########################################################################


sub apply_to {
  my $self = shift;
  my ($book) = @_;

  $book->anno_io and croak("that's going to hurt");

  foreach my $item ($self->items_for($book)) {
    $self->_tell_book('add', $item, $book);
  }

  $book->set_anno_io($self);

} # end subroutine apply_to definition
########################################################################


sub _tell_book {
  my $self = shift;
  my ($action, $item, $book) = @_;

  my $type = $item->{type};

  my $anno_type = $self->_anno_type($type);

  # TODO could be more efficient on delete
  my $object = $type->deserialize($item, book => $book);

  my $method = $action . '_' . $anno_type;
  $book->io_action(sub {$book->$method($object);});
} # end subroutine _tell_book definition
########################################################################


{
my %got_types; # as-you-go caching of addtype + require
sub _anno_type {
  my $self = shift;
  my ($type) = @_;

  my $anno_type;
  unless($anno_type = $got_types{$type}) { # long form of require
    my $type_pm = $type;
    $type_pm =~ s#::#/#g;
    $type_pm .= '.pm';
    eval { require "$type_pm" };
    $@ and croak("bah $@");
    $anno_type = $got_types{$type} = $type->ANNOTATION_TYPE;
  }
  return($anno_type);
} # end subroutine _anno_type definition
} # and closure
########################################################################


# vi:ts=2:sw=2:et:sta
1;