abandon 'collated' relationship removal
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / RelationshipStore.pm
index 93c4699..3328b96 100644 (file)
@@ -23,9 +23,38 @@ general) between readings.
 =begin testing
 
 use Text::Tradition;
+use TryCatch;
 
 use_ok( 'Text::Tradition::Collation::RelationshipStore' );
 
+# Add some relationships, and delete them
+
+my $cxfile = 't/data/Collatex-16.xml';
+my $t = Text::Tradition->new( 
+    'name'  => 'inline', 
+    'input' => 'CollateX',
+    'file'  => $cxfile,
+    );
+my $c = $t->collation;
+
+my @v1 = $c->add_relationship( 'n21', 'n22', { 'type' => 'meaning' } );
+is( scalar @v1, 1, "Added a single relationship" );
+is( $v1[0]->[0], 'n21', "Got correct node 1" );
+is( $v1[0]->[1], 'n22', "Got correct node 2" );
+my @v2 = $c->add_relationship( 'n9', 'n23', 
+       { 'type' => 'spelling', 'scope' => 'global' } );
+is( scalar @v2, 2, "Added a global relationship with two instances" );
+@v1 = $c->del_relationship( 'n22', 'n21' );
+is( scalar @v1, 1, "Deleted first relationship" );
+@v2 = $c->del_relationship( 'n8', 'n13' );
+is( scalar @v2, 2, "Deleted second global relationship" );
+try {
+       my @v3 = $c->del_relationship( 'n1', 'n2' );
+       ok( 0, "Should have errored on non-existent relationship" );
+} catch( Text::Tradition::Error $e ) {
+       like( $e->message, qr/No relationship defined/, "Attempt to delete non-existent relationship errored" );
+}
+
 =end testing
 
 =head1 METHODS
@@ -57,9 +86,24 @@ has 'graph' => (
        relationships => 'edges',
        add_reading => 'add_vertex',
        delete_reading => 'delete_vertex',
+       delete_relationship => 'delete_edge',
     },
        );
        
+around 'delete_relationship' => sub {
+       my $orig = shift;
+       my $self = shift;
+       my @vector;
+       if( @_ == 1 && ref( $_[0] ) eq 'ARRAY' ) {
+               # Dereference the edge arrayref that was passed.
+               my $edge = shift;
+               @vector = @$edge;
+       } else {
+               @vector = @_;
+       }
+       return $self->$orig( @vector );
+};
+       
 =head2 get_relationship
 
 Return the relationship object, if any, that exists between two readings.
@@ -67,7 +111,15 @@ Return the relationship object, if any, that exists between two readings.
 =cut
 
 sub get_relationship {
-       my( $self, @vector ) = @_;
+       my $self = shift;
+       my @vector;
+       if( @_ == 1 && ref( $_[0] ) eq 'ARRAY' ) {
+               # Dereference the edge arrayref that was passed.
+               my $edge = shift;
+               @vector = @$edge;
+       } else {
+               @vector = @_;
+       }
        my $relationship;
        if( $self->graph->has_edge_attribute( @vector, 'object' ) ) {
                $relationship = $self->graph->get_edge_attribute( @vector, 'object' );
@@ -100,7 +152,11 @@ sub create {
        my $target = delete $options->{'orig_b'};
        my $rel = $self->get_relationship( $source, $target );
        if( $rel ) {
-               if( $rel->type ne $options->{'type'} ) {
+               if( $rel->type eq 'collated' ) {
+                       # Always replace a 'collated' relationship with a more descriptive
+                       # one, if asked.
+                       $self->del_relationship( $source, $target );
+               } elsif( $rel->type ne $options->{'type'} ) {
                        throw( "Another relationship of type " . $rel->type 
                                . " already exists between $source and $target" );
                } else {
@@ -230,6 +286,31 @@ sub add_relationship {
     return @pairs_set;
 }
 
+=head2 del_relationship( $source, $target )
+
+Removes the relationship between the given readings. If the relationship is
+non-local, removes the relationship everywhere in the graph.
+
+=cut
+
+sub del_relationship {
+       my( $self, $source, $target ) = @_;
+       my $rel = $self->get_relationship( $source, $target );
+       throw( "No relationship defined between $source and $target" ) unless $rel;
+       my @vectors = ( [ $source, $target ] );
+       $self->_remove_relationship( $source, $target );
+       if( $rel->nonlocal ) {
+               # Remove the relationship wherever it occurs.
+               my @rel_edges = grep { $self->get_relationship( @$_ ) == $rel }
+                       $self->relationships;
+               foreach my $re ( @rel_edges ) {
+                       $self->_remove_relationship( @$re );
+                       push( @vectors, $re );
+               }
+       }
+       return @vectors;
+}
+
 =head2 relationship_valid( $source, $target, $type )
 
 Checks whether a relationship of type $type may exist between the readings given
@@ -244,6 +325,7 @@ sub relationship_valid {
     if ( $rel eq 'transposition' || $rel eq 'repetition' ) {
                # Check that the two readings do (for a repetition) or do not (for
                # a transposition) appear in the same witness.
+               # TODO this might be called before witness paths are set...
                my %seen_wits;
                map { $seen_wits{$_} = 1 } $c->reading_witnesses( $source );
                foreach my $w ( $c->reading_witnesses( $target ) ) {
@@ -259,7 +341,9 @@ sub relationship_valid {
                # Check that linking the source and target in a relationship won't lead
                # to a path loop for any witness.  If they have the same rank then fine.
                return( 1, "ok" ) 
-                       if $c->reading( $source )->rank == $c->reading( $target )->rank;
+                       if $c->reading( $source )->has_rank
+                               && $c->reading( $target )->has_rank
+                               && $c->reading( $source )->rank == $c->reading( $target )->rank;
                
                # Otherwise, first make a lookup table of all the
                # readings related to either the source or the target.
@@ -289,23 +373,27 @@ sub relationship_valid {
        }
 }
 
-=head2 related_readings( $reading, $colocated_only )
+=head2 related_readings( $reading, $filter )
 
 Returns a list of readings that are connected via relationship links to $reading.
-If $colocated_only is true, restricts the list to those readings that are in the
-same logical location (and therefore have the same rank in the collation graph.)
+If $filter is set to a subroutine ref, returns only those related readings where
+$filter( $relationship ) returns a true value.
 
 =cut
 
 sub related_readings {
-       my( $self, $reading, $colocated ) = @_;
+       my( $self, $reading, $filter ) = @_;
        my $return_object;
        if( ref( $reading ) eq 'Text::Tradition::Collation::Reading' ) {
                $reading = $reading->id;
                $return_object = 1;
        }
        my @answer;
-       if( $colocated ) {
+       if( $filter ) {
+               # Backwards compat
+               if( $filter eq 'colocated' ) {
+                       $filter = sub { $_[0]->colocated };
+               }
                my %found = ( $reading => 1 );
                my $check = [ $reading ];
                my $iter = 0;
@@ -313,7 +401,7 @@ sub related_readings {
                        my $more = [];
                        foreach my $r ( @$check ) {
                                foreach my $nr ( $self->graph->neighbors( $r ) ) {
-                                       if( $self->get_relationship( $r, $nr )->colocated ) {
+                                       if( &$filter( $self->get_relationship( $r, $nr ) ) ) {
                                                push( @$more, $nr ) unless exists $found{$nr};
                                                $found{$nr} = 1;
                                        }
@@ -321,6 +409,7 @@ sub related_readings {
                        }
                        $check = $more;
                }
+               delete $found{$reading};
                @answer = keys %found;
        } else {
                @answer = $self->graph->all_reachable( $reading );
@@ -397,6 +486,7 @@ sub _as_graphml {
                my $rel_obj = $self->get_relationship( @$e );
                _add_graphml_data( $edge_el, $edge_keys->{'relationship'}, $rel_obj->type );
                _add_graphml_data( $edge_el, $edge_keys->{'scope'}, $rel_obj->scope );
+               _add_graphml_data( $edge_el, $edge_keys->{'annotation'}, $rel_obj->annotation );
                _add_graphml_data( $edge_el, $edge_keys->{'non_correctable'}, 
                        $rel_obj->non_correctable ) if $rel_obj->noncorr_set;
                _add_graphml_data( $edge_el, $edge_keys->{'non_independent'},