Add ability for various Packager plugins to report their "options" via command 
line
-----------------------------------------------------------------------------------

                 Key: DS-387
                 URL: http://jira.dspace.org/jira/browse/DS-387
             Project: DSpace 1.x
          Issue Type: Improvement
          Components: DSpace API
    Affects Versions: 1.5.2, 1.6.0
         Environment: Any command line interface
            Reporter: Tim Donohue
            Priority: Minor
         Attachments: PackagerOptions.patch

Currently, the various packager plugins (METS & PDF) have no way to report to 
users what options are available to be passed to the plugin (via the 'packager 
-o [option]=[value]' flag).

It'd be nice to allow a user to get a brief description of the valid options 
for each plugin via the commandline interface.  I've implemented a simple patch 
(see attached) which lets users do this as follows:

(1) running 'dspace packager -h' will output the normal Help information, 
including a list of all currently configured packager plugins (this feature 
already existed)

(2) running 'dspace packager -h -t METS' will report normal Help information, 
but will *also* output some additional options which are specific to the METS 
packager plugin.  Similarly, 'dspace packager -h -t PDF' would report any 
additional options which are specific to the PDF packager plugin.

The way this is implemented is to add a "getParameterHelp()" method to both the 
PackageIngester and PackageDisseminator interfaces.  Each implementing packager 
plugin is responsible for reporting any custom options in this 
"getParameterHelp()" method.

See the attached patch for further details.   (NOTE: This patch is very 
slightly dependent on DS-386 in that some of the line numbers in the patch are 
only correct if you already have installed DS-386.)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.dspace.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Dspace-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/dspace-devel

Reply via email to