refactored Analysis module with associated changes

[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 fa9ce8b..d1c69f7 100644 (file)
--- a/lib/Text/Tradition/Collation/Reading.pm
+++ b/lib/Text/Tradition/Collation/Reading.pm
@@ -1,8 +1,7 @@
 package Text::Tradition::Collation::Reading;
 
 use Moose;
-use overload '""' => \&_stringify;
-use Text::Tradition::Collation;
+use overload '""' => \&_stringify, 'fallback' => 1;
 
 =head1 NAME
 
@@ -37,6 +36,8 @@ Options include:
 
 =item is_lacuna - The 'reading' represents a known gap in the text.
 
+=item is_ph - A temporary placeholder for apparatus parsing purposes.  Do not use unless you know what you are doing.
+
 =item rank - The sequence number of the reading. This should probably not be set manually.
 
 =back
@@ -78,8 +79,9 @@ has 'text' => (
        is => 'ro',
        isa => 'Str',
        required => 1,
+       writer => 'alter_text',
        );
-
+       
 has 'is_start' => (
        is => 'ro',
        isa => 'Bool',
@@ -97,6 +99,18 @@ has 'is_lacuna' => (
     isa => 'Bool',
        default => undef,
     );
+    
+has 'is_ph' => (
+       is => 'ro',
+       isa => 'Bool',
+       default => undef,
+       );
+       
+has 'is_common' => (
+       is => 'rw',
+       isa => 'Bool',
+       default => undef,
+       );
 
 has 'rank' => (
     is => 'rw',
@@ -114,12 +128,11 @@ around BUILDARGS => sub {
        } 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'} );
+               $args->{'text'} = '#LACUNA#';
        } elsif( exists $args->{'is_start'} ) {
                $args->{'id'} = '#START#';  # Change the ID to ensure we have only one
                $args->{'text'} = '#START#';
@@ -127,6 +140,8 @@ around BUILDARGS => sub {
        } elsif( exists $args->{'is_end'} ) {
                $args->{'id'} = '#END#';        # Change the ID to ensure we have only one
                $args->{'text'} = '#END#';
+       } elsif( exists $args->{'is_ph'} ) {
+               $args->{'text'} = $args->{'id'};
        }
        
        $class->$orig( $args );
@@ -142,15 +157,64 @@ of text found in a witness.
 
 sub is_meta {
        my $self = shift;
-       return $self->is_start || $self->is_end || $self->is_lacuna;    
+       return $self->is_start || $self->is_end || $self->is_lacuna || $self->is_ph;    
 }
 
-# Some syntactic sugar
+=head1 Convenience methods
+
+=head2 related_readings
+
+Calls Collation's related_readings with $self as the first argument.
+
+=cut
+
 sub related_readings {
        my $self = shift;
        return $self->collation->related_readings( $self, @_ );
 }
 
+=head2 witnesses 
+
+Calls Collation's reading_witnesses with $self as the first argument.
+
+=cut
+
+sub witnesses {
+       my $self = shift;
+       return $self->collation->reading_witnesses( $self, @_ );
+}
+
+=head2 predecessors
+
+Returns a list of Reading objects that immediately precede $self in the collation.
+
+=cut
+
+sub predecessors {
+       my $self = shift;
+       my @pred = $self->collation->sequence->predecessors( $self->id );
+       return map { $self->collation->reading( $_ ) } @pred;
+}
+
+=head2 successors
+
+Returns a list of Reading objects that immediately follow $self in the collation.
+
+=cut
+
+sub successors {
+       my $self = shift;
+       my @succ = $self->collation->sequence->successors( $self->id );
+       return map { $self->collation->reading( $_ ) } @succ;
+}
+
+=head2 set_identical( $other_reading)
+
+Backwards compatibility method, to add a transposition relationship
+between $self and $other_reading.  Don't use this.
+
+=cut
+
 sub set_identical {
        my( $self, $other ) = @_;
        return $self->collation->add_relationship( $self, $other,