[jira] [Resolved] (OODT-360) Add supported for CmdLineAction detailed help description

["Brian Foster (Resolved) (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/OODT-360?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brian Foster resolved OODT-360.
-------------------------------

    Resolution: Fixed

- submitted in r1209988
                
> Add supported for CmdLineAction detailed help description
> ---------------------------------------------------------
>
>                 Key: OODT-360
>                 URL: https://issues.apache.org/jira/browse/OODT-360
>             Project: OODT
>          Issue Type: Improvement
>    Affects Versions: 0.3
>         Environment: none
>            Reporter: Brian Foster
>            Assignee: Brian Foster
>            Priority: Minor
>             Fix For: 0.4
>
>
> For example action help would print something more along the lines of:
> $ ./filemgr-client -h SqlQuery
> {code}
> ** Action Help for 'SqlQuery' **
> DESCRIPTION:
>  This supports sending queries to the FileManager in form of SELECT <Elements> FROM <ProductTypes> WHERE <where-clause>, where:
>   - <Elements>: is a comma separated list of Element names; may also be * which represents all Elements
>   - <ProductTypes>: is a comma separated list of ProductType names; may also be * which represents all ProductTypes
>   - <where-clause>: is an optional Element name filter supporting the following:
>      * AND and OR boolean operators
>      * () grouping of queries
>      * <element-name> == '<element-value>'
>      * <element-name> < '<element-value>'
>      * <element-name> > '<element-value>'
>      * <element-name> <= '<element-value>'
>      * <element-name> >= '<element-value>'
> USAGE:
>  - Required:
>     -u [--url] <url>
>     -op [--operation]
>       -sql [--sqlQuery] (required)
>     -q [--query] <query>
>  - Optional:
>     -f [--filter]
>       -prMetKey [--priorityMetKey] <metadata-key> (required)
>       -algor [--algor] <classpath> (required)
>       -sdtMetKey [--startDateTimeMetKey] <metadata-key> (required)
>       -conv [--converter] <classpath> (optional)
>       -edtMetKey [--endDateTimeMetKey] <metadata-key> (required)
>     -of [--outputFormat] <output-format-string>
>     -sb [--sortBy] <metadata field>
>     -dlmtr [--delimiter] <delimiter-string>
> EXAMPLES:
>  (Assume you have a ProductType, GenericFile, which supports the Elements: Filename, NominalDate, Group, and DataVersion)
>   SELECT Filename FROM GenericFile WHERE (NominalDate == '2011-20-10' OR NominalDate == '2011-20-11') AND Group == 'Test' AND DataVersion > '1.0'
>  (Returns all Products in FileManager -- use with care)
>   SELECT * FROM *
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira