Changeset 32543 for main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm

Timestamp:

2018-10-26T15:10:47+13:00 (6 years ago)

Author:

ak19

Message:

Tidying up and adjusting TODO statements

File:

• main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm (modified) (6 diffs)

main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm

@@ -40 +40 @@
 
 # TODO: SIGTERM rollback and disconnect?
-# TODO Q: what about verbosity for debugging
+# TODO Q: what about verbosity for debugging, instead of current situation of printing out upon debug set at the expense of writing to db
 # TODO Q: introduced site_name param to plugins and plugouts. Did I do it right? And should they have hiddengli = "yes"
 
-# this plugout does not output xml to a file, but outputs rows into a mysql table
+# this plugout does not output the metadata and/or fulltxt xml to a file,
+# but outputs rows into a mysql table for metadata and/or a table for fulltxt
 sub BEGIN {
     @GreenstoneSQLPlugout::ISA = ('GreenstoneXMLPlugout');
@@ -56 +57 @@
 
 # TODO Q: what is "group" in GreenstoneXMLPlugout?
-# TODO Q: site_name only exists for GS3. What about GS2?
-
 
 my $process_mode_list =
@@ -141 +140 @@
     #print STDERR "@@@@ proc_mode: " . $self->{'process_mode'} . "\n";
     
-    ########### TODO: these should be set from cmdline/GLI options to plugout #########
+    ########### TODO: deal with build mode #########
 
     $self->{'build_mode'} = "removeold";
@@ -236 +235 @@
 }
  
-# TODO: check arc-inf.db for whether each entry is to be deleted/indexed/reindexed/been indexed
+# TODO: check arc-inf.db for whether each entry is to be deleted/indexed/reindexed/been indexed?
+# That's only for indexing, not for this step which only generates the content in archives dir
 sub saveas {
     my $self = shift (@_);
@@ -253 +253 @@
 
     # TODO: also set debugging in begin()? Then stmts creating db and tables also sent to debug out and not executed
-
-    # TODO: remove unused old_unused_saveas from GreenstoneXMLPlugout
-    
-    
-    # 2. overriding saving behaviour to do what the superclass does PLUS saving to sql db    
-
-    #NOTE: if proc_mode == all, then "breadcrumbs" go into both meta and txt elements of doc.xml:
-    # statements pointing viewer to the sql db for contents
+   
+    
+    # 2. overriding saving behaviour to do what the superclass does (writing out doc.xml files,
+    # under new name of docsql.xml, with breadcrumbs pointing to sql db) PLUS saving to sql db    
+
+    # NOTE: if proc_mode == all, then "breadcrumbs" (statements pointing viewer to the sql db
+    # for contents) go into both meta and txt elements of doc.xml (docsql.xml specifically): 
     
-    # write the INVERSE into doc.xml as to what is written to the db    
+    # write the INVERSE into doc.xml as to what is written to the SQL db    
     my $docxml_output_options = { 'output' => docprint::OUTPUT_NONE };
     if($proc_mode eq "meta_only" ) { # since only meta to go into MySQL db, text will go into docxml
@@ -272 +271 @@
     # now we've prepared to write out whatever is meant to go into docxml
     # and can do actual the steps superclass GreenstoneXMLPlugout carries out to write out docxml
-    # So: write out the doc xml file for the current document
+    # So: write out the doc xml file, "docsql.xml", for the current document
     my $section_text = &docprint::get_section_xml($doc_obj, $docxml_output_options);
     print $docxml_outhandler $section_text;