Changeset 24547

Timestamp:

2011-09-02T16:28:57+12:00 (13 years ago)

Author:

ak19

Message:

Added new abstract plugin MetadataRead that defines can_process_this_file_for_metadata that MetadataPlugin subclasses can inherit (if MetadataRead is listed first in the ISA inheritance list) and which will then override the one defined in BasePlugin. For now committing MARC, ISIS and OAIPlugins which now additionally inherit from MetadataRead. Other metadataPlugins also need to be committed.

Location:

main/trunk/greenstone2/perllib/plugins

Files:

• ISISPlugin.pm (modified) (2 diffs)
• MARCPlugin.pm (modified) (3 diffs)
• MARCXMLPlugin.pm (modified) (2 diffs)
• MetadataCSVPlugin.pm (modified) (2 diffs)
• MetadataRead.pm (added)
• OAIPlugin.pm (modified) (2 diffs)

main/trunk/greenstone2/perllib/plugins/ISISPlugin.pm

@@ -30 +30 @@
 use multiread;
 use SplitTextFile;
+use MetadataRead;
 
 use strict;
@@ -35 +36 @@
 
 # ISISPlugin is a sub-class of SplitTextFile.
+# methods with identical signatures take precedence in the order given in the ISA list.
 sub BEGIN {
-    @ISISPlugin::ISA = ('SplitTextFile');
+    @ISISPlugin::ISA = ('MetadataRead', 'SplitTextFile');
 }
 

main/trunk/greenstone2/perllib/plugins/MARCPlugin.pm

@@ -28 +28 @@
 
 use SplitTextFile;
+use MetadataRead;
 
 use unicode;
@@ -36 +37 @@
 no strict 'refs'; # allow filehandles to be variables and viceversa
 
+# methods defined in superclasses that have the same signature take
+# precedence in the order given in the ISA list. We want MetaPlugins to
+# call MetadataRead's can_process_this_file_for_metadata(), rather than
+# calling BasePlugin's version of the same method, so list inherited 
+# superclasses in this order.
 sub BEGIN {
-    @MARCPlugin::ISA = ('SplitTextFile');
+    @MARCPlugin::ISA = ('MetadataRead', 'SplitTextFile'); 
     unshift (@INC, "$ENV{'GSDLHOME'}/perllib/cpan");
 }
@@ -84 +90 @@
     push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
     push(@{$hashArgOptLists->{"OptList"}},$options);
-
+ 
+    # this does nothing yet, but if member vars are ever added
+    # to MetadataRead, will need to do this anyway:
+    #new MetadataRead($pluginlist, $inputargs, $hashArgOptLists);
     my $self = new SplitTextFile($pluginlist, $inputargs, $hashArgOptLists);
 

main/trunk/greenstone2/perllib/plugins/MARCXMLPlugin.pm

@@ -32 +32 @@
 use ReadXMLFile;
 use ReadTextFile;
+use MetadataRead;
 use marcmapping;
 
@@ -37 +38 @@
 no strict 'refs'; # allow filehandles to be variables and viceversa
 
+# methods with identical signatures take precedence in the order given in the ISA list.
 sub BEGIN {
-    @MARCXMLPlugin::ISA = ('ReadXMLFile', 'ReadTextFile');
+    @MARCXMLPlugin::ISA = ('MetadataRead', 'ReadXMLFile', 'ReadTextFile');
 }
 

main/trunk/greenstone2/perllib/plugins/MetadataCSVPlugin.pm

@@ -29 +29 @@
 
 use BasePlugin;
+use MetadataRead;
+
 use strict;
 no strict 'refs';
@@ -34 +36 @@
 
 
+# methods with identical signatures take precedence in the order given in the ISA list.
 sub BEGIN {
-    @MetadataCSVPlugin::ISA = ('BasePlugin');
+    @MetadataCSVPlugin::ISA = ('MetadataRead', 'BasePlugin');
 }
 

main/trunk/greenstone2/perllib/plugins/OAIPlugin.pm

@@ -36 +36 @@
 use ReadTextFile; # needed for subroutine textcat_get_language_encoding
 use metadatautil;
-
+use MetadataRead;
+
+# methods with identical signatures take precedence in the order given in the ISA list.
 sub BEGIN {
-    @OAIPlugin::ISA = ('ReadXMLFile', 'ReadTextFile');
+    @OAIPlugin::ISA = ('MetadataRead', 'ReadXMLFile', 'ReadTextFile');
 }
 
@@ -183 +185 @@
     $self->{'metadata_xml'} .= $_;
     }
-}
-
-sub can_process_this_file_for_metadata {
-    my $self = shift(@_);
-
-    return $self->can_process_this_file(@_);
 }