package Text::Tradition::Collation::Reading;
use Moose;
-use MooseX::NonMoose;
-use Text::Tradition::Collation::Position;
+use overload '""' => \&_stringify, 'fallback' => 1;
+use Text::Tradition::Collation;
-extends 'Graph::Easy::Node';
+=head1 NAME
-has 'position' => (
- is => 'rw',
- isa => 'Text::Tradition::Collation::Position',
- predicate => 'has_position',
- );
+Text::Tradition::Collation::Reading - represents a reading (usually a word) in a collation.
+
+=head1 DESCRIPTION
-# 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]',
- );
+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
-# 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( @_ );
- }
-};
+=head1 METHODS
-# Take constructor args as well as a Position argument.
-around position => sub {
- my $orig = shift;
- my $self = shift;
- return $self->$orig() unless @_;
-
- my @args = @_;
- unless( @_ == 1 && ref( $_[0] ) eq 'Text::Tradition::Collation::Position' ) {
- # We have constructor arguments; pass them to Position.
- @args = ( Text::Tradition::Collation::Position->new( @_ ) );
- }
- $self->$orig( @args );
-};
+=head2 new
-# Initialize the identity pool.
-sub BUILD {
- my( $self, $args ) = @_;
- $self->same_as( [ $self ] );
-}
+Creates a new reading in the given collation with the given attributes.
+Options include:
-sub text {
- # Wrapper function around 'label' attribute.
- my $self = shift;
- if( @_ ) {
- $self->set_attribute( 'label', $_[0] );
- }
- return $self->label;
-}
+=over 4
-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;
+=item collation - The Text::Tradition::Collation object to which this reading belongs. Required.
- # TODO Adopt the relationship attributes of the other node.
-}
+=item id - A unique identifier for this reading. Required.
-## Dealing with transposed readings. These methods are only really
-## applicable if we have a linear collation graph.
+=item text - The word or other text of the reading.
-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 is_start - The reading is the starting point for the collation.
-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_end - The reading is the ending point for the collation.
-sub has_primary {
- my $self = shift;
- my $pool = $self->same_as;
- return $pool->[0]->name ne $self->name;
-}
+=item is_lacuna - The 'reading' represents a known gap in the text.
-sub primary {
- my $self = shift;
- return $self->same_as->[0];
-}
+=item rank - The sequence number of the reading. This should probably not be set manually.
-sub is_at_position {
- my $self = shift;
- return undef unless $self->has_position;
- return $self->position->is_colocated( @_ );
-}
+=back
-# Returns all readings that adjoin this one on any path.
-sub neighbor_readings {
- my( $self, $direction ) = @_;
- $direction = 'both' unless $direction;
- my @paths = grep { $_->isa( 'Text::Tradition::Collation::Path' ) } $self->edges;
- my %connected;
- foreach my $p ( @paths ) {
- if( $p->to eq $self ) {
- next if $direction eq 'forward';
- $connected{$p->from->name} = $p->from;
- } else { # $p->from eq $self
- next if $direction =~ /^back/;
- $connected{$p->to->name} = $p->to;
- }
- }
- return values( %connected );
-}
+One of 'text', 'is_start', 'is_end', or 'is_lacuna' is required.
-sub adjust_neighbor_position {
- my $self = shift;
- return unless $self->position->fixed;
-
- # TODO This is a naive and repetitive implementation and
- # I don't like it.
- foreach my $neighbor ( $self->neighbor_readings('forward') ) {
- next unless !$neighbor->is_common &&
- $neighbor->position->common == $self->position->common;
- if( $neighbor->position->fixed &&
- $neighbor->position->min == $self->position->min ) {
- warn sprintf( "Readings %s and %s are at the same position!",
- $neighbor->name, $self->name );
- }
- next if $neighbor->position->fixed || $neighbor->position->matched;
- $neighbor->position->min( $self->position->min + 1 );
- # Recurse if necessary.
- $neighbor->adjust_neighbor_position()
- unless $neighbor->position->fixed;
- }
- foreach my $neighbor ( $self->neighbor_readings('back') ) {
- next unless !$neighbor->is_common &&
- $neighbor->position->common == $self->position->common;
- if( $neighbor->position->fixed &&
- $neighbor->position->min == $self->position->min ) {
- warn sprintf( "Readings %s and %s are at the same position!",
- $neighbor->name, $self->name );
- }
- next if $neighbor->position->fixed || $neighbor->position->matched;
- $neighbor->position->max( $self->position->max - 1 );
- # Recurse if necessary.
- $neighbor->adjust_neighbor_position()
- unless $neighbor->position->fixed;
- }
- return;
-}
-
-sub match_position {
- my( $self, $other ) = @_;
- # Adjust the position of both these nodes to be as restrictive as possible.
- unless( $self->position->is_colocated( $other->position ) ) {
- warn "Cannot match positions of non-colocated readings";
- return;
- }
- my $sp = $self->position;
- my $op = $other->position;
- my $newmin = $sp->min > $op->min ? $sp->min : $op->min;
- my $newmax = $sp->max < $op->max ? $sp->max : $op->max;
- my $newpos = Text::Tradition::Collation::Position->new(
- 'common' => $sp->common,
- 'min' => $newmin,
- 'max' => $newmax,
- 'matched' => 1,
+=head2 collation
+
+=head2 id
+
+=head2 text
+
+=head2 is_start
+
+=head2 is_end
+
+=head2 is_lacuna
+
+=head2 rank
+
+Accessor methods for the given attributes.
+
+=cut
+
+has 'collation' => (
+ is => 'ro',
+ isa => 'Text::Tradition::Collation',
+ # required => 1,
+ weak_ref => 1,
);
- # We are setting the positions to be the same object. I don't
- # think that actually matters. We may eventually want unique
- # objects for each position.
- $self->position( $newpos );
- $other->position( $newpos );
- $self->adjust_neighbor_position();
- $other->adjust_neighbor_position();
-}
-## Keep track of which readings are unchanged across witnesses.
+has 'id' => (
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
+ );
-sub is_common {
- my( $self ) = shift;
- return $self->get_attribute( 'class' ) eq 'common';
-}
+has 'text' => (
+ is => 'ro',
+ isa => 'Str',
+ required => 1,
+ );
-sub make_common {
- my( $self ) = shift;
- $self->set_attribute( 'class', 'common' );
-}
+has 'is_start' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
-sub make_variant {
- my( $self ) = shift;
- $self->set_attribute( 'class', 'variant' );
-}
+has 'is_end' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
+
+has 'is_lacuna' => (
+ is => 'ro',
+ isa => 'Bool',
+ default => undef,
+ );
-no Moose;
-__PACKAGE__->meta->make_immutable;
+has 'rank' => (
+ is => 'rw',
+ isa => 'Int',
+ predicate => 'has_rank',
+ );
-1;
-######################################################
-## copied from Graph::Easy::Parser docs
-######################################################
-# when overriding nodes, we also need ::Anon
+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
-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;
+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.
-1;
-# use base qw/Text::Tradition::Collation::Reading/;
-# use base qw/Graph::Easy::Node::Anon/;
+=cut
+
+sub is_meta {
+ my $self = shift;
+ return $self->is_start || $self->is_end || $self->is_lacuna;
+}
-######################################################
-# and :::Empty
+# 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/;
-######################################################
projects / scpubgit/stemmatology.git / blobdiff