Changeset 27234 for gs2-extensions/parallel-building/trunk

Timestamp:

2013-04-19T09:56:17+12:00 (11 years ago)

Author:

jmt12

Message:

renamed prepare_build_recipe() to the more meaningful prepareIndexRecipe() - plus I prefer java formatting

Location:

gs2-extensions/parallel-building/trunk/src/perllib

Files:

• parallelbasebuilder.pm (modified) (1 diff)
• parallellucenebuilder.pm (modified) (3 diffs)

gs2-extensions/parallel-building/trunk/src/perllib/parallelbasebuilder.pm

@@ -49 +49 @@
 # /** new() **/
 
-# /** @function prepareBuildRecipe()
+# /** @function prepareIndexRecipe()
+#  * @param $self
+#  * @author jmt12
 #  */
-sub prepareBuildRecipe
+sub prepareIndexRecipe
 {
   my ($self) = @_;
   my $outhandle = $self->{'outhandle'};
-  print $outhandle "WARNING: prepare_build_recipe() should be implemented in subclass!!";
+  print $outhandle "WARNING: prepareIndexRecipe() should be implemented in subclass!!";
 }
-# /** prepareBuildRecipe() **/
+# /** prepareIndexRecipe() **/
 
 1;

gs2-extensions/parallel-building/trunk/src/perllib/parallellucenebuilder.pm

@@ -28 +28 @@
 ###########################################################################
 
-# @author John Thompson, Waikato DL Research group
+# @author David Bainbridge and Katherine Don, Waikato DL Research group
+# @author John Rowe, DL Consulting Ltd.
+# @author John Thompson, DL Consulting Ltd.
+# @author John Thompson [jmt12], Waikato DL Research group
+
 package parallellucenebuilder;
 
@@ -40 +44 @@
 }
 
+# /** @function new()
+#  */
 sub new
 {
@@ -46 +52 @@
   return bless($self, $class);
 }
+# /** new() **/
 
-# The three main 'modes' in Lucene builds are completely independent, while
-# index building can be further split by level [jmt12]
-sub prepare_build_recipe
+# /** @function prepareIndexRecipe()
+#  * The three main 'modes' in Lucene builds are completely independent, while
+#  * index building can be further split by level
+#  * @param $self
+#  * @param $collection
+#  * @param $recipe a reference to an array of recipe 'steps'
+#  * @author jmt12
+#  */
+sub prepareIndexRecipe
 {
-  my ($self, $collection, $recipe_ref) = @_;
+  my ($self, $collection, $recipe) = @_;
   my $outhandle = $self->{'outhandle'};
   my $verbosity = $self->{'verbosity'};
   # 1. Compressing the text
-  push(@{$recipe_ref}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode compress_text ' . $collection});
+  push(@{$recipe}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode compress_text ' . $collection});
   # 2. Info database building
-  push(@{$recipe_ref}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode infodb ' . $collection});
+  push(@{$recipe}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode infodb ' . $collection});
   # 3. Now one command each for each level of index required
   foreach my $level (keys %{$self->{'levels'}})
   {
-    push(@{$recipe_ref}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode build_index -indexlevel ' . $level . ' ' . $collection});
+    push(@{$recipe}, {'command'=>'buildcol.pl -keepold -verbosity ' . $verbosity . ' -mode build_index -indexlevel ' . $level . ' ' . $collection});
   }
   # Complete!
 }
-# /** prepare_build_recipe() **/
+# /** prepareIndexRecipe() **/
 
 1;