NAME

dtRdr::Annotation::Range - range-derived annotations

SYNOPSIS

Identifier Methods

IS_RANGE_TYPE

Required for all annotations. Any annotation derived from this class is a range type, so this is just a constant.

ANNOTATION_TYPE

Must be implemented by subclasses.

Misc Methods

renode

Change the node of an annotation object. The resultant object cannot be used for serialization.

my $new_obj = $obj->renode($node, %props);

dummy

Create a new (not unlinked) copy of an object with different properties.

$new_obj = $obj->dummy(%props);

get_book

Overrides the range get_book alias.

$hl->get_book;

Serialization

The annotation storage (dtRdr::Annotation::IO) classes expect annotations objects to support serialize() and deserialize() methods. These methods transform an object to/from a plain hash reference (i.e. there are no linked objects, circular references, etc.)

serialize

Returns a hashref which contains no book object or other circular references.

my $plain_hashref = $object->serialize;

%props = $object->augment_serialize;

deserialize

Transform the stripped-down hashref (as returned by serialize()) into a proper object.

my $object = MyClass->deserialize($hashref, book => $book);

augment_deserialize

May be defined by a subclass to augment the deserialization. The returned properties will be added to the arguments to new().

%props_out = SubClass->augment_deserialize(%props_in);

clone

Creates a (mostly) detatched version of the object. (use sparingly)

$obj->clone;

AUTHOR

Eric Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com/

COPYRIGHT

Copyright (C) 2006 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.

cpanm dtRdr

perl -MCPAN -e shell
install dtRdr