start implementing morphology on readings

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

diff --git a/lib/Text/Tradition/Collation/Reading/WordForm.pm b/lib/Text/Tradition/Collation/Reading/WordForm.pm
new file mode 100644 (file)
index 0000000..a56cd2b
--- /dev/null
+++ b/lib/Text/Tradition/Collation/Reading/WordForm.pm
@@ -0,0 +1,94 @@
+package Text::Tradition::Collation::Reading::WordForm;
+
+use Moose;
+
+=head1 NAME
+
+Text::Tradition::Collation::Reading::WordForm - represents a
+language/lemma/morphology triplet that can be associated with a Reading.
+
+=head1 DESCRIPTION
+
+Text::Tradition is a library for representation and analysis of collated
+texts, particularly medieval ones.  A word form is used for the analysis of
+Reading objects; it consists of a lemma, a language, and a code to
+represent its part of speech.  In general the word forms for a particular
+language should be read from / written to some morphological database.
+
+=head1 METHODS
+
+=head2 new
+
+Creates a new word form from the passed options.
+
+=head2 language
+
+Returns the language to which this word form belongs.
+
+=head2 lemma
+
+Returns the lemma for the word form.
+
+=head2 morphology
+
+Returns an array representing this word's morphology. The contents of the
+array depend on the language being used.
+
+=cut
+
+has 'language' => (
+       is => 'ro',
+       isa => 'Str',
+       required => 1,
+       );
+       
+# TODO do we need this?
+has 'form' => (
+       is => 'ro',
+       isa => 'Str',
+       # required => 1,
+       );
+       
+has 'lemma' => (
+       is => 'ro',
+       isa => 'Str',
+       required => 1,
+       );
+       
+has 'morphology' => (
+       is => 'ro',
+       isa => 'ArrayRef',
+       required => 1,
+       );
+       
+around BUILDARGS => sub {
+       my $orig = shift;
+       my $class = shift;
+       my %args = @_ == 1 ? %{$_[0]} : @_;
+       unless( ref( $args{'morphology'} ) ) {
+               my @morph = split( '', $args{'morphology'} );
+               $args{'morphology'} = \@morph;
+       }
+       $class->$orig( %args );
+};
+
+sub _stringify {
+       my $self = shift;
+       return sprintf( "%s//%s//%s", $self->language, $self->lemma,
+               join( '', $self->morphology ) );
+}
+
+no Moose;
+__PACKAGE__->meta->make_immutable;
+
+1;
+
+=head1 LICENSE
+
+This package is free software and is provided "as is" without express
+or implied warranty.  You can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Tara L Andrews E<lt>aurum@cpan.orgE<gt>