com.psec.util

Class Parm

java.lang.Object

com.psec.util.Parm

public class Parm
extends java.lang.Object

Table based Parms Handler

The Parm class and its nested classes and interfaces provide a mechanism that allows for convenient and consistent table based program arguments handling and processing.

The Parm[] table is matched against the invokation arguments. Errors are reported (such as the absence of a mandatory field).

If the arguments parse is successful, the class run method is invoked.

The Parm Table

The Parm table consists of an array of Parm objects, each constructed using an anonymous instance of the Parm.PS interface.

The result of the parse is the customized Parm.Opt object where each field is populated according to the String[] args parameter provided to the class main method.

To improving the readability of the table, the symbolic names are short so that each option can be conveniently specified on one text line.

Input Conventions

• Keywords are lower case, specified in any order
• The last quietly overides the former in the case of duplication on the command line
• Values are input -key space(s) value
• Booleans are input -key (no trailing value)
• Properies are input -defname=value (no intermediate space, -def used by convention but it could be some other such as -D

Example for below

-brief c:\temp\brief.json.txt -out d:\1\out.xlsx -what basic -red -negfmt "()"

Working Example

Here is an example of a table used in DemoExcel.

  private static class Opt extends Parm.Opt {
    public String  sStr1;
    public String  sOut;
    public String  sInp;
    public String  sWhat;
    public String  sNegFmt;
    public boolean bRed;
  }

  static Opt oOPT = new Opt();

  static Parm[] oParms = {
     new Parm(new Parm.PS(){public void set(String sN) {oOPT.bHelp=true; }},     ".","-h",      null,      "Generate this Help Information that you are now reading")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.sBrief=sN;}},       "m","-brief",  "brief",   "path for Brief output")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.sOut=sN;}},         "m","-out",    "file",    "Target output name")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.sInp=sN;}},         ".","-inp",    "file",    "input template file")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.sWhat=sN;}},        "m","-what",   "string",  "What we are to run")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.bRed=true; }},      ".","-red",      null,    "Show negative numbers in red")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.sNegFmt=sN; }},     ".","-negfmt",  "string", "Negative format")
    ,new Parm(new Parm.PS(){public void set(String sN) {oOPT.addProp(sN);}},     ".","-def",    "key=val", "Defined Property string")
  };

  public static void main(String[] sArgs) {
    oOPT.mainStart(oParms,sArgs,new DemoExcel());
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parm.Brief Brief base class used by PSEC routines.
static interface	Parm.MainRun The interface class to be implemented by the class that is to be called by the mainStart method.
static class	Parm.Opt Base class for option set.
static interface	Parm.PS Interface used to process each option.

Constructor Summary

Constructors

Constructor and Description
Parm(Parm.PS oSet, java.lang.String sFlag, java.lang.String sParm, java.lang.String sExtra, java.lang.String sDesc) Parm instance constructor.

Method Summary

Modifier and Type	Method and Description
static void	printHelp(Parm[] oParms, java.lang.String sTitle) List the options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parm

public Parm(Parm.PS oSet,
            java.lang.String sFlag,
            java.lang.String sParm,
            java.lang.String sExtra,
            java.lang.String sDesc)

Parm instance constructor. The table definition employs the following conventions to create a consistent and predictable interface with the user. Each Parm entry follows the convention.

The constructor has 4 input parameters.

1. The the anonymous function constructed to move (and possibly transform) the input string to the target object as detailed in the set method.
2. The

Parameters:

oSet - The anonymous used to transform the input data.

sFlag - The mandatory flag.

sParm - The external key string used to recognize the parameter.

sExtra - A string to indicate the value type.

sDesc - A brief description that helps the user know the meaning and format of the data.

Method Detail

printHelp

public static void printHelp(Parm[] oParms,
                             java.lang.String sTitle)

List the options. The options are listed in a manner suitable for a user to know how to supply a particular parameter.

Parameters:

oParms - the Parm[] table;

sTitle - The list title.