org.optimizationservices.oscommon.localinterface
Class OSOption

java.lang.Object
  org.optimizationservices.oscommon.localinterface.OSOption

public class OSOption
extends java.lang.Object

The OSOption class is a local interface for storing Optimization Services options, especially solver service options. Its design follows the Optimization Services option Language (OSoL). All the data structures in this class are standards specified in OSoL. Developers can add service-specific options by extending this class.

Since:

OS 1.0

Version:

1.0, 03/14/2005

Author:

Robert Fourer, Jun Ma, Kipp Martin

See Also:

OSInstance, OSResult, OSAnalysis

Field Summary

GeneralOption	general general holds the general option specified by the OSoL Schema.
JobOption	job job holds the job option specified by the OSoL Schema.
OptimizationOption	optimization optimization holds the optimization option specified by the OSoL Schema.
OtherOption[]	other other holds an array of all other options specified by the OSoL Schema.
ServiceOption	service service holds the service option specified by the OSoL Schema.
SystemOption	system system holds the system option specified by the OSoL Schema.

Constructor Summary

OSOption()
Default constructor.

Method Summary

int	getConstraintNumber() Get constraint number.
java.lang.String	getContactAddress() Get the contact address to respond to the requester.
java.lang.String	getContactTransportType() Get the contact transport type to respond to the requester, smtp (for email), osp (for knocking back on the requester), etc.
java.lang.String[]	getDirectoriesToDelete() Get the directories to delete after running the job, which is a string array of paths.
java.lang.String[]	getDirectoriesToMake() Get the directories to make before running the job, which is a string array of paths.
java.lang.String[]	getFilesToCreate() Get the files to create before running the job, which is a string array of paths.
java.lang.String[]	getFilesToDelete() Get the files to delete after running the job, which is a string array of paths.
double[]	getInitialVariableValues() get initial variable values (double[]).
java.lang.String[]	getInputFilesToCopyFrom() Get the input files to copy from before running the job, which is a string array of paths.
java.lang.String[]	getInputFilesToCopyTo() Get the input files to copy to before running the job, which is a string array of paths.
java.lang.String[]	getInputFilesToMoveFrom() Get the input files to move from before running the job, which is a string array of paths.
java.lang.String[]	getInputFilesToMoveTo() Get the input files to move to before running the job, which is a string array of paths.
java.lang.String	getInstanceAddress() Get the instance address to get the instance.
java.lang.String	getInstanceLocationType() Get the instance location type to get the instance.
java.lang.String	getInstanceName() Get instance name.
java.lang.String[]	getJobDependencies() Get the dependencies of the current job, which is a string array of ids of the jobs that have run before the current job.
java.lang.String	getJobID() Get job ID.
double	getJobMaxTime() Get the maximum time (in seconds) before the job is terminated.
java.util.GregorianCalendar	getJobScheduledStartTime() Get the scheduled start time for the job.
java.lang.String	getLicense() Get license.
int	getObjectiveNumber() Get objective number.
java.util.Hashtable<java.lang.String,java.lang.String>	getOtherOptionDescriptions() get a hashmap of other option descriptions.
java.lang.String[]	getOtherOptionNames() get a string array of names of other options.
java.util.Hashtable<java.lang.String,java.lang.String>	getOtherOptionValues() get a hashmap of other option values.
java.lang.String[]	getOutputFilesToCopyFrom() Get the output files to copy from before running the job, which is a string array of paths.
java.lang.String[]	getOutputFilesToCopyTo() Get the output files to copy to before running the job, which is a string array of paths.
java.lang.String[]	getOutputFilesToMoveFrom() Get the output files to move from before running the job, which is a string array of paths.
java.lang.String[]	getOutputFilesToMoveTo() Get the output files to move to before running the job, which is a string array of paths.
java.lang.String	getPassword() Get the password.
java.lang.String[]	getProcessesToKill() Get the processes to kill after running the job, which is a string array of process names.
java.lang.String[]	getRequiredDirectoriesAndFiles() Get the required directories and files to run the job, which is a string array of paths.
java.lang.String	getServiceName() Get service name.
java.lang.String	getServiceType() Get the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent
java.lang.String	getServiceURI() Get service uri.
double	getSystemMinCPUSpeed() Get the system minimum cpu speed required to solve the job.
double	getSystemMinDiskSpace() Get the system minimum disk space required to solve the job.
double	getSystemMinMemorySize() Get the system minimum memory size required to solve the job.
java.lang.String	getUserName() Get the userName.
int	getVariableNumber() Get variable number.
static void	main(java.lang.String[] args) main for test purposes.
OSOption	readOSoL(java.lang.String osol, boolean isFile, boolean validate) read an OSoL instance and return and OSOption object.
boolean	setConstraintNumber(int constraintNumber) Set the constraint number.
boolean	setContactAddress(java.lang.String address) Set the contact address to respond to the requester.
boolean	setContactTransportType(java.lang.String transportType) Set the contact transport type to respond to the requester, smtp (for email), osp (for knocking back on the requester), etc.
boolean	setDirectoriesToDelete(java.lang.String[] paths) Set the directories to delete after running the job, which is a string array of paths.
boolean	setDirectoriesToMake(java.lang.String[] paths) Set the directories to make before running the job, which is a string array of paths.
boolean	setFilesToCreate(java.lang.String[] paths) Set the files to create before running the job, which is a string array of paths.
boolean	setFilesToDelete(java.lang.String[] paths) Set the files to delete after running the job, which is a string array of paths.
boolean	setInitialVariableValues(double[] initialVariableValues) Set initial variable values (double[]).
boolean	setInputFilesToCopyFrom(java.lang.String[] paths) Set the input files to copy from before running the job, which is a string array of paths.
boolean	setInputFilesToCopyTo(java.lang.String[] paths) Set the input files to copy to before running the job, which is a string array of paths.
boolean	setInputFilesToMoveFrom(java.lang.String[] paths) Set the input files to move from before running the job, which is a string array of paths.
boolean	setInputFilesToMoveTo(java.lang.String[] paths) Set the input files to move to before running the job, which is a string array of paths.
boolean	setInstanceAddress(java.lang.String address) Set the instance address to get the instance.
boolean	setInstanceLocationType(java.lang.String locationType) Set the instance location type to get the instance.
boolean	setInstanceName(java.lang.String instanceName) Set instance name.
boolean	setJobDependencies(java.lang.String[] jobIDs) Get the dependencies of the current job, which is a string array of ids of the jobs that have run before the current job.
boolean	setJobID(java.lang.String jobID) Set jobID.
boolean	setJobMaxTime(double maxTime) Set the maximum time before the job is terminated.
boolean	setJobScheduledStartTime(java.util.GregorianCalendar scheduledStartTime) Set the scheduled start time for the job.
boolean	setLicense(java.lang.String license) Set license.
boolean	setObjectiveNumber(int objectiveNumber) Set the objective number.
boolean	setOtherOptions(java.lang.String[] names, java.lang.String[] descriptions, java.lang.String[] values) set other options, with their names (required), descriptions (optional) and values (optional).
boolean	setOutputFilesToCopyFrom(java.lang.String[] paths) Set the output files to copy from before running the job, which is a string array of paths.
boolean	setOutputFilesToCopyTo(java.lang.String[] paths) Set the output files to copy to before running the job, which is a string array of paths.
boolean	setOutputFilesToMoveFrom(java.lang.String[] paths) Set the output files to move from before running the job, which is a string array of paths.
boolean	setOutputFilesToMoveTo(java.lang.String[] paths) Set the output files to move to before running the job, which is a string array of paths.
boolean	setPassword(java.lang.String password) Set the password.
boolean	setProcessesToKill(java.lang.String[] processNames) Set the processes to kill after running the job, which is a string array of paths.
boolean	setRequiredDirectoriesAndFiles(java.lang.String[] paths) Set the required directories and files to run the job, which is a string array of paths.
boolean	setServiceName(java.lang.String serviceName) Set service name.
boolean	setServiceType(java.lang.String type) Set the service type.
boolean	setServiceURI(java.lang.String serviceURI) Set service uri.
boolean	setSystemMinCPUSpeed(double minCPUSpeed) Set the the system minimum cpu speed required to solve the job.
boolean	setSystemMinDiskSpace(double minDiskSpace) Set the the system minimum disk space required to solve the job.
boolean	setSystemMinMemorySize(double minMemorySize) Set the the system minimum memory size required to solve the job.
boolean	setUserName(java.lang.String userName) Set the user name.
boolean	setVariableNumber(int variableNumber) Set the variable number.
java.lang.String	writeOSoL() write the OSOption to an osol xml string.

Methods inherited from class java.lang.Object

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

Field Detail

general

public GeneralOption general

general holds the general option specified by the OSoL Schema.

system

public SystemOption system

system holds the system option specified by the OSoL Schema.

service

public ServiceOption service

service holds the service option specified by the OSoL Schema.

job

public JobOption job

job holds the job option specified by the OSoL Schema.

optimization

public OptimizationOption optimization

optimization holds the optimization option specified by the OSoL Schema.

other

public OtherOption[] other

other holds an array of all other options specified by the OSoL Schema.

Constructor Detail

OSOption

public OSOption()

Default constructor.

Method Detail

readOSoL

public OSOption readOSoL(java.lang.String osol,
                         boolean isFile,
                         boolean validate)
                  throws java.lang.Exception

read an OSoL instance and return and OSOption object.

Parameters:

osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.

isFile - holds whether the osol string is a file name or a string that literally holds the osol contents.

validate - holds whether the reader should be validating against the schema or not.

Returns:

the OSOption object constructed from the OSoL String.

Throws:

java.lang.Exception - if there are errors in reading the string or setting the OSOption.

writeOSoL

public java.lang.String writeOSoL()
                           throws java.lang.Exception

write the OSOption to an osol xml string.

Returns:

the osol xml string.

Throws:

java.lang.Exception - if there are errors in writing the osol string.

getServiceName

public java.lang.String getServiceName()

Get service name.

Returns:

the service name.

setServiceName

public boolean setServiceName(java.lang.String serviceName)

Set service name.

Parameters:

serviceName - holds the name of the service.

Returns:

whether the service name is set successfully.

getServiceURI

public java.lang.String getServiceURI()

Get service uri.

Returns:

the service uri.

setServiceURI

public boolean setServiceURI(java.lang.String serviceURI)

Set service uri.

Parameters:

serviceURI - holds the uri of the service.

Returns:

whether the service uri is set successfully.

getInstanceName

public java.lang.String getInstanceName()

Get instance name.

Returns:

the instance name.

setInstanceName

public boolean setInstanceName(java.lang.String instanceName)

Set instance name.

Parameters:

instanceName - holds the name of the instance.

Returns:

whether the instance name is set successfully.

getInstanceLocationType

public java.lang.String getInstanceLocationType()

Get the instance location type to get the instance. e.g. local, http, ftp.

Returns:

the instance location type, null or empty string if none.

setInstanceLocationType

public boolean setInstanceLocationType(java.lang.String locationType)

Set the instance location type to get the instance.

Parameters:

locationType - holds the instance location type, e.g. local, http, ftp.

Returns:

whether the instance location type is set successfully.

getInstanceAddress

public java.lang.String getInstanceAddress()

Get the instance address to get the instance.

Returns:

the instance address, null or empty string if none.

setInstanceAddress

public boolean setInstanceAddress(java.lang.String address)

Set the instance address to get the instance.

Parameters:

address - holds the instance address.

Returns:

whether the instance address is set successfully.

getJobID

public java.lang.String getJobID()

Get job ID.

Returns:

the job ID, null or empty string if none.

setJobID

public boolean setJobID(java.lang.String jobID)

Set jobID.

Parameters:

jobID - holds the jobID.

Returns:

whether the jobID is set successfully.

getLicense

public java.lang.String getLicense()

Get license.

Returns:

the license, null or empty string if none.

setLicense

public boolean setLicense(java.lang.String license)

Set license.

Parameters:

license - holds the license required by the service.

Returns:

whether the license is set successfully.

getUserName

public java.lang.String getUserName()

Get the userName.

Returns:

the user name, null or empty string if none.

setUserName

public boolean setUserName(java.lang.String userName)

Set the user name.

Parameters:

userName - holds the user name required by the service.

Returns:

whether the user name is set successfully.

getPassword

public java.lang.String getPassword()

Get the password.

Returns:

the password, null or empty string if none.

setPassword

public boolean setPassword(java.lang.String password)

Set the password.

Parameters:

password - holds the password required by the service.

Returns:

whether the password is set successfully.

getContactTransportType

public java.lang.String getContactTransportType()

Get the contact transport type to respond to the requester, smtp (for email), osp (for knocking back on the requester), etc.

Returns:

the contact trasport type, null or empty string if none.

setContactTransportType

public boolean setContactTransportType(java.lang.String transportType)

Set the contact transport type to respond to the requester, smtp (for email), osp (for knocking back on the requester), etc.

Parameters:

transportType - holds the contact transport type.

Returns:

whether the contact transport type is set successfully.

getContactAddress

public java.lang.String getContactAddress()

Get the contact address to respond to the requester. For example it can be an email address if the contact transport type is smtp or a http uri if the contact transport type is osp (for knocking back on the requester), etc.

Returns:

the contact trasport address, null or empty string if none.

setContactAddress

public boolean setContactAddress(java.lang.String address)

Set the contact address to respond to the requester. For example it can be an email address if the contact transport type is smtp or a http uri if the contact transport type is osp (for knocking back on the requester), etc.

Parameters:

address - holds the contact address.

Returns:

whether the contact address is set successfully.

getSystemMinDiskSpace

public double getSystemMinDiskSpace()

Get the system minimum disk space required to solve the job.

Returns:

the system minimum disk space, 0.0 if none.

setSystemMinDiskSpace

public boolean setSystemMinDiskSpace(double minDiskSpace)

Set the the system minimum disk space required to solve the job.

Parameters:

minDiskSpace - holds the minimum disk space required to solve the job.

Returns:

whether the minimum disk space is set successfully.

getSystemMinMemorySize

public double getSystemMinMemorySize()

Get the system minimum memory size required to solve the job.

Returns:

the system minimum memory size, 0.0 if none.

setSystemMinMemorySize

public boolean setSystemMinMemorySize(double minMemorySize)

Set the the system minimum memory size required to solve the job.

Parameters:

minMemorySize - holds the minimum memory size required to solve the job.

Returns:

whether the minimum memory size is set successfully.

getSystemMinCPUSpeed

public double getSystemMinCPUSpeed()

Get the system minimum cpu speed required to solve the job.

Returns:

the system minimum cpu speed, 0.0 if none.

setSystemMinCPUSpeed

public boolean setSystemMinCPUSpeed(double minCPUSpeed)

Set the the system minimum cpu speed required to solve the job.

Parameters:

minCPUSpeed - holds the minimum cpu speed required to solve the job.

Returns:

whether the minimum cpu speed is set successfully.

getServiceType

public java.lang.String getServiceType()

Get the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent

Returns:

the service type; null or empty string if none.

setServiceType

public boolean setServiceType(java.lang.String type)

Set the service type.

Parameters:

type - holds the service type, which can be: solver, analyzer, scheduler, simulation, registry, modeler, agent

Returns:

whether the service type is set successfully or not.

getJobMaxTime

public double getJobMaxTime()

Get the maximum time (in seconds) before the job is terminated.

Returns:

the maximum time, Double.POSITIVE_INFINITY if none.

setJobMaxTime

public boolean setJobMaxTime(double maxTime)

Set the maximum time before the job is terminated.

Parameters:

maxTime - holds the maximum time in seconds.

Returns:

whether the maximum time is set successfully.

getJobScheduledStartTime

public java.util.GregorianCalendar getJobScheduledStartTime()

Get the scheduled start time for the job.

Returns:

the scheduled start time for the job, null or UNIX time (1970/1/1) if none.

setJobScheduledStartTime

public boolean setJobScheduledStartTime(java.util.GregorianCalendar scheduledStartTime)

Set the scheduled start time for the job.

Parameters:

scheduledStartTime - holds the scheduled start time for the job.

Returns:

whether the scheduled start time is set successfully.

getJobDependencies

public java.lang.String[] getJobDependencies()

Get the dependencies of the current job, which is a string array of ids of the jobs that have run before the current job.

Returns:

a string array of ids of the jobs that have to run before the current job.

setJobDependencies

public boolean setJobDependencies(java.lang.String[] jobIDs)

Get the dependencies of the current job, which is a string array of ids of the jobs that have run before the current job.

Parameters:

jobIDs - holds a string array of ids of the jobs that have run before the current job.

Returns:

whether the job dependencies are set successfully.

getRequiredDirectoriesAndFiles

public java.lang.String[] getRequiredDirectoriesAndFiles()

Get the required directories and files to run the job, which is a string array of paths.

Returns:

a string array of direcotry/file paths required to run the job.

setRequiredDirectoriesAndFiles

public boolean setRequiredDirectoriesAndFiles(java.lang.String[] paths)

Set the required directories and files to run the job, which is a string array of paths.

Parameters:

paths - holds a string array of directory/file paths required to run the job.

Returns:

whether the required directories and files are set successfully.

getDirectoriesToMake

public java.lang.String[] getDirectoriesToMake()

Get the directories to make before running the job, which is a string array of paths.

Returns:

a string array of direcotry paths to make.

setDirectoriesToMake

public boolean setDirectoriesToMake(java.lang.String[] paths)

Set the directories to make before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of directories to make before running the job.

Returns:

whether the directories to make are set successfully.

getFilesToCreate

public java.lang.String[] getFilesToCreate()

Get the files to create before running the job, which is a string array of paths.

Returns:

a string array of file paths to create.

setFilesToCreate

public boolean setFilesToCreate(java.lang.String[] paths)

Set the files to create before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of files to create before running the job.

Returns:

whether the files to create are set successfully.

getInputFilesToCopyFrom

public java.lang.String[] getInputFilesToCopyFrom()

Get the input files to copy from before running the job, which is a string array of paths.

Returns:

a string array of file paths to copy from.

setInputFilesToCopyFrom

public boolean setInputFilesToCopyFrom(java.lang.String[] paths)

Set the input files to copy from before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of input files to copy from before running the job.

Returns:

whether the input files to copy from are set successfully.

getInputFilesToCopyTo

public java.lang.String[] getInputFilesToCopyTo()

Get the input files to copy to before running the job, which is a string array of paths.

Returns:

a string array of file paths to copy to.

setInputFilesToCopyTo

public boolean setInputFilesToCopyTo(java.lang.String[] paths)

Set the input files to copy to before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of input files to copy to before running the job.

Returns:

whether the input files to copy to are set successfully.

getInputFilesToMoveFrom

public java.lang.String[] getInputFilesToMoveFrom()

Get the input files to move from before running the job, which is a string array of paths.

Returns:

a string array of file paths to move from.

setInputFilesToMoveFrom

public boolean setInputFilesToMoveFrom(java.lang.String[] paths)

Set the input files to move from before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of input files to move from before running the job.

Returns:

whether the input files to move from are set successfully.

getInputFilesToMoveTo

public java.lang.String[] getInputFilesToMoveTo()

Get the input files to move to before running the job, which is a string array of paths.

Returns:

a string array of file paths to move to.

setInputFilesToMoveTo

public boolean setInputFilesToMoveTo(java.lang.String[] paths)

Set the input files to move to before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of input files to move to before running the job.

Returns:

whether the input files to move to are set successfully.

getOutputFilesToCopyFrom

public java.lang.String[] getOutputFilesToCopyFrom()

Get the output files to copy from before running the job, which is a string array of paths.

Returns:

a string array of file paths to copy from.

setOutputFilesToCopyFrom

public boolean setOutputFilesToCopyFrom(java.lang.String[] paths)

Set the output files to copy from before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of output files to copy from before running the job.

Returns:

whether the output files to copy from are set successfully.

getOutputFilesToCopyTo

public java.lang.String[] getOutputFilesToCopyTo()

Get the output files to copy to before running the job, which is a string array of paths.

Returns:

a string array of file paths to copy to.

setOutputFilesToCopyTo

public boolean setOutputFilesToCopyTo(java.lang.String[] paths)

Set the output files to copy to before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of output files to copy to before running the job.

Returns:

whether the output files to copy to are set successfully.

getOutputFilesToMoveFrom

public java.lang.String[] getOutputFilesToMoveFrom()

Get the output files to move from before running the job, which is a string array of paths.

Returns:

a string array of file paths to move from.

setOutputFilesToMoveFrom

public boolean setOutputFilesToMoveFrom(java.lang.String[] paths)

Set the output files to move from before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of output files to move from before running the job.

Returns:

whether the output files to move from are set successfully.

getOutputFilesToMoveTo

public java.lang.String[] getOutputFilesToMoveTo()

Get the output files to move to before running the job, which is a string array of paths.

Returns:

a string array of file paths to move to.

setOutputFilesToMoveTo

public boolean setOutputFilesToMoveTo(java.lang.String[] paths)

Set the output files to move to before running the job, which is a string array of paths.

Parameters:

paths - holds a string array of output files to move to before running the job.

Returns:

whether the output files to move to are set successfully.

getFilesToDelete

public java.lang.String[] getFilesToDelete()

Get the files to delete after running the job, which is a string array of paths.

Returns:

a string array of file paths to delete.

setFilesToDelete

public boolean setFilesToDelete(java.lang.String[] paths)

Set the files to delete after running the job, which is a string array of paths.

Parameters:

paths - holds a string array of file paths to delete after running the job.

Returns:

whether the files to delete are set successfully.

getDirectoriesToDelete

public java.lang.String[] getDirectoriesToDelete()

Get the directories to delete after running the job, which is a string array of paths.

Returns:

a string array of directory paths to delete.

setDirectoriesToDelete

public boolean setDirectoriesToDelete(java.lang.String[] paths)

Set the directories to delete after running the job, which is a string array of paths.

Parameters:

paths - holds a string array of directory paths to delete after running the job.

Returns:

whether the directories to delete are set successfully.

getProcessesToKill

public java.lang.String[] getProcessesToKill()

Get the processes to kill after running the job, which is a string array of process names.

Returns:

a string array of process names to kill.

setProcessesToKill

public boolean setProcessesToKill(java.lang.String[] processNames)

Set the processes to kill after running the job, which is a string array of paths.

Parameters:

processNames - holds a string array of process names to kill after running the job.

Returns:

whether the processes to kill are set successfully.

getVariableNumber

public int getVariableNumber()

Get variable number.

Returns:

variable number, -1 if no information.

setVariableNumber

public boolean setVariableNumber(int variableNumber)

Set the variable number.

Parameters:

variableNumber - holds the number of variables

Returns:

whether the variable number is set successfully or not.

getObjectiveNumber

public int getObjectiveNumber()

Get objective number.

Returns:

objective number, -1 if no information.

setObjectiveNumber

public boolean setObjectiveNumber(int objectiveNumber)

Set the objective number.

Parameters:

objectiveNumber - holds the number of objectives

Returns:

whether the objective number is set successfully or not.

getConstraintNumber

public int getConstraintNumber()

Get constraint number.

Returns:

constraint number, -1 if no information.

setConstraintNumber

public boolean setConstraintNumber(int constraintNumber)

Set the constraint number.

Parameters:

constraintNumber - holds the number of constraints

Returns:

whether the constraint number is set successfully or not.

getInitialVariableValues

public double[] getInitialVariableValues()

get initial variable values (double[]).

Returns:

a double array of the initial variable values, null if none.

setInitialVariableValues

public boolean setInitialVariableValues(double[] initialVariableValues)

Set initial variable values (double[]). Before this method is called, the setVariable(int), setObjective(int), setConstraint(int) methods are recommended to be called first.

Parameters:

initialVariableValues - holds a double array of initial variable values.

Returns:

whether the initial variable values are set successfully or not.

getOtherOptionNames

public java.lang.String[] getOtherOptionNames()

get a string array of names of other options.

Returns:

a string array of names of other options, null if no other options.

getOtherOptionDescriptions

public java.util.Hashtable<java.lang.String,java.lang.String> getOtherOptionDescriptions()

get a hashmap of other option descriptions. The keys of the hashmap are the option names, and the values of the hashmap are the option descriptions.

Returns:

a hashmap of other option descriptions, null if no other options.

getOtherOptionValues

public java.util.Hashtable<java.lang.String,java.lang.String> getOtherOptionValues()

get a hashmap of other option values. The keys of the hashmap are the option names, and the values of the hashmap are the option values.

Returns:

a hashmap of other option values, null if no other options.

setOtherOptions

public boolean setOtherOptions(java.lang.String[] names,
                               java.lang.String[] descriptions,
                               java.lang.String[] values)

set other options, with their names (required), descriptions (optional) and values (optional).

Parameters:

names - holds the names of the other options; it is required.

descriptions - holds the descriptions of the other options; null if none.

values - holds the values of the other options; null if none.

Returns:

whether the other anlysis information is set successfully.

main

public static void main(java.lang.String[] args)

main for test purposes.

Parameters:

argv - command line arguments.