Changeset 15872 for gsdl/trunk/perllib/plugins/ReferPlugin.pm

Timestamp:

2008-06-05T09:29:32+12:00 (16 years ago)

Author:

kjdon

Message:

plugin overhaul: plugins renamed to xxPlugin, and in some cases the names are made more sensible. They now use the new base plugins. Hopefully we have better code reuse. Some of the plugins still need work done as I didn't want to spend another month doing this before committing it. Alos, I haven't really tested anything yet...

File:

• gsdl/trunk/perllib/plugins/ReferPlugin.pm (modified) (7 diffs)

gsdl/trunk/perllib/plugins/ReferPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# ReferPlug.pm - a plugin for bibliography records in Refer format
+# ReferPlugin.pm - a plugin for bibliography records in Refer format
 #
 # A component of the Greenstone digital library software
@@ -26 +26 @@
 ###########################################################################
 
-# ReferPlug reads bibliography files in Refer format.
+# ReferPlugin reads bibliography files in Refer format.
 #
 # by Gordon W. Paynter ([email protected]), November 2000
@@ -36 +36 @@
 #
 #
-# ReferPlug creates a document object for every reference in the file.
-# It is a subclass of SplitPlug, so if there are multiple records, all
+# ReferPlugin creates a document object for every reference in the file.
+# It is a subclass of SplitTextFile, so if there are multiple records, all
 # are read.
 #
@@ -61 +61 @@
 #
 
-# 12/05/02 Added usage datastructure - John Thompson
-
-package ReferPlug;
-
-use SplitPlug;
+package ReferPlugin;
+
+use SplitTextFile;
 use strict;
 no strict 'refs'; # allow filehandles to be variables and viceversa
 
-# ReferPlug is a sub-class of BasPlug.
+# ReferPlugin is a sub-class of BasePlugin.
 sub BEGIN {
-    @ReferPlug::ISA = ('SplitPlug');
+    @ReferPlugin::ISA = ('SplitTextFile');
 }
 
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{BasePlugin.process_exp}",
     'type' => "regexp",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" },
       { 'name' => "split_exp",
-    'desc' => "{SplitPlug.split_exp}",
+    'desc' => "{SplitTextFile.split_exp}",
     'type' => "regexp",
     'reqd' => "no",
@@ -87 +85 @@
       ];
 
-my $options = { 'name'     => "ReferPlug",
-        'desc'     => "{ReferPlug.desc}",
+my $options = { 'name'     => "ReferPlugin",
+        'desc'     => "{ReferPlugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -109 +107 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
-
-    my $self = new SplitPlug($pluginlist, $inputargs, $hashArgOptLists);
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
+
+    my $self = new SplitTextFile($pluginlist, $inputargs, $hashArgOptLists);
 
     return bless $self, $class;
@@ -130 +128 @@
     my $cursection = $doc_obj->get_top_section();
     # Report that we're processing the file
-    print STDERR "<Processing n='$file' p='ReferPlug'>\n" if ($gli);
-    print $outhandle "ReferPlug: processing $file\n"
+    print STDERR "<Processing n='$file' p='ReferPlugin'>\n" if ($gli);
+    print $outhandle "ReferPlugin: processing $file\n"
     if ($self->{'verbosity'}) > 1;