Data::Annotated - Data structure Annotation module
Version 0.01
use Data::Annotated;
my $da = Data::Annotated->new();
$da->annotate('/foo/bar[2]/baz', {desc => 'this is an interesting field'});
$da->annotate('/some/other/path', {test => 1, runthis => sub { print 'I was one'; } });
my $struct = {some => {other => {path => 1}}};
my @annotations = $da->cat_annotation();
# this will print out "I was one';
$annotations[0]{runthis}->() if $struct->{some}{other}{path} == $annotations[0]{test};
new()instantiate a new Data::Annotated object;
Annotate a piece of a data structure. The path is an XPath like path like the Data::Path manpage uses. The annotation can be any scalar value. Possible uses are String for descriptive text. Or a reference to a more complex data structure.
cat_annotation($data)spit out the annotations for a data structure. Returns the annotations that apply for the passed in data structures. Does not return an annotation if the data doesn't contain the data location it is matched to.
get_annotation($path);retrieves an annotation keyed by the path in the data structure.
_validate_path($path)validates a the Data::Path manpage path for validity.
Should Data::Annotate wrap data? or stay a collection of annotations?
Make Data::Annotate return the data from a requested path. my $info = $da->get($path, $data) basically just a wrapper around L<Data::Path> get()
Copyright 2007 Jeremy Wall, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Jeremy Wall, <jeremy at marzhillstudios.com>