X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FText%2FTradition%2FCollation%2FRelationshipStore.pm;h=2f8784c208c176e9db3991f20235ece854395aaf;hb=0a90079324146b05a46fadc49999d423e7d93db3;hp=a74c890733dfd9ed60c9cfd40aea82e92645297e;hpb=84d4ca783d20c1606c29cc83e1c41c09ddd888f2;p=scpubgit%2Fstemmatology.git

diff --git a/lib/Text/Tradition/Collation/RelationshipStore.pm b/lib/Text/Tradition/Collation/RelationshipStore.pm
index a74c890..2f8784c 100644
--- a/lib/Text/Tradition/Collation/RelationshipStore.pm
+++ b/lib/Text/Tradition/Collation/RelationshipStore.pm
@@ -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
@@ -67,11 +96,19 @@ 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' );
-	}
+	} 
 	return $relationship;
 }
 
@@ -81,11 +118,6 @@ sub _set_relationship {
 	$self->graph->set_edge_attribute( @vector, 'object', $relationship );
 }
 
-sub _remove_relationship {
-	my( $self, @vector ) = @_;
-	$self->graph->delete_edge( @vector );
-}
-	
 =head2 create
 
 Create a new relationship with the given options and return it.
@@ -100,7 +132,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 {
@@ -172,25 +208,43 @@ add_relationship.
 sub add_relationship {
 	my( $self, $source, $source_rdg, $target, $target_rdg, $options ) = @_;
 
-	# Check the options
-	$options->{'scope'} = 'local' unless $options->{'scope'};
-	
-	my( $is_valid, $reason ) = 
-		$self->relationship_valid( $source, $target, $options->{'type'} );
-    unless( $is_valid ) {
-        throw( "Invalid relationship: $reason" );
+	my $relationship;
+	my $thispaironly;
+	if( ref( $options ) eq 'Text::Tradition::Collation::Relationship' ) {
+		$relationship = $options;
+		$thispaironly = 1;  # If existing rel, set only where asked.
+	} else {
+		# Check the options
+		$options->{'scope'} = 'local' unless $options->{'scope'};
+		
+		my( $is_valid, $reason ) = 
+			$self->relationship_valid( $source, $target, $options->{'type'} );
+		unless( $is_valid ) {
+			throw( "Invalid relationship: $reason" );
+		}
+		
+		# Try to create the relationship object.
+		$options->{'reading_a'} = $source_rdg->text;
+		$options->{'reading_b'} = $target_rdg->text;
+		$options->{'orig_a'} = $source;
+		$options->{'orig_b'} = $target;
+    	if( $options->{'scope'} ne 'local' ) {
+			# Is there a relationship with this a & b already?
+			my $otherrel = $self->scoped_relationship( $options->{reading_a}, 
+				$options->{reading_b} );
+			if( $otherrel && $otherrel->type eq $options->{type}
+				&& $otherrel->scope eq $options->{scope} ) {
+				warn "Applying existing scoped relationship";
+				$relationship = $otherrel;
+			}
+    	}
+		$relationship = $self->create( $options ) unless $relationship;  # Will throw on error
     }
-    
-    # Try to create the relationship object.
-    $options->{'reading_a'} = $source_rdg->text;
-    $options->{'reading_b'} = $target_rdg->text;
-    $options->{'orig_a'} = $source;
-    $options->{'orig_b'} = $target;
-    my $relationship = $self->create( $options );  # Will throw on error
+
 
 	# Find all the pairs for which we need to set the relationship.
 	my @vectors = ( [ $source, $target ] );	
-    if( $relationship->colocated && $relationship->nonlocal ) {
+    if( $relationship->colocated && $relationship->nonlocal && !$thispaironly ) {
     	my $c = $self->collation;
     	# Set the same relationship everywhere we can, throughout the graph.
     	my @identical_readings = grep { $_->text eq $relationship->reading_a }
@@ -215,7 +269,7 @@ sub add_relationship {
     my @pairs_set;
     foreach my $v ( @vectors ) {
 		my $rel = $self->get_relationship( @$v );
-    	if( $rel ) {
+    	if( $rel && $rel ne $relationship ) {
     		if( $rel->nonlocal ) {
     			throw( "Found conflicting relationship at @$v" );
     		} else {
@@ -230,6 +284,36 @@ 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;
+}
+
+sub _remove_relationship {
+	my( $self, @vector ) = @_;
+	$self->graph->delete_edge( @vector );
+}
+	
 =head2 relationship_valid( $source, $target, $type )
 
 Checks whether a relationship of type $type may exist between the readings given
@@ -244,6 +328,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 ) ) {
@@ -291,23 +376,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;
@@ -315,7 +404,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;
 					}
@@ -323,6 +412,7 @@ sub related_readings {
 			}
 			$check = $more;
 		}
+		delete $found{$reading};
 		@answer = keys %found;
 	} else {
 		@answer = $self->graph->all_reachable( $reading );
@@ -399,6 +489,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'},