lib/Text/Tradition/Parser/Self.pm

   1 package Text::Tradition::Parser::Self;
   2
   3 use strict;
   4 use warnings;
   5 use Text::Tradition::Parser::GraphML qw/ graphml_parse /;
   6
   7 =head1 NAME
   8
   9 Text::Tradition::Parser::GraphML
  10
  11 =head1 SYNOPSIS
  12
  13   use Text::Tradition;
  14
  15   my $t_from_file = Text::Tradition->new(
  16     'name' => 'my text',
  17     'input' => 'Self',
  18     'file' => '/path/to/tradition.xml'
  19     );
  20
  21   my $t_from_string = Text::Tradition->new(
  22     'name' => 'my text',
  23     'input' => 'Self',
  24     'string' => $tradition_xml,
  25     );
  26
  27 =head1 DESCRIPTION
  28
  29 Parser module for Text::Tradition to read in its own GraphML output format.
  30 GraphML is a relatively simple graph description language; a 'graph' element
  31 can have 'node' and 'edge' elements, and each of these can have simple 'data'
  32 elements for attributes to be saved.
  33
  34 The graph itself has attributes as in the Collation object:
  35
  36 =over
  37
  38 =item * linear
  39
  40 =item * ac_label
  41
  42 =item * baselabel
  43
  44 =item * wit_list_separator
  45
  46 =back
  47
  48 The node objects have the following attributes:
  49
  50 =over
  51
  52 =item * name
  53
  54 =item * reading
  55
  56 =item * identical
  57
  58 =item * rank
  59
  60 =item * class
  61
  62 =back
  63
  64 The edge objects have the following attributes:
  65
  66 =over
  67
  68 =item * class
  69
  70 =item * witness (for 'path' class edges)
  71
  72 =item * extra   (for 'path' class edges)
  73
  74 =item * relationship    (for 'relationship' class edges)
  75
  76 =item * equal_rank      (for 'relationship' class edges)
  77
  78 =item * non_correctable (for 'relationship' class edges)
  79
  80 =item * non_independent (for 'relationship' class edges)
  81
  82 =back
  83
  84 =head1 METHODS
  85
  86 =head2 B<parse>
  87
  88 parse( $graph, $opts );
  89
  90 Takes an initialized Text::Tradition object and a set of options; creates
  91 the appropriate nodes and edges on the graph.  The options hash should
  92 include either a 'file' argument or a 'string' argument, depending on the
  93 source of the XML to be parsed.
  94
  95 =begin testing
  96
  97 use Text::Tradition;
  98 binmode STDOUT, ":utf8";
  99 binmode STDERR, ":utf8";
 100 eval { no warnings; binmode $DB::OUT, ":utf8"; };
 101
 102 my $tradition = 't/data/florilegium_graphml.xml';
 103 my $t = Text::Tradition->new(
 104     'name'  => 'inline',
 105     'input' => 'Self',
 106     'file'  => $tradition,
 107     );
 108
 109 is( ref( $t ), 'Text::Tradition', "Parsed our own GraphML" );
 110 if( $t ) {
 111     is( scalar $t->collation->readings, 319, "Collation has all readings" );
 112     is( scalar $t->collation->paths, 376, "Collation has all paths" );
 113     is( scalar $t->witnesses, 13, "Collation has all witnesses" );
 114 }
 115
 116 =end testing
 117
 118 =cut
 119
 120 my( $IDKEY, $TOKENKEY, $TRANSPOS_KEY, $RANK_KEY, $CLASS_KEY,
 121         $START_KEY, $END_KEY, $LACUNA_KEY,
 122         $SOURCE_KEY, $TARGET_KEY, $WITNESS_KEY, $EXTRA_KEY, $RELATIONSHIP_KEY,
 123         $COLO_KEY, $CORRECT_KEY, $INDEP_KEY )
 124     = qw/ name reading identical rank class
 125           is_start is_end is_lacuna
 126           source target witness extra relationship
 127           equal_rank non_correctable non_independent /;
 128
 129 sub parse {
 130     my( $tradition, $opts ) = @_;
 131     my $graph_data = graphml_parse( $opts );
 132
 133     my $collation = $tradition->collation;
 134     my %witnesses;
 135
 136     # Set up the graph-global attributes.  They will appear in the
 137     # hash under their accessor names.
 138     my $use_version;
 139     print STDERR "Setting graph globals\n";
 140     $tradition->name( $graph_data->{'name'} );
 141         $DB::single = 1;
 142     foreach my $gkey ( keys %{$graph_data->{'global'}} ) {
 143                 my $val = $graph_data->{'global'}->{$gkey};
 144                 if( $gkey eq 'version' ) {
 145                         $use_version = $val;
 146                 } else {
 147                         $collation->$gkey( $val );
 148                 }
 149         }
 150         if( $use_version ) {
 151                 # Many of our tags changed.
 152                 $IDKEY = 'id';
 153                 $TOKENKEY = 'text';
 154                 $COLO_KEY = 'colocated';
 155         }
 156
 157     # Add the nodes to the graph.
 158
 159     my $extra_data = {}; # Keep track of data that needs to be processed
 160                          # after the nodes & edges are created.
 161     print STDERR "Adding graph nodes\n";
 162     foreach my $n ( @{$graph_data->{'nodes'}} ) {
 163         # If it is the start or end node, we already have one, so skip it.
 164         next if defined $n->{$START_KEY} || defined $n->{$END_KEY};
 165
 166         # First extract the data that we can use without reference to
 167         # anything else.
 168         my %node_data = %$n; # Need $n itself untouched for edge processing
 169
 170         # Create the node.
 171         my $reading_options = {
 172                 'id' => delete $node_data{$IDKEY},
 173                 'is_lacuna' => delete $node_data{$LACUNA_KEY},
 174                 };
 175         my $rank = delete $node_data{$RANK_KEY};
 176                 $reading_options->{'rank'} = $rank if $rank;
 177                 my $text = delete $node_data{$TOKENKEY};
 178                 $reading_options->{'text'} = $text if $text;
 179
 180         # This is a horrible hack for backwards compatibility.
 181         unless( $use_version ) {
 182                         $reading_options->{'is_lacuna'} = 1
 183                                 if $reading_options->{'text'} =~ /^\#LACUNA/;
 184                 }
 185
 186                 delete $node_data{$CLASS_KEY}; # Not actually used
 187                 my $gnode = $collation->add_reading( $reading_options );
 188
 189         # Now save the data that we need for post-processing,
 190         # if it exists. TODO this is unneeded after conversion
 191         if ( keys %node_data ) {
 192             $extra_data->{$gnode->id} = \%node_data
 193         }
 194     }
 195
 196     # Now add the edges.
 197     print STDERR "Adding graph edges\n";
 198     foreach my $e ( @{$graph_data->{'edges'}} ) {
 199         my $from = $e->{$SOURCE_KEY};
 200         my $to = $e->{$TARGET_KEY};
 201         my $class = $e->{$CLASS_KEY};
 202
 203         # We may have more information depending on the class.
 204         if( $class eq 'path' ) {
 205                 # We need the witness, and whether it is an 'extra' reading path.
 206                 my $wit = $e->{$WITNESS_KEY};
 207                 warn "No witness label on path edge!" unless $wit;
 208                 my $extra = $e->{$EXTRA_KEY};
 209                 my $label = $wit . ( $extra ? $collation->ac_label : '' );
 210                 $collation->add_path( $from->{$IDKEY}, $to->{$IDKEY}, $label );
 211                 # Add the witness if we don't have it already.
 212                         unless( $witnesses{$wit} ) {
 213                                 $tradition->add_witness( sigil => $wit );
 214                                 $witnesses{$wit} = 1;
 215                         }
 216                         $tradition->witness( $wit )->is_layered( 1 ) if $extra;
 217         } elsif( $class eq 'relationship' ) {
 218                 # We need the metadata about the relationship.
 219                 my $opts = { 'type' => $e->{$RELATIONSHIP_KEY} };
 220                 $opts->{$COLO_KEY} = $e->{$COLO_KEY}
 221                         if exists $e->{$COLO_KEY};
 222                 $opts->{$CORRECT_KEY} = $e->{$CORRECT_KEY}
 223                         if exists $e->{$CORRECT_KEY};
 224                 $opts->{$INDEP_KEY} = $e->{$INDEP_KEY}
 225                         if exists $e->{$INDEP_KEY};
 226                 warn "No relationship type for relationship edge!" unless $opts->{'type'};
 227                 my( $ok, @result ) = $collation->add_relationship( $from->{$IDKEY}, $to->{$IDKEY}, $opts );
 228                 unless( $ok ) {
 229                         warn "Did not add relationship: @result";
 230                 }
 231         }
 232     }
 233
 234     ## Deal with node information (transposition, relationships, etc.) that
 235     ## needs to be processed after all the nodes are created.
 236     ## TODO unneeded after conversion
 237     unless( $use_version ) {
 238                 print STDERR "Adding second-pass node data\n";
 239                 foreach my $nkey ( keys %$extra_data ) {
 240                         foreach my $edkey ( keys %{$extra_data->{$nkey}} ) {
 241                                 my $this_reading = $collation->reading( $nkey );
 242                                 if( $edkey eq $TRANSPOS_KEY ) {
 243                                         my $other_reading = $collation->reading( $extra_data->{$nkey}->{$edkey} );
 244                                         $this_reading->set_identical( $other_reading );
 245                                 } else {
 246                                         warn "Unfamiliar reading node data $edkey for $nkey";
 247                                 }
 248                         }
 249                 }
 250     }
 251 }
 252
 253 1;
 254
 255 =head1 BUGS / TODO
 256
 257 =over
 258
 259 =item * Make this into a stream parser with GraphML
 260
 261 =item * Simply field -> attribute correspondence for nodes and edges
 262
 263 =item * Share key name constants with Collation.pm
 264
 265 =back
 266
 267 =head1 LICENSE
 268
 269 This package is free software and is provided "as is" without express
 270 or implied warranty.  You can redistribute it and/or modify it under
 271 the same terms as Perl itself.
 272
 273 =head1 AUTHOR
 274
 275 Tara L Andrews E<lt>aurum@cpan.orgE<gt>