add method to generate a part of the graph specified by rank range
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation.pm
index b6cd063..6891065 100644 (file)
@@ -6,6 +6,7 @@ use Graph;
 use IPC::Run qw( run binary );
 use Text::CSV_XS;
 use Text::Tradition::Collation::Reading;
+use Text::Tradition::Collation::RelationshipStore;
 use XML::LibXML;
 use Moose;
 
@@ -20,11 +21,12 @@ has 'sequence' => (
     
 has 'relations' => (
        is => 'ro',
-       isa => 'Graph',
-       default => sub { Graph->new( undirected => 1 ) },
-    handles => {
-       relationships => 'edges',
-    },
+       isa => 'Text::Tradition::Collation::RelationshipStore',
+       handles => {
+               relationships => 'relationships',
+               related_readings => 'related_readings',
+       },
+       writer => '_set_relations',
        );
 
 has 'tradition' => (
@@ -101,6 +103,7 @@ has 'end' => (
 
 sub BUILD {
     my $self = shift;
+    $self->_set_relations( Text::Tradition::Collation::RelationshipStore->new( 'collation' => $self ) );
     $self->_set_start( $self->add_reading( { 'collation' => $self, 'is_start' => 1 } ) );
     $self->_set_end( $self->add_reading( { 'collation' => $self, 'is_end' => 1 } ) );
 }
@@ -123,7 +126,7 @@ sub add_reading {
        $self->_add_reading( $reading->id => $reading );
        # Once the reading has been added, put it in both graphs.
        $self->sequence->add_vertex( $reading->id );
-       $self->relations->add_vertex( $reading->id );
+       $self->relations->add_reading( $reading->id );
        return $reading;
 };
 
@@ -137,7 +140,7 @@ around del_reading => sub {
        }
        # Remove the reading from the graphs.
        $self->sequence->delete_vertex( $arg );
-       $self->relations->delete_vertex( $arg );
+       $self->relations->delete_reading( $arg );
        
        # Carry on.
        $self->$orig( $arg );
@@ -165,18 +168,7 @@ sub merge_readings {
                @wits{keys %$fwits} = values %$fwits;
                $self->sequence->set_edge_attributes( @vector, \%wits );
        }
-       foreach my $rel ( $self->relations->edges_at( $deleted ) ) {
-               my @vector = ( $kept );
-               push( @vector, $rel->[0] eq $deleted ? $rel->[1] : $rel->[0] );
-               next if $vector[0] eq $vector[1]; # Don't add a self loop
-               # Is there a relationship here already? If so, keep it.
-               # TODO Warn about conflicting relationships
-               next if $self->relations->has_edge( @vector );
-               # If not, adopt the relationship that would be deleted.
-               $self->relations->add_edge( @vector );
-               my $attr = $self->relations->get_edge_attributes( @$rel );
-               $self->relations->set_edge_attributes( @vector, $attr );
-       }
+       $self->relations->merge_readings( $kept, $deleted, $combine_char );
        
        # Do the deletion deed.
        if( $combine_char ) {
@@ -245,25 +237,11 @@ sub has_path {
        return $self->sequence->has_edge_attribute( $source, $target, $wit );
 }
 
-### Relationship logic
-
 =head2 add_relationship( $reading1, $reading2, $definition )
 
 Adds the specified relationship between the two readings.  A relationship
-is transitive (i.e. undirected), and must have the following attributes
-specified in the hashref $definition:
-
-=over 4
-
-=item * type - Can be one of spelling, orthographic, grammatical, meaning, repetition, transposition.  The first three are only valid relationships between readings that occur at the same point in the text.
-
-=item * non_correctable - (Optional) True if the reading would not have been corrected independently.
-
-=item * non_independent - (Optional) True if the variant is unlikely to have occurred independently in unrelated witnesses.
-
-=item * global - (Optional) A meta-attribute, to set the same relationship between readings with the same text whenever they occur in the same place.
-
-=back
+is transitive (i.e. undirected); the options for its definition may be found
+in Text::Tradition::Collation::Relationship.
 
 =cut
 
@@ -272,74 +250,27 @@ specified in the hashref $definition:
 
 sub add_relationship {
        my $self = shift;
-    my( $source, $target, $options ) = $self->_stringify_args( @_ );
-
-       # Check the options
-       if( !defined $options->{'type'} ||
-               $options->{'type'} !~ /^(spelling|orthographic|grammatical|meaning|lexical|repetition|transposition)$/i ) {
-               my $t = $options->{'type'} ? $options->{'type'} : '';
-               return( undef, "Invalid or missing type " . $options->{'type'} );
-       }
-       unless ( $options->{'type'} =~ /^(repetition|transposition)$/ ) {
-               $options->{'colocated'} = 1;
-       }
-       
-    # Make sure there is not another relationship between these two
-    # readings already
-    if( $self->relations->has_edge( $source, $target ) ) {
-               return ( undef, "Relationship already exists between these readings" );
-    }
-    if( !$self->relationship_valid( $source, $target, $options->{'type'} ) ) {
-        return ( undef, 'Relationship creates witness loop' );
-    }
+    my( $source, $target, $opts ) = $self->_stringify_args( @_ );
+    my( $ret, @vectors ) = $self->relations->add_relationship( $source, 
+       $self->reading( $source ), $target, $self->reading( $target ), $opts );
+    # Force a full rank recalculation every time. Yuck.
+    $self->calculate_ranks() if $ret && $self->end->has_rank;
+    return( $ret, @vectors );
+}
 
-       my @vector = ( $source, $target );
-       $self->relations->add_edge( @vector );
-       $self->relations->set_edge_attributes( @vector, $options );
-    
-    # TODO Handle global relationship setting
+=head2 reading_witnesses( $reading )
 
-    return( 1, @vector );
-}
+Return a list of sigils corresponding to the witnesses in which the reading appears.
 
-sub relationship_valid {
-    my( $self, $source, $target, $rel ) = @_;
-    if( $rel eq 'repetition' ) {
-       return 1;
-       } elsif ( $rel eq 'transposition' ) {
-               # Check that the two readings do not appear in the same witness.
-               my %seen_wits;
-               map { $seen_wits{$_} = 1 } $self->reading_witnesses( $source );
-               foreach my $w ( $self->reading_witnesses( $target ) ) {
-                       return 0 if $seen_wits{$w};
-               }
-               return 1;
-       } else {
-               # Check that linking the source and target in a relationship won't lead
-               # to a path loop for any witness.  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' ) );
-               my %pr_ids;
-               map { $pr_ids{ $_ } = 1 } @proposed_related;
-       
-               # None of these proposed related readings should have a neighbor that
-               # is also in proposed_related.
-               foreach my $pr ( keys %pr_ids ) {
-                       foreach my $neighbor( $self->sequence->neighbors( $pr ) ) {
-                               return 0 if exists $pr_ids{$neighbor};
-                       }
-               }               
-               return 1;
-       }
-}
+=cut
 
-# Return a list of the witnesses in which the reading appears.
 sub reading_witnesses {
        my( $self, $reading ) = @_;
        # We need only check either the incoming or the outgoing edges; I have
-       # arbitrarily chosen "incoming".
+       # arbitrarily chosen "incoming".  Thus, special-case the start node.
+       if( $reading eq $self->start ) {
+               return map { $_->sigil } $self->tradition->witnesses;
+       }
        my %all_witnesses;
        foreach my $e ( $self->sequence->edges_to( $reading ) ) {
                my $wits = $self->sequence->get_edge_attributes( @$e );
@@ -348,36 +279,15 @@ sub reading_witnesses {
        return keys %all_witnesses;
 }
 
-sub related_readings {
-       my( $self, $reading, $colocated ) = @_;
-       my $return_object;
-       if( ref( $reading ) eq 'Text::Tradition::Collation::Reading' ) {
-               $reading = $reading->id;
-               $return_object = 1;
-#              print STDERR "Returning related objects\n";
-#      } else {
-#              print STDERR "Returning related object names\n";
-       }
-       my @related = $self->relations->all_reachable( $reading );
-       if( $colocated ) {
-               my @colo = grep { $self->relations->has_edge_attribute( $reading, $_, 'colocated' ) } @related;
-               @related = @colo;
-       } 
-       return $return_object ? map { $self->reading( $_ ) } @related : @related;
-}
-
 =head2 Output method(s)
 
 =over
 
 =item B<as_svg>
 
-print $graph->as_svg( $recalculate );
+print $collation->as_svg();
 
-Returns an SVG string that represents the graph.  Uses GraphViz to do
-this, because Graph::Easy doesn\'t cope well with long graphs. Unless
-$recalculate is passed (and is a true value), the method will return a
-cached copy of the SVG after the first call to the method.
+Returns an SVG string that represents the graph, via as_dot and graphviz.
 
 =cut
 
@@ -397,9 +307,41 @@ sub as_svg {
     return $svg;
 }
 
+=item B<svg_subgraph>
+
+print $collation->svg_subgraph( $from, $to )
+
+Returns an SVG string that represents the portion of the graph given by the
+specified range.  The $from and $to variables refer to ranks within the graph.
+
+=cut
+
+sub svg_subgraph {
+    my( $self, $from, $to ) = @_;
+    
+    my $dot = $self->as_dot( $from, $to );
+    unless( $dot ) {
+       warn "Could not output a graph with range $from - $to";
+       return;
+    }
+    
+    my @cmd = qw/dot -Tsvg/;
+    my( $svg, $err );
+    my $dotfile = File::Temp->new();
+    ## TODO REMOVE
+    # $dotfile->unlink_on_destroy(0);
+    binmode $dotfile, ':utf8';
+    print $dotfile $dot;
+    push( @cmd, $dotfile->filename );
+    run( \@cmd, ">", binary(), \$svg );
+    $svg = decode_utf8( $svg );
+    return $svg;
+}
+
+
 =item B<as_dot>
 
-print $graph->as_dot( $view, $recalculate );
+print $collation->as_dot();
 
 Returns a string that is the collation graph expressed in dot
 (i.e. GraphViz) format.  The 'view' argument determines what kind of
@@ -411,19 +353,46 @@ graph is produced.
 =cut
 
 sub as_dot {
-    my( $self, $view ) = @_;
-    $view = 'sequence' unless $view;
+    my( $self, $startrank, $endrank ) = @_;
+    
+    # Check the arguments
+    if( $startrank ) {
+       return if $endrank && $startrank > $endrank;
+       return if $startrank > $self->end->rank;
+       }
+       if( defined $endrank ) {
+               return if $endrank < 0;
+       }
+       
     # TODO consider making some of these things configurable
     my $graph_name = $self->tradition->name;
     $graph_name =~ s/[^\w\s]//g;
     $graph_name = join( '_', split( /\s+/, $graph_name ) );
     my $dot = sprintf( "digraph %s {\n", $graph_name );
     $dot .= "\tedge [ arrowhead=open ];\n";
-    $dot .= "\tgraph [ rankdir=LR ];\n";
+    $dot .= "\tgraph [ rankdir=LR,bgcolor=none ];\n";
     $dot .= sprintf( "\tnode [ fontsize=%d, fillcolor=%s, style=%s, shape=%s ];\n",
                      11, "white", "filled", "ellipse" );
 
+       # Output substitute start/end readings if necessary
+       if( $startrank ) {
+               $dot .= "\t\"#SUBSTART#\" [ label=\"...\" ];\n";
+       }
+       if( $endrank ) {
+               $dot .= "\t\"#SUBEND#\" [ label=\"...\" ];\n";  
+       }
+       my %used;  # Keep track of the readings that actually appear in the graph
+       my %subedges;
+       my %subend;
     foreach my $reading ( $self->readings ) {
+       # Only output readings within our rank range.
+       next if $startrank && $reading->rank < $startrank;
+       next if $endrank && $reading->rank > $endrank;
+        $used{$reading->id} = 1;
+        $subedges{$reading->id} = '#SUBSTART#' 
+               if $startrank && $startrank == $reading->rank;
+        $subedges{$reading->id} = '#SUBEND#' 
+               if $endrank && $endrank == $reading->rank;
         # Need not output nodes without separate labels
         next if $reading->id eq $reading->text;
         my $label = $reading->text;
@@ -431,18 +400,38 @@ sub as_dot {
         $dot .= sprintf( "\t\"%s\" [ label=\"%s\" ];\n", $reading->id, $label );
     }
     
-    # TODO do something sensible for relationships
-
-    my @edges = $self->paths;
-    foreach my $edge ( @edges ) {
-        my %variables = ( 'color' => '#000000',
+    # Add substitute start and end edges if necessary
+    foreach my $node ( keys %subedges ) {
+               my @vector = ( $subedges{$node}, $node );
+               @vector = reverse( @vector ) if $vector[0] =~ /END/;
+       my $witstr = join( ', ', sort $self->reading_witnesses( $self->reading( $node ) ) );
+       my %variables = ( 'color' => '#000000',
                           'fontcolor' => '#000000',
-                          'label' => join( ', ', $self->path_display_label( $edge ) ),
+                          'label' => $witstr,
             );
         my $varopts = join( ', ', map { $_.'="'.$variables{$_}.'"' } sort keys %variables );
-        $dot .= sprintf( "\t\"%s\" -> \"%s\" [ %s ];\n",
-                         $edge->[0], $edge->[1], $varopts );
+               $dot .= sprintf( "\t\"%s\" -> \"%s\" [ %s ];\n", @vector, $varopts );
+       }
+       
+       # Add the real edges
+    my @edges = $self->paths;
+    foreach my $edge ( @edges ) {
+       # Do we need to output this edge?
+       if( $used{$edge->[0]} && $used{$edge->[1]} ) {;
+                       my %variables = ( 'color' => '#000000',
+                                                         'fontcolor' => '#000000',
+                                                         'label' => join( ', ', $self->path_display_label( $edge ) ),
+                               );
+                       my $varopts = join( ', ', map { $_.'="'.$variables{$_}.'"' } sort keys %variables );
+                       # Account for the rank gap if necessary
+                       my $rankgap = $self->reading( $edge->[1] )->rank 
+                               - $self->reading( $edge->[0] )->rank;
+                       $varopts .= ", minlen=$rankgap" if $rankgap > 1;
+                       $dot .= sprintf( "\t\"%s\" -> \"%s\" [ %s ];\n",
+                                                        $edge->[0], $edge->[1], $varopts );
+        }
     }
+    
     $dot .= "}\n";
     return $dot;
 }
@@ -472,7 +461,7 @@ sub path_display_label {
 
 =item B<as_graphml>
 
-print $graph->as_graphml( $recalculate )
+print $collation->as_graphml( $recalculate )
 
 Returns a GraphML representation of the collation graph, with
 transposition information and position information. Unless
@@ -534,7 +523,7 @@ sub as_graphml {
     my $edi = 0;
     my %edge_data_keys;
     my %edge_data = (
-       class => 'string',                              # Path or relationship?
+       class => 'string',                              # Class, deprecated soon
        witness => 'string',                    # ID/label for a path
        relationship => 'string',               # ID/label for a relationship
        extra => 'boolean',                             # Path key
@@ -552,26 +541,27 @@ sub as_graphml {
     }
 
     # Add the collation graph itself
-    my $graph = $root->addNewChild( $graphml_ns, 'graph' );
-    $graph->setAttribute( 'edgedefault', 'directed' );
-    $graph->setAttribute( 'id', $self->tradition->name );
-    $graph->setAttribute( 'parse.edgeids', 'canonical' );
-    $graph->setAttribute( 'parse.edges', scalar($self->paths) );
-    $graph->setAttribute( 'parse.nodeids', 'canonical' );
-    $graph->setAttribute( 'parse.nodes', scalar($self->readings) );
-    $graph->setAttribute( 'parse.order', 'nodesfirst' );
-    
+    my $sgraph = $root->addNewChild( $graphml_ns, 'graph' );
+    $sgraph->setAttribute( 'edgedefault', 'directed' );
+    $sgraph->setAttribute( 'id', $self->tradition->name );
+    $sgraph->setAttribute( 'parse.edgeids', 'canonical' );
+    $sgraph->setAttribute( 'parse.edges', scalar($self->paths) );
+    $sgraph->setAttribute( 'parse.nodeids', 'canonical' );
+    $sgraph->setAttribute( 'parse.nodes', scalar($self->readings) );
+    $sgraph->setAttribute( 'parse.order', 'nodesfirst' );
+           
     # Collation attribute data
     foreach my $datum ( @graph_attributes ) {
-       my $value = $datum eq 'version' ? '2.0' : $self->$datum;
-               _add_graphml_data( $graph, $graph_data_keys{$datum}, $value );
+       my $value = $datum eq 'version' ? '3.0' : $self->$datum;
+               _add_graphml_data( $sgraph, $graph_data_keys{$datum}, $value );
        }
 
     my $node_ctr = 0;
     my %node_hash;
     # Add our readings to the graph
     foreach my $n ( sort { $a->id cmp $b->id } $self->readings ) {
-        my $node_el = $graph->addNewChild( $graphml_ns, 'node' );
+       # Add to the main graph
+        my $node_el = $sgraph->addNewChild( $graphml_ns, 'node' );
         my $node_xmlid = 'n' . $node_ctr++;
         $node_hash{ $n->id } = $node_xmlid;
         $node_el->setAttribute( 'id', $node_xmlid );
@@ -582,7 +572,7 @@ sub as_graphml {
         }
     }
 
-    # Add the path edges
+    # Add the path edges to the sequence graph
     my $edge_ctr = 0;
     foreach my $e ( sort { $a->[0] cmp $b->[0] } $self->sequence->edges() ) {
        # We add an edge in the graphml for every witness in $e.
@@ -590,12 +580,10 @@ sub as_graphml {
                        my( $id, $from, $to ) = ( 'e'.$edge_ctr++,
                                                                                $node_hash{ $e->[0] },
                                                                                $node_hash{ $e->[1] } );
-                       my $edge_el = $graph->addNewChild( $graphml_ns, 'edge' );
+                       my $edge_el = $sgraph->addNewChild( $graphml_ns, 'edge' );
                        $edge_el->setAttribute( 'source', $from );
                        $edge_el->setAttribute( 'target', $to );
                        $edge_el->setAttribute( 'id', $id );
-                       # Add the edge class
-                       _add_graphml_data( $edge_el, $edge_data_keys{'class'}, 'path' );
                        
                        # It's a witness path, so add the witness
                        my $base = $wit;
@@ -609,34 +597,12 @@ sub as_graphml {
                                _add_graphml_data( $edge_el, $edge_data_keys{'extra'}, $aclabel );
                        }
                        _add_graphml_data( $edge_el, $edge_data_keys{'witness'}, $base );
+                       _add_graphml_data( $edge_el, $edge_data_keys{'class'}, 'path' );
                }
        }
        
-       # Add the relationship edges
-       foreach my $e ( sort { $a->[0] cmp $b->[0] } $self->relationships ) {
-               my( $id, $from, $to ) = ( 'e'.$edge_ctr++,
-                                                                       $node_hash{ $e->[0] },
-                                                                       $node_hash{ $e->[1] } );
-               my $edge_el = $graph->addNewChild( $graphml_ns, 'edge' );
-               $edge_el->setAttribute( 'source', $from );
-               $edge_el->setAttribute( 'target', $to );
-               $edge_el->setAttribute( 'id', $id );
-               # Add the edge class
-               _add_graphml_data( $edge_el, $edge_data_keys{'class'}, 'relationship' );
-               
-               my $data = $self->relations->get_edge_attributes( @$e );
-               # It's a relationship, so save the relationship data
-               _add_graphml_data( $edge_el, $edge_data_keys{'relationship'}, $data->{type} );
-               _add_graphml_data( $edge_el, $edge_data_keys{'colocated'}, $data->{colocated} );
-               if( exists $data->{non_correctable} ) {
-                       _add_graphml_data( $edge_el, $edge_data_keys{'non_correctable'}, 
-                               $data->{non_correctable} );
-               }
-               if( exists $data->{non_independent} ) {
-                       _add_graphml_data( $edge_el, $edge_data_keys{'non_independent'}, 
-                               $data->{non_independent} );
-               }
-    }
+       # Add the relationship graph to the XML
+       $self->relations->as_graphml( $root );
 
     # Save and return the thing
     my $result = decode_utf8( $graphml->toString(1) );
@@ -653,12 +619,10 @@ sub _add_graphml_data {
 
 =item B<as_csv>
 
-print $graph->as_csv( $recalculate )
+print $collation->as_csv( $recalculate )
 
 Returns a CSV alignment table representation of the collation graph, one
-row per witness (or witness uncorrected.) Unless $recalculate is passed
-(and is a true value), the method will return a cached copy of the CSV
-after the first call to the method.
+row per witness (or witness uncorrected.) 
 
 =cut
 
@@ -667,15 +631,39 @@ sub as_csv {
     my $table = $self->make_alignment_table;
     my $csv = Text::CSV_XS->new( { binary => 1, quote_null => 0 } );    
     my @result;
-    foreach my $row ( @$table ) {
-        $csv->combine( @$row );
+    # Make the header row
+    $csv->combine( map { $_->{'witness'} } @{$table->{'alignment'}} );
+       push( @result, decode_utf8( $csv->string ) );
+    # Make the rest of the rows
+    foreach my $idx ( 0 .. $table->{'length'} - 1 ) {
+       my @rowobjs = map { $_->{'tokens'}->[$idx] } @{$table->{'alignment'}};
+       my @row = map { $_ ? $_->{'t'} : $_ } @rowobjs;
+        $csv->combine( @row );
         push( @result, decode_utf8( $csv->string ) );
     }
     return join( "\n", @result );
 }
 
-# Make an alignment table - $noderefs controls whether the objects
-# in the table are the nodes or simply their readings.
+=item B<make_alignment_table>
+
+my $table = $collation->make_alignment_table( $use_refs, \@wits_to_include )
+
+Return a reference to an alignment table, in a slightly enhanced CollateX
+format which looks like this:
+
+ $table = { alignment => [ { witness => "SIGIL", 
+                             tokens => [ { t => "READINGTEXT" }, ... ] },
+                           { witness => "SIG2", 
+                             tokens => [ { t => "READINGTEXT" }, ... ] },
+                           ... ],
+            length => TEXTLEN };
+
+If $use_refs is set to 1, the reading object is returned in the table 
+instead of READINGTEXT; if not, the text of the reading is returned.
+If $wits_to_include is set to a hashref, only the witnesses whose sigil
+keys have a true hash value will be included.
+
+=cut
 
 sub make_alignment_table {
     my( $self, $noderefs, $include ) = @_;
@@ -683,49 +671,40 @@ sub make_alignment_table {
         warn "Need a linear graph in order to make an alignment table";
         return;
     }
-    my $table;
-    $DB::single = 1;
+    my $table = { 'alignment' => [], 'length' => $self->end->rank - 1 };
     my @all_pos = ( 1 .. $self->end->rank - 1 );
-    foreach my $wit ( $self->tradition->witnesses ) {
+    foreach my $wit ( sort { $a->sigil cmp $b->sigil } $self->tradition->witnesses ) {
+       if( $include ) {
+               next unless $include->{$wit->sigil};
+       }
         # print STDERR "Making witness row(s) for " . $wit->sigil . "\n";
         my @wit_path = $self->reading_sequence( $self->start, $self->end, $wit->sigil );
         my @row = _make_witness_row( \@wit_path, \@all_pos, $noderefs );
-        unshift( @row, $wit->sigil );
-        push( @$table, \@row );
+        push( @{$table->{'alignment'}}, 
+               { 'witness' => $wit->sigil, 'tokens' => \@row } );
         if( $wit->is_layered ) {
                my @wit_ac_path = $self->reading_sequence( $self->start, $self->end, 
                        $wit->sigil.$self->ac_label, $wit->sigil );
             my @ac_row = _make_witness_row( \@wit_ac_path, \@all_pos, $noderefs );
-            unshift( @ac_row, $wit->sigil . $self->ac_label );
-            push( @$table, \@ac_row );
+                       push( @{$table->{'alignment'}},
+                               { 'witness' => $wit->sigil.$self->ac_label, 'tokens' => \@ac_row } );
         }           
     }
-
-    if( $include ) {
-        my $winnowed = [];
-        # Winnow out the rows for any witness not included.
-        foreach my $row ( @$table ) {
-            next unless $include->{$row->[0]};
-            push( @$winnowed, $row );
-        }
-        $table = $winnowed;
-    }
-
-    # Return a table where the witnesses read in columns rather than rows.
-    my $turned = _turn_table( $table );
-    # TODO We should really go through and delete empty rows.
-    return $turned;
+       return $table;
 }
 
 sub _make_witness_row {
     my( $path, $positions, $noderefs ) = @_;
     my %char_hash;
     map { $char_hash{$_} = undef } @$positions;
+    my $debug = 0;
     foreach my $rdg ( @$path ) {
         my $rtext = $rdg->text;
         $rtext = '#LACUNA#' if $rdg->is_lacuna;
+        print STDERR "rank " . $rdg->rank . "\n" if $debug;
         # print STDERR "No rank for " . $rdg->id . "\n" unless defined $rdg->rank;
-        $char_hash{$rdg->rank} = $noderefs ? $rdg : $rtext;
+        $char_hash{$rdg->rank} = $noderefs ? { 't' => $rdg } 
+                                                                          : { 't' => $rtext };
     }
     my @row = map { $char_hash{$_} } @$positions;
     # Fill in lacuna markers for undef spots in the row
@@ -735,7 +714,7 @@ sub _make_witness_row {
         # If we are using node reference, make the lacuna node appear many times
         # in the table.  If not, use the lacuna tag.
         if( $last_el && _el_is_lacuna( $last_el ) && !defined $el ) {
-            $el = $noderefs ? $last_el : '#LACUNA#';
+            $el = $noderefs ? $last_el : { 't' => '#LACUNA#' };
         }
         push( @filled_row, $el );
         $last_el = $el;
@@ -746,9 +725,9 @@ sub _make_witness_row {
 # Tiny utility function to say if a table element is a lacuna
 sub _el_is_lacuna {
     my $el = shift;
-    return 1 if $el eq '#LACUNA#';
-    return 1 if ref( $el ) eq 'Text::Tradition::Collation::Reading'
-        && $el->is_lacuna;
+    return 1 if $el->{'t'} eq '#LACUNA#';
+    return 1 if ref( $el->{'t'} ) eq 'Text::Tradition::Collation::Reading'
+        && $el->{'t'}->is_lacuna;
     return 0;
 }
 
@@ -788,7 +767,7 @@ Returns the end of the collation, a meta-reading with label '#END#'.
 
 =item B<reading_sequence>
 
-my @readings = $graph->reading_sequence( $first, $last, $path[, $alt_path] );
+my @readings = $collation->reading_sequence( $first, $last, $path[, $alt_path] );
 
 Returns the ordered list of readings, starting with $first and ending
 with $last, along the given witness path.  If no path is specified,
@@ -831,7 +810,7 @@ sub reading_sequence {
 
 =item B<next_reading>
 
-my $next_reading = $graph->next_reading( $reading, $witpath );
+my $next_reading = $collation->next_reading( $reading, $witpath );
 
 Returns the reading that follows the given reading along the given witness
 path.  
@@ -842,12 +821,13 @@ sub next_reading {
     # Return the successor via the corresponding path.
     my $self = shift;
     my $answer = $self->_find_linked_reading( 'next', @_ );
+       return undef unless $answer;
     return $self->reading( $answer );
 }
 
 =item B<prior_reading>
 
-my $prior_reading = $graph->prior_reading( $reading, $witpath );
+my $prior_reading = $collation->prior_reading( $reading, $witpath );
 
 Returns the reading that precedes the given reading along the given witness
 path.  
@@ -896,7 +876,7 @@ sub _find_linked_reading {
         if $base_le;
 
     # Got this far? We have no appropriate path.
-    warn "Could not find $direction node from " . $node->label 
+    warn "Could not find $direction node from " . $node->id 
         . " along path $path";
     return undef;
 }
@@ -923,7 +903,7 @@ sub _is_within {
 sub make_witness_paths {
     my( $self ) = @_;
     foreach my $wit ( $self->tradition->witnesses ) {
-        print STDERR "Making path for " . $wit->sigil . "\n";
+        # print STDERR "Making path for " . $wit->sigil . "\n";
         $self->make_witness_path( $wit );
     }
 }
@@ -1050,7 +1030,7 @@ sub flatten_ranks {
         my $key = $rdg->rank . "||" . $rdg->text;
         if( exists $unique_rank_rdg{$key} ) {
             # Combine!
-            print STDERR "Combining readings at same rank: $key\n";
+            # print STDERR "Combining readings at same rank: $key\n";
             $self->merge_readings( $unique_rank_rdg{$key}, $rdg );
         } else {
             $unique_rank_rdg{$key} = $rdg;
@@ -1070,6 +1050,68 @@ sub witnesses_of_label {
     return @answer;
 }    
 
+=begin testing
+
+use Text::Tradition;
+
+my $cxfile = 't/data/Collatex-16.xml';
+my $t = Text::Tradition->new( 
+    'name'  => 'inline', 
+    'input' => 'CollateX',
+    'file'  => $cxfile,
+    );
+my $c = $t->collation;
+
+is( $c->common_predecessor( $c->reading('n9'), $c->reading('n23') )->id, 
+    'n20', "Found correct common predecessor" );
+is( $c->common_successor( $c->reading('n9'), $c->reading('n23') )->id, 
+    '#END#', "Found correct common successor" );
+
+is( $c->common_predecessor( $c->reading('n19'), $c->reading('n17') )->id, 
+    'n16', "Found correct common predecessor for readings on same path" );
+is( $c->common_successor( $c->reading('n21'), $c->reading('n26') )->id, 
+    '#END#', "Found correct common successor for readings on same path" );
+
+=end testing
+
+=cut
+
+## Return the closest reading that is a predecessor of both the given readings.
+sub common_predecessor {
+       my $self = shift;
+       return $self->common_in_path( @_, 'predecessors' );
+}
+
+sub common_successor {
+       my $self = shift;
+       return $self->common_in_path( @_, 'successors' );
+}
+
+sub common_in_path {
+       my( $self, $r1, $r2, $dir ) = @_;
+       my $iter = $r1->rank > $r2->rank ? $r1->rank : $r2->rank;
+       $iter = $self->end->rank - $iter if $dir eq 'successors';
+       my @candidates;
+       my @last_checked = ( $r1, $r2 );
+       my %all_seen;
+       while( !@candidates ) {
+               my @new_lc;
+               foreach my $lc ( @last_checked ) {
+                       foreach my $p ( $lc->$dir ) {
+                               if( $all_seen{$p->id} ) {
+                                       push( @candidates, $p );
+                               } else {
+                                       $all_seen{$p->id} = 1;
+                                       push( @new_lc, $p );
+                               }
+                       }
+               }
+               @last_checked = @new_lc;
+       }
+       my @answer = sort { $a->rank <=> $b->rank } @candidates;
+       return $dir eq 'predecessors' ? pop( @answer ) : shift ( @answer );
+}
+
 no Moose;
 __PACKAGE__->meta->make_immutable;
 
@@ -1077,8 +1119,6 @@ __PACKAGE__->meta->make_immutable;
 
 =over
 
-=item * Rationalize edge classes
-
-=item * Port the internal graph from Graph::Easy to Graph
+=item * Think about making Relationship objects again
 
 =back