org.protempa.cli

Class CLI

java.lang.Object

org.protempa.cli.CLI

Direct Known Subclasses:

PrintAbstractedFrom, PrintAbstractedInto, PrintInverseIsA, PrintIsA, PrintPropositionDefinition, PrintPropositionDefinitionsForTerm, PrintSubtreeInDataSource, PrintTerm, PrintTermChildren, ValidateDataSource

public abstract class CLI
extends Object

Convenience class for creating command line applications using PROTEMPA.

Author:

Andrew Post

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLI.Argument For defining command line arguments that are not prefixed by the option syntax.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CLI() Instantiates this application.
protected	CLI(CLI.Argument[] arguments) Instantiates the application with optional arguments.
protected	CLI(CLI.Argument[] arguments, boolean configurationIdEnabled) Instantiates the application with a required shell command name and whether to create the configuration id option.
protected	CLI(String shellCommand) Instantiates the application with a required shell command name.
protected	CLI(String shellCommand, CLI.Argument[] arguments) Instantiates the application with a required shell command name and optional arguments that are not prefixed with option syntax.
protected	CLI(String shellCommand, CLI.Argument[] arguments, boolean configurationIdEnabled) Instantiates the application with a required shell command name, optional arguments that are not prefixed with option syntax, and whether to create the configuration id option.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomCliOptions(org.apache.commons.cli.Options options) Override to specify any custom command line options.
void	close() Closes the instance of Protempa created by #initialize(java.lang.String).
void	execute() Calls the code in execute(org.protempa.Protempa, org.apache.commons.cli.CommandLine).
void	execute(Protempa protempa, org.apache.commons.cli.CommandLine commandLine) Implemented with whatever is done with the instance of PROTEMPA created with #initialize(java.lang.String), and processing of any arguments and command line options specified in addCustomCliOptions(org.apache.commons.cli.Options).
CLI.Argument[]	getArguments() Gets optional arguments that are not prefixed with option syntax.
String	getShellCommand() Gets the shell command.
void	initialize() Initializes PROTEMPA with the specified configuration.
void	initializeExecuteAndClose() Like calling #initialize(java.lang.String), execute() and close() in succession.
boolean	isConfigurationIdEnabled() Whether the configuration option will be created.
void	printException(Exception cliException) Prints to the console an exception's message and its nested exception's message (if any).
org.apache.commons.cli.CommandLine	processOptionsAndArgs(String[] args) Processes command line options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLI

protected CLI()

Instantiates this application. The system property app.name must be set to the shell command name.

CLI

protected CLI(String shellCommand)

Instantiates the application with a required shell command name.

Parameters:

shellCommand - a String, cannot be null or empty.

CLI

protected CLI(CLI.Argument[] arguments)

Instantiates the application with optional arguments. The system property app.name must be set to the shell command name.

Parameters:

arguments - the command line arguments for this application. May be null or empty.

CLI

protected CLI(String shellCommand,
              CLI.Argument[] arguments)

Instantiates the application with a required shell command name and optional arguments that are not prefixed with option syntax. To add options, override addCustomCliOptions(org.apache.commons.cli.Options).

Parameters:

shellCommand - a String, cannot be null or empty.

arguments - an Argument[].

CLI

protected CLI(CLI.Argument[] arguments,
              boolean configurationIdEnabled)

Instantiates the application with a required shell command name and whether to create the configuration id option. The latter is true by default, and normally would be unless PROTEMPA would not be initialized by the program for some reason. To add options, override addCustomCliOptions(org.apache.commons.cli.Options).

Parameters:

arguments - an Argument[].

configurationIdEnabled - whether or not the configuration id option should be created.

CLI

protected CLI(String shellCommand,
              CLI.Argument[] arguments,
              boolean configurationIdEnabled)

Instantiates the application with a required shell command name, optional arguments that are not prefixed with option syntax, and whether to create the configuration id option. The latter is true by default, and normally would be unless PROTEMPA would not be initialized by the program for some reason. To add options, override addCustomCliOptions(org.apache.commons.cli.Options).

Parameters:

shellCommand - a String, cannot be null or empty.

arguments - an Argument[].

configurationIdEnabled - whether or not the configuration id option should be created.

Method Detail

getShellCommand

public final String getShellCommand()

Gets the shell command.

Returns:

a String.

getArguments

public final CLI.Argument[] getArguments()

Gets optional arguments that are not prefixed with option syntax.

Returns:

a Argument[]. Guaranteed not null.

isConfigurationIdEnabled

public final boolean isConfigurationIdEnabled()

Whether the configuration option will be created. This is true unless otherwise specified, and must be true if initialize() will be called.

Returns:

true or false.

initialize

public final void initialize()
                      throws ProtempaStartupException

Initializes PROTEMPA with the specified configuration. Must be called after #processArgs(java.lang.String[], int, int) .

Parameters:

configurationId - the id String of a configuration.

Throws:

ProtempaStartupException - if an error occurred starting up PROTEMPA.

execute

public void execute(Protempa protempa,
                    org.apache.commons.cli.CommandLine commandLine)
             throws CLIException

Implemented with whatever is done with the instance of PROTEMPA created with #initialize(java.lang.String), and processing of any arguments and command line options specified in addCustomCliOptions(org.apache.commons.cli.Options). The default implementation is a no-op.

Parameters:

protempa - an instance of Protempa.

commandLine - the CommandLine options passed in by the caller.

Throws:

CLIException - if some exception was thrown by the implementation of this method. The convention is for any such exceptions to be nested in an instance of CLIException.

printException

public final void printException(Exception cliException)

Prints to the console an exception's message and its nested exception's message (if any).

Parameters:

cliException - the Exception to print.

execute

public final void execute()
                   throws CLIException

Calls the code in execute(org.protempa.Protempa, org.apache.commons.cli.CommandLine).

Throws:

CLIException - if execute(org.protempa.Protempa, org.apache.commons.cli.CommandLine) throws an exception.

close

public final void close()
                 throws CloseException

Closes the instance of Protempa created by #initialize(java.lang.String).

Throws:

CloseException

processOptionsAndArgs

public final org.apache.commons.cli.CommandLine processOptionsAndArgs(String[] args)

Processes command line options. The default command line options are -h or --help, which prints usage and the list of options, and -c or --configuration, which is followed by the id of a PROTEMPA configuration. The latter is required unless -h is specified. Any additional options that are specified in addCustomCliOptions(org.apache.commons.cli.Options) should be handled by execute(org.protempa.Protempa, org.apache.commons.cli.CommandLine). There always must be at least one argument for the configuration id.

Parameters:

args - the argument String[] passed into main.

Returns:

a CommandLine instance.

initializeExecuteAndClose

public final void initializeExecuteAndClose()

Like calling #initialize(java.lang.String), execute() and close() in succession. Must be called only after #processArgs(java.lang.String[], int, int) .

addCustomCliOptions

protected void addCustomCliOptions(org.apache.commons.cli.Options options)

Override to specify any custom command line options.

Parameters:

options - the command line Options.