gov.nih.nlm.nls.stmt.CmdLine

Class CmdLineArgsConfig

java.lang.Object

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

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

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

Direct Known Subclasses:

Lsf, MapTool, NormTool, Smt, Stmt

public abstract class CmdLineArgsConfig
extends CmdLineArgs

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

• config information option (-ci)
• help menu option (-h)
• option hierarchy structure (-hs)
• prompt option (-p)
• tool version option (-v)
• configuration option (-x)

History:

Version:

V-2015

Author:

NLM Lexical Systems Group

Field Summary

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

flagHelpList_, 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
CmdLineArgsConfig() Create a tool object (default).

Method Summary

Methods

Modifier and Type	Method and Description
protected void	AddConfigInfoKey(java.lang.String configIntoKey)
protected void	ExecuteOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem optionItem, gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption)
protected Configuration	GetConfig()
protected Configuration	GetConfig(java.lang.String configFile, java.lang.String defaultConfigFile)
protected boolean	GetConfigBoolean(java.lang.String name)
protected java.lang.String	GetConfigInfo()
protected int	GetConfigInt(java.lang.String name)
protected java.lang.String	GetConfigStr(java.lang.String name)
protected java.lang.String	GetToolName()
protected void	HelpMenu()
protected void	SetDefaultConfigFile(java.lang.String defaultConfigFile)
protected void	SetOptionFlags()
protected void	SetToolDescription(java.lang.String toolDescription)
protected void	SetToolName(java.lang.String toolName)
protected void	SetToolVersion(java.lang.String toolVersion)
protected void	SetValues()

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

AddOptionHelpMenu, CheckOption, ExecuteLocalOption, GetOptions, PreProcess, ResizeWithSpace, SetLocalDefaultOption, SetLocalFlagStr, SetLocalOptions, SetSystemOptionFullName, 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

Constructor Detail

CmdLineArgsConfig

public CmdLineArgsConfig()

Create a tool object (default).

Method Detail

SetDefaultConfigFile

protected void SetDefaultConfigFile(java.lang.String defaultConfigFile)

SetToolName

protected void SetToolName(java.lang.String toolName)

GetToolName

protected java.lang.String GetToolName()

SetToolVersion

protected void SetToolVersion(java.lang.String toolVersion)

SetToolDescription

protected void SetToolDescription(java.lang.String toolDescription)

GetConfig

protected Configuration GetConfig()

GetConfig

protected Configuration GetConfig(java.lang.String configFile,
                      java.lang.String defaultConfigFile)

GetConfigStr

protected java.lang.String GetConfigStr(java.lang.String name)

GetConfigInt

protected int GetConfigInt(java.lang.String name)

GetConfigBoolean

protected boolean GetConfigBoolean(java.lang.String name)

HelpMenu

protected void HelpMenu()

Overrides:

HelpMenu in class CmdLineArgs

SetOptionFlags

protected void SetOptionFlags()

Overrides:

SetOptionFlags in class CmdLineArgs

ExecuteOption

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

Overrides:

ExecuteOption in class CmdLineArgs

GetConfigInfo

protected java.lang.String GetConfigInfo()

SetValues

protected void SetValues()

Overrides:

SetValues in class CmdLineArgs

AddConfigInfoKey

protected void AddConfigInfoKey(java.lang.String configIntoKey)