use JSON for serialization rather than rolling own

[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / Reading.pm

diff --git a/lib/Text/Tradition/Collation/Reading.pm b/lib/Text/Tradition/Collation/Reading.pm
index 4bdaecb..5a60823 100644 (file)
--- a/lib/Text/Tradition/Collation/Reading.pm
+++ b/lib/Text/Tradition/Collation/Reading.pm
@@ -1,7 +1,10 @@
 package Text::Tradition::Collation::Reading;
 
 use Moose;
+use JSON qw/ from_json /;
 use Module::Load;
+use Text::Tradition::Error;
+use YAML::XS;
 use overload '""' => \&_stringify, 'fallback' => 1;
 
 =head1 NAME
@@ -138,8 +141,7 @@ has 'normal_form' => (
        predicate => 'has_normal_form',
        );
 
-# Holds the word form. If is_disambiguated is true, the form at index zero
-# is the correct one.
+# Holds the lexemes for the reading.
 has 'reading_lexemes' => (
        traits => ['Array'],
        isa => 'ArrayRef[Text::Tradition::Collation::Reading::Lexeme]',
@@ -195,6 +197,14 @@ around BUILDARGS => sub {
        $class->$orig( $args );
 };
 
+# Look for a lexeme-string argument in the build args.
+sub BUILD {
+       my( $self, $args ) = @_;
+       if( exists $args->{'lexemes'} ) {
+               $self->_deserialize_lexemes( $args->{'lexemes'} );
+       }
+}
+
 =head2 is_meta
 
 A meta attribute (ha ha), which should be true if any of our 'special'
@@ -276,17 +286,34 @@ sub _stringify {
 
 =head1 MORPHOLOGY
 
-A few methods to try to tack on morphological information.
+Methods for the morphological information (if any) attached to readings.
+A reading may be made up of multiple lexemes; the concatenated lexeme
+strings ought to match the reading's normalized form.
+ 
+See L<Text::Tradition::Collation::Reading::Lexeme> for more information
+on Lexeme objects and their attributes.
+
+=head2 has_lexemes
+
+Returns a true value if the reading has any attached lexemes.
 
 =head2 lexemes
 
-=head2 has_lexemes
+Returns the Lexeme objects (if any) attached to the reading.
 
 =head2 clear_lexemes
 
-=head2 add_lexeme
+Wipes any associated Lexeme objects out of the reading.
+
+=head2 add_lexeme( $lexobj )
+
+Adds the Lexeme in $lexobj to the list of lexemes.
+
+=head2 lemmatize
 
-=head2 lemmatize 
+If the language of the reading is set, this method will use the appropriate
+Language model to determine the lexemes that belong to this reading.  See
+L<Text::Tradition::lemmatize> if you wish to lemmatize an entire tradition.
 
 =cut
 
@@ -302,6 +329,35 @@ sub lemmatize {
 
 }
 
+# For graph serialization. Return a JSON representation of the associated
+# reading lexemes.
+sub _serialize_lexemes {
+       my $self = shift;
+       my $json = JSON->new->allow_blessed(1)->convert_blessed(1);
+       return $json->encode( [ $self->lexemes ] );
+}
+
+# Given a JSON representation of the lexemes, instantiate them and add
+# them to the reading.
+sub _deserialize_lexemes {
+       my( $self, $json ) = @_;
+       my $data = from_json( $json );
+       return unless @$data;
+       
+       # Need to have the lexeme module in order to have lexemes.
+       eval { use Text::Tradition::Collation::Reading::Lexeme; };
+       throw( $@ ) if $@;
+       
+       # Good to go - add the lexemes.
+       my @lexemes;
+       foreach my $lexhash ( @$data ) {
+               push( @lexemes, Text::Tradition::Collation::Reading::Lexeme->new(
+                       'JSON' => $lexhash ) );
+       }
+       $self->clear_lexemes;
+       $self->add_lexeme( @lexemes );
+}
+
 ## Utility methods
 
 sub TO_JSON {
@@ -309,7 +365,12 @@ sub TO_JSON {
        return $self->text;
 }
 
-## TODO will need a throw() here
+sub throw {
+       Text::Tradition::Error->throw( 
+               'ident' => 'Reading error',
+               'message' => $_[0],
+               );
+}
 
 no Moose;
 __PACKAGE__->meta->make_immutable;