package Text::Tradition::Collation::Reading;
use Moose;
-use Moose::Util::TypeConstraints;
-use MooseX::NonMoose;
+use overload '""' => \&_stringify, 'fallback' => 1;
+use Text::Tradition::Collation;
-extends 'Graph::Easy::Node';
+=head1 NAME
-subtype 'Position'
- => as 'Str',
- => where { $_ =~ /^\d+\,\d+$/ },
- message { 'Position must be of the form x,y' };
+Text::Tradition::Collation::Reading - represents a reading (usually a word) in a collation.
+
+=head1 DESCRIPTION
-has 'position' => (
- is => 'rw',
- isa => 'Position',
- predicate => 'has_position',
- );
+Text::Tradition is a library for representation and analysis of collated
+texts, particularly medieval ones. A 'reading' refers to a unit of text,
+usually a word, that appears in one or more witnesses (manuscripts) of the
+tradition; the text of a given witness is composed of a set of readings in
+a particular sequence
-# This contains an array of reading objects; the array is a pool,
-# shared by the reading objects inside the pool. When a reading is
-# added to the pool, all the same_as attributes should be updated.
-has 'same_as' => (
- is => 'rw',
- isa => 'ArrayRef[Text::Tradition::Collation::Reading]',
- );
+=head1 METHODS
-# # This is a hash mapping of 'relationship => reading'.
-# # TODO we should validate the relationships sometime.
-has 'relationships' => (
- is => 'ro',
- isa => 'HashRef[Text::Tradition::Collation::Reading]',
- default => sub { {} },
- );
+=head2 new
-# Deal with the non-arg option for Graph::Easy's constructor.
-around BUILDARGS => sub {
- my $orig = shift;
- my $class = shift;
-
- my %args;
- if( @_ == 1 && ref( $_[0] ) ne 'HASH' ) {
- return $class->$orig( 'name' => $_[0] );
- } else {
- return $class->$orig( @_ );
- }
-};
+Creates a new reading in the given collation with the given attributes.
+Options include:
-# Initialize the identity pool.
-sub BUILD {
- my( $self, $args ) = @_;
- $self->same_as( [ $self ] );
-}
+=over 4
-sub text {
- # Wrapper function around 'label' attribute.
- my $self = shift;
- if( @_ ) {
- $self->set_attribute( 'label', $_[0] );
- }
- return $self->get_attribute( 'label' );
-}
+=item collation - The Text::Tradition::Collation object to which this reading belongs. Required.
-sub merge_from {
- my( $self, $merged_node ) = @_;
- # Adopt the identity pool of the other node.
- my @now_identical = grep { $_ ne $merged_node } @{$merged_node->same_as};
- my $new_pool = _merge_array_pool( \@now_identical, $self->same_as )
- if @now_identical;
-
- # Adopt the relationship attributes of the other node.
- my $now_rel = $merged_node->relationships;
- foreach my $key ( %$now_rel ) {
- if( $self->has_relationship( $key ) ) {
- my $related = $self->get_relationship( $key );
- if( $now_rel->{$key} ne $related ) {
- warn( sprintf( "Merged reading %s has relationship %s to reading %s instead of %s; skipping",
- $merged_node->name, $key,
- $now_rel->{$key},
- $related) );
- } # else no action needed
- } else {
- $self->set_relationship( $key, $now_rel->{$key} );
- }
- }
-}
+=item id - A unique identifier for this reading. Required.
-sub set_identical {
- my( $self, $other_node ) = @_;
- my $enlarged_pool = _merge_array_pool( $self->same_as,
- $other_node->same_as );
-
- # ...and set this node to point to the enlarged pool.
- $self->same_as( $enlarged_pool );
-}
-
-sub identical_readings {
- my $self = shift;
- my @same = grep { $_ ne $self } @{$self->same_as};
- return @same;
-}
+=item text - The word or other text of the reading.
-sub _merge_array_pool {
- my( $pool, $main_pool ) = @_;
- my %poolhash;
- foreach ( @$main_pool ) {
- # Note which nodes are already in the main pool so that we
- # don't re-add them.
- $poolhash{$_->name} = 1;
- }
-
- foreach( @$pool ) {
- # Add the remaining nodes to the main pool...
- push( @$main_pool, $_ ) unless $poolhash{$_->name};
- }
- return $main_pool;
-}
+=item is_start - The reading is the starting point for the collation.
-sub has_primary {
- my $self = shift;
- my $pool = $self->same_as;
- return $pool->[0]->name eq $self->name;
-}
+=item is_end - The reading is the ending point for the collation.
-sub primary {
- my $self = shift;
- return $self->same_as->[0];
-}
+=item is_lacuna - The 'reading' represents a known gap in the text.
-# Much easier to do this with a hash than with an array of Relationship objects,
-# which would be the proper OO method.
+=item rank - The sequence number of the reading. This should probably not be set manually.
-sub has_relationship {
- my( $self, $rel ) = @_;
- return exists( $self->relationships->{ $rel } );
-}
+=back
-sub get_relationship {
- my( $self, $rel ) = @_;
- if( $self->has_relationship( $rel ) ) {
- return $self->relationships->{ $rel };
- }
- return undef;
-}
+One of 'text', 'is_start', 'is_end', or 'is_lacuna' is required.
-sub set_relationship {
- my( $self, $rel, $value ) = @_;
- $self->relationships->{ $rel } = $value;
-}
+=head2 collation
-sub is_common {
- my( $self ) = shift;
- return $self->get_attribute( 'class' ) eq 'common';
-}
+=head2 id
-sub make_common {
- my( $self ) = shift;
- $self->set_attribute( 'class', 'common' );
-}
+=head2 text
-sub make_variant {
- my( $self ) = shift;
- $self->set_attribute( 'class', 'variant' );
-}
+=head2 is_start
-no Moose;
-__PACKAGE__->meta->make_immutable;
+=head2 is_end
-1;
+=head2 is_lacuna
-######################################################
-## copied from Graph::Easy::Parser docs
-######################################################
-# when overriding nodes, we also need ::Anon
+=head2 rank
-package Text::Tradition::Collation::Reading::Anon;
-use Moose;
-use MooseX::NonMoose;
-extends 'Text::Tradition::Collation::Reading';
-extends 'Graph::Easy::Node::Anon';
-no Moose;
-__PACKAGE__->meta->make_immutable;
+Accessor methods for the given attributes.
-1;
-# use base qw/Text::Tradition::Collation::Reading/;
-# use base qw/Graph::Easy::Node::Anon/;
+=cut
-######################################################
-# and :::Empty
+has 'collation' => (
+ is => 'ro',
+ isa => 'Text::Tradition::Collation',
+ # required => 1,
+ weak_ref => 1,
+ );
+
+has 'id' => (
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
+ );
+
+has 'text' => (
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
+ writer => 'alter_text',
+ );
+
+has 'is_start' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
+
+has 'is_end' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
+
+has 'is_lacuna' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
+
+has 'rank' => (
+ is => 'rw',
+ isa => 'Int',
+ predicate => 'has_rank',
+ );
+
+
+around BUILDARGS => sub {
+ my $orig = shift;
+ my $class = shift;
+ my $args;
+ if( @_ == 1 ) {
+ $args = shift;
+ } else {
+ $args = { @_ };
+ }
+
+ # If one of our special booleans is set, we change the text and the
+ # ID to match.
+
+ if( exists $args->{'is_lacuna'} && !exists $args->{'text'} ) {
+ $args->{'text'} = sprintf( "#LACUNA_%s#", $args->{'id'} );
+ } elsif( exists $args->{'is_start'} ) {
+ $args->{'id'} = '#START#'; # Change the ID to ensure we have only one
+ $args->{'text'} = '#START#';
+ $args->{'rank'} = 0;
+ } elsif( exists $args->{'is_end'} ) {
+ $args->{'id'} = '#END#'; # Change the ID to ensure we have only one
+ $args->{'text'} = '#END#';
+ }
+
+ $class->$orig( $args );
+};
+
+=head2 is_meta
+
+A meta attribute (ha ha), which should be true if any of our 'special'
+booleans are true. Implies that the reading does not represent a bit
+of text found in a witness.
+
+=cut
+
+sub is_meta {
+ my $self = shift;
+ return $self->is_start || $self->is_end || $self->is_lacuna;
+}
+
+# Some syntactic sugar
+sub related_readings {
+ my $self = shift;
+ return $self->collation->related_readings( $self, @_ );
+}
+
+sub set_identical {
+ my( $self, $other ) = @_;
+ return $self->collation->add_relationship( $self, $other,
+ { 'type' => 'transposition' } );
+}
+
+sub _stringify {
+ my $self = shift;
+ return $self->id;
+}
-package Text::Tradition::Collation::Reading::Empty;
-use Moose;
-use MooseX::NonMoose;
-extends 'Graph::Easy::Node::Empty';
no Moose;
__PACKAGE__->meta->make_immutable;
1;
-# use base qw/Text::Tradition::Collation::Reading/;
-######################################################