use vars qw( @EXPORT_OK );
@EXPORT_OK = qw( merge_base );
+=head1 NAME
+
+Text::Tradition::Parser::BaseText
+
+=head1 SYNOPSIS
+
+use Text::Tradition::Parser::BaseText qw( merge_base );
+merge_base( $graph, 'reference.txt', @apparatus_entries )
+
+=head1 DESCRIPTION
+
+For an overview of the package, see the documentation for the
+Text::Tradition::Graph module.
+
+This module is meant for use with certain of the other Parser classes
+- whenever a list of variants is given with reference to a base text,
+these must be joined into a single collation. The parser should
+therefore make a list of variants and their locations, and BaseText
+will join those listed variants onto the reference text.
+
+=head1 SUBROUTINES
+
+=over
+
+=item B<merge_base>
+
+merge_base( $graph, 'reference.txt', @apparatus_entries )
+
+Takes three arguments: a newly-initialized Text::Tradition::Graph
+object, a text file containing the reference text, and a list of
+variants (apparatus entries). Adds the base text to the graph, and
+joins the variants to that.
+
+The list of variants is an array of hash references; each hash takes
+the form
+ { '_id' => line reference,
+ 'rdg_0' => lemma reading,
+ 'rdg_1' => first variant,
+ ... # and so on until all distinct readings are listed
+ 'WitnessA' => 'rdg_0',
+ 'WitnessB' => 'rdg_1',
+ ... # and so on until all witnesses are listed with their readings
+ }
+
+Any hash key that is not of the form /^rdg_\d+$/ and that does not
+begin with an underscore is assumed to be a witness name. Any 'meta'
+information to be passed must be passed in a key with a leading
+underscore in its name.
+
+=cut
+
sub merge_base {
my( $graph, $base_file, @app_entries ) = @_;
my @base_line_starts = read_base( $base_file, $graph );
my( $line, $num ) = split( /\./, $app->{_id} );
# DEBUG with a short graph
# last if $line > 2;
- my $scrutinize = "21.8";
+ # DEBUG for problematic entries
+ my $scrutinize = "";
my $first_line_node = $base_line_starts[ $line ];
my $too_far = $base_line_starts[ $line+1 ];
# Now we have our lemma nodes; we add the variant nodes to the graph.
+ # Keep track of the start and end point of each reading for later
+ # node collapse.
+ my @readings = ( $lemma_start, $lemma_end );
+
# For each reading that is not rdg_0, we make a chain of nodes
# and connect them to the anchor. Edges are named after the mss
# that are relevant.
$graph->add_edge( $last_node, $graph->next_word( $lemma_end ),
$edge_name );
- # Now collate and collapse the identical nodes within the graph.
- collate_variant( $graph, $lemma_start, $lemma_end,
- $var_start, $last_node );
-
+ if( $var_start ) { # if it wasn't an empty reading
+ push( @readings, $var_start, $last_node );
+ }
}
+
+ # Now collate and collapse the identical nodes within the graph.
+ collate_variants( $graph, @readings );
}
## Now in theory I have a graph. I want to make it a little easier to
}
}
-# read_base: Takes a text file and a (presumed empty) graph object,
-# adds the words as simple linear nodes to the graph, and returns a
-# list of nodes that represent the beginning of lines. This graph is
-# now the starting point for application of apparatus entries in
-# merge_base, e.g. from a CSV file or a CTE file.
+=item B<read_base>
+
+my @line_beginnings = read_base( 'reference.txt', $graph );
+
+Takes a text file and a (presumed empty) graph object, adds the words
+as simple linear nodes to the graph, and returns a list of nodes that
+represent the beginning of lines. This graph is now the starting point
+for application of apparatus entries in merge_base, e.g. from a CSV
+file or a Classical Text Editor file.
+
+=cut
sub read_base {
my( $base_file, $graph ) = @_;
$started = 1;
}
if( $last_node ) {
- $graph->add_edge( $last_node, $node, "base text" );
+ my $edge = $graph->add_edge( $last_node, $node, "base text" );
+ $edge->set_attribute( 'class', 'basetext' );
$last_node = $node;
} # TODO there should be no else here...
}
return( @$lineref_array );
}
+=item B<collate_variants>
+
+collate_variants( $graph, @readings )
-## Helper methods for merge_base
+Given a set of readings in the form
+( lemma_start, lemma_end, rdg1_start, rdg1_end, ... )
+walks through each to identify those nodes that are identical. The
+graph is a Text::Tradition::Graph object; the elements of @readings are
+Graph::Easy::Node objects that appear on the graph.
-sub collate_variant {
- my( $graph, $lemma_start, $lemma_end, $var_start, $var_end ) = @_;
- # If var_start is undef, then the variant is an omission and
- # there's nothing to collate. Return.
- return unless $var_start;
+TODO: Handle collapsed and non-collapsed transpositions.
- # I want to look at the nodes in the variant and lemma, and
- # collapse nodes that are the same word. This is mini-collation.
- my %collapsed = ();
- # There will only be one outgoing edge at first, so this is safe.
- my @out = $var_start->outgoing();
- my $var_label = $out[0]->label();
+=cut
- my @lemma_nodes;
+sub collate_variants {
+ my( $graph, @readings ) = @_;
+ my $lemma_start = shift @readings;
+ my $lemma_end = shift @readings;
+ my $detranspose = 1;
+
+ # Start the list of distinct nodes with those nodes in the lemma.
+ my @distinct_nodes;
while( $lemma_start ne $lemma_end ) {
- push( @lemma_nodes, $lemma_start );
+ push( @distinct_nodes, [ $lemma_start, 'base text' ] );
$lemma_start = $graph->next_word( $lemma_start );
}
- push( @lemma_nodes, $lemma_end );
+ push( @distinct_nodes, [ $lemma_end, 'base text' ] );
- my @variant_nodes;
- while( $var_start ne $var_end ) {
- push( @variant_nodes, $var_start );
- $var_start = $graph->next_word( $var_start, $var_label );
- }
- push( @variant_nodes, $var_end );
-
- # Go through the variant nodes, and if we find a lemma node that
- # hasn't yet been collapsed with a node, equate them.
-
- foreach my $w ( @variant_nodes ) {
- my $word = $w->label();
- foreach my $l ( @lemma_nodes ) {
- if( $word eq cmp_str( $l ) ) {
- next if exists( $collapsed{ $l->label } )
- && $collapsed{ $l->label } eq $l;
- # Collapse the nodes.
- printf STDERR "Merging nodes %s/%s and %s/%s\n",
- $l->name, $l->label, $w->name, $w->label;
- $graph->merge_nodes( $l, $w );
- $collapsed{ $l->label } = $l;
- # Now collapse any multiple edges to and from the node.
- # Rely on the presence of the 'base text' edge.
- remove_duplicate_edges( $graph, $graph->prior_word( $l ), $l );
- remove_duplicate_edges( $graph, $l, $graph->next_word( $l ) );
+
+ while( scalar @readings ) {
+ my( $var_start, $var_end ) = splice( @readings, 0, 2 );
+
+ # I want to look at the nodes in the variant and lemma, and
+ # collapse nodes that are the same word. This is mini-collation.
+ # Each word in the 'main' list can only be collapsed once with a
+ # word from the current reading.
+ my %collapsed = ();
+
+ # Get the label. There will only be one outgoing edge to start
+ # with, so this is safe.
+ my @out = $var_start->outgoing();
+ my $var_label = $out[0]->label();
+
+ my @variant_nodes;
+ while( $var_start ne $var_end ) {
+ push( @variant_nodes, $var_start );
+ $var_start = $graph->next_word( $var_start, $var_label );
+ }
+ push( @variant_nodes, $var_end );
+
+ # Go through the variant nodes, and if we find a lemma node that
+ # hasn't yet been collapsed with a node, equate them. If we do
+ # not, keep them to push onto the end of all_nodes.
+ my @remaining_nodes;
+ my $last_index = 0;
+ foreach my $w ( @variant_nodes ) {
+ my $word = $w->label();
+ my $matched = 0;
+ foreach my $idx ( $last_index .. $#distinct_nodes ) {
+ my( $l, $edgelabel ) = @{$distinct_nodes[$idx]};
+ if( $word eq cmp_str( $l ) ) {
+ next if exists( $collapsed{ $l->label } )
+ && $collapsed{ $l->label } eq $l;
+ $matched = 1;
+ $last_index = $idx if $detranspose;
+ # Collapse the nodes.
+ printf STDERR "Merging nodes %s/%s and %s/%s\n",
+ $l->name, $l->label, $w->name, $w->label;
+ $graph->merge_nodes( $l, $w );
+ $collapsed{ $l->label } = $l;
+ # Now collapse any multiple edges to and from the node.
+ remove_duplicate_edges( $graph,
+ $graph->prior_word( $l, $edgelabel ), $l );
+ remove_duplicate_edges( $graph, $l,
+ $graph->next_word( $l, $edgelabel ) );
+ }
}
+ push( @remaining_nodes, [ $w, $var_label ] ) unless $matched;
}
+ push( @distinct_nodes, @remaining_nodes) if scalar( @remaining_nodes );
}
}
+=item B<remove_duplicate_edges>
+
+remove_duplicate_edges( $graph, $from, $to );
+
+Given two nodes, reduce the number of edges between those nodes to
+one. If neither edge represents a base text, combine their labels.
+
+=cut
+
sub remove_duplicate_edges {
my( $graph, $from, $to ) = @_;
my @edges = $from->edges_to( $to );
}
}
-# TODO need to make this configurable!
+=item B<cmp_str>
+
+Pretend you never saw this method. Really it needs to not be hardcoded.
+
+=cut
+
sub cmp_str {
my( $node ) = @_;
my $word = $node->label();
return $word;
}
+=back
+
+=head1 LICENSE
+
+This package is free software and is provided "as is" without express
+or implied warranty. You can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Tara L Andrews, aurum@cpan.org
+
+=cut
+
1;
projects / scpubgit/stemmatology.git / blobdiff