gov.nih.nlm.nls.stmt.CmdLine

Class CmdLineArgs

java.lang.Object

gov.nih.nlm.nls.stmt.CmdLine.CmdLine

gov.nih.nlm.nls.stmt.CmdLine.CmdLineArgs

Direct Known Subclasses:

CmdLineArgsConfig

public abstract class CmdLineArgs
extends CmdLine

This class provides command line object with arguments options. In addition to basic interactive interface of command line, it also read in arguments. It comes with following standard args options.

• help menu option (-h)
• option hierarchy structure (-hs)
• prompt option (-p)

History:

Notes: It is illegal to have multiple arguments with one of them is NONE
For example: -a:aa~aaa~aab~NONE
Instead, it should change to -a:aa~aaa~aab~none

Version:

V-2015

Author:

NLM Lexical Systems Group

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,java.lang.String>	flagHelpList_
protected gov.nih.nlm.nls.lvg.CmdLineSyntax.Option	option_
protected gov.nih.nlm.nls.lvg.CmdLineSyntax.Option	systemOption_

Fields inherited from class gov.nih.nlm.nls.stmt.CmdLine.CmdLine

fileOutput_, inReader_, outWriter_, promptFlag_, promptStr_, quitStrList_, runFlag_

Constructor Summary

Constructors

Constructor and Description
CmdLineArgs() Create a tool object (default).

Method Summary

Methods

Modifier and Type	Method and Description
protected void	AddOptionHelpMenu(java.lang.String flag, java.lang.String helpMenu)
protected boolean	CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem, java.lang.String systemItemStr)
protected abstract void	ExecuteLocalOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem optionItem)
protected void	ExecuteOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem optionItem, gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption)
protected static java.util.Vector<java.lang.String>	GetOptions(java.lang.String inStr)
protected void	HelpMenu()
protected boolean	PreProcess(java.lang.String[] args)
protected java.lang.String	ResizeWithSpace(java.lang.String inStr, int size)
protected abstract void	SetLocalDefaultOption()
protected abstract java.lang.String	SetLocalFlagStr()
protected abstract void	SetLocalOptions()
protected void	SetOptionFlags()
protected void	SetSystemOptionFullName(java.lang.String item, java.lang.String fullName)
protected void	SetValues()
protected void	SetValuesByCmdLineOptions()

Methods inherited from class gov.nih.nlm.nls.stmt.CmdLine.CmdLine

CloseLocalObjs, CloseObjs, GetPromptFlag, InitLocalObjs, PostProcess, Println, Process, ProcessLine, Run, SetPrompStr, SetToolInfo, SetValuesByDefault

Methods inherited from class java.lang.Object

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

Field Detail

systemOption_

protected gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption_

option_

protected gov.nih.nlm.nls.lvg.CmdLineSyntax.Option option_

flagHelpList_

protected java.util.Hashtable<java.lang.String,java.lang.String> flagHelpList_

Constructor Detail

CmdLineArgs

public CmdLineArgs()

Create a tool object (default).

Method Detail

SetLocalFlagStr

protected abstract java.lang.String SetLocalFlagStr()

SetLocalOptions

protected abstract void SetLocalOptions()

ExecuteLocalOption

protected abstract void ExecuteLocalOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem optionItem)

SetLocalDefaultOption

protected abstract void SetLocalDefaultOption()

PreProcess

protected boolean PreProcess(java.lang.String[] args)

Overrides:

PreProcess in class CmdLine

AddOptionHelpMenu

protected void AddOptionHelpMenu(java.lang.String flag,
                     java.lang.String helpMenu)

SetSystemOptionFullName

protected void SetSystemOptionFullName(java.lang.String item,
                           java.lang.String fullName)

CheckOption

protected boolean CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem,
                  java.lang.String systemItemStr)

HelpMenu

protected void HelpMenu()

Overrides:

HelpMenu in class CmdLine

ResizeWithSpace

protected java.lang.String ResizeWithSpace(java.lang.String inStr,
                               int size)

SetOptionFlags

protected void SetOptionFlags()

SetValuesByCmdLineOptions

protected void SetValuesByCmdLineOptions()

GetOptions

protected static java.util.Vector<java.lang.String> GetOptions(java.lang.String inStr)

ExecuteOption

protected void ExecuteOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem optionItem,
                 gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption)

SetValues

protected void SetValues()

Overrides:

SetValues in class CmdLine