refactor GraphML write/parse to use Moose introspection
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / RelationshipStore.pm
index 3328b96..c9136b3 100644 (file)
@@ -86,24 +86,9 @@ 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.
@@ -123,7 +108,7 @@ sub get_relationship {
        my $relationship;
        if( $self->graph->has_edge_attribute( @vector, 'object' ) ) {
                $relationship = $self->graph->get_edge_attribute( @vector, 'object' );
-       }
+       } 
        return $relationship;
 }
 
@@ -133,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.
@@ -228,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 }
@@ -271,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 {
@@ -311,6 +309,11 @@ sub del_relationship {
        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
@@ -348,8 +351,12 @@ sub relationship_valid {
                # Otherwise, first make a lookup table of all the
                # readings related to either the source or the target.
                my @proposed_related = ( $source, $target );
-               push( @proposed_related, $self->related_readings( $source, 'colocated' ) );
-               push( @proposed_related, $self->related_readings( $target, 'colocated' ) );
+               # Drop the collation links of source and target, unless we want to
+               # add a collation relationship.
+               foreach my $r ( ( $source, $target ) ) {
+                       $self->_drop_collations( $r ) unless $rel eq 'collated';
+                       push( @proposed_related, $self->related_readings( $r, 'colocated' ) );
+               }
                my %pr_ids;
                map { $pr_ids{ $_ } = 1 } @proposed_related;
        
@@ -373,6 +380,15 @@ sub relationship_valid {
        }
 }
 
+sub _drop_collations {
+       my( $self, $reading ) = @_;
+       foreach my $n ( $self->graph->neighbors( $reading ) ) {
+               if( $self->get_relationship( $reading, $n )->type eq 'collated' ) {
+                       $self->del_relationship( $reading, $n );
+               }
+       }
+}
+
 =head2 related_readings( $reading, $filter )
 
 Returns a list of readings that are connected via relationship links to $reading.
@@ -484,13 +500,11 @@ sub _as_graphml {
                $edge_el->setAttribute( 'id', 'e'.$edge_ctr++ );
 
                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'}, 
-                       $rel_obj->non_independent ) if $rel_obj->nonind_set;
+               foreach my $key ( keys %$edge_keys ) {
+                       my $value = $rel_obj->$key;
+                       _add_graphml_data( $edge_el, $edge_keys->{$key}, $value ) 
+                               if defined $value;
+               }
        }
 }