Package org.apache.sis.console

Class Command

Object

Command

public final class Command
extends Object

Command line interface for Apache SIS. The main(String[]) method accepts the following actions:

Supported command-line actions

help	Show a help overview.
about	Show information about Apache SIS and system configuration.
mime-type	Show MIME type for the given file.
metadata	Show metadata information for the given file.
crs	Show Coordinate Reference System information for the given file or code.
identifier	Show identifiers for metadata and referencing systems in the given file.
transform	Convert or transform coordinates from given source CRS to target CRS.

Each command can accepts some of the following options:

Supported command-line options

--sourceCRS	The Coordinate Reference System of input data.
--targetCRS	The Coordinate Reference System of output data.
--format	The output format: xml, wkt, wkt1 or text.
--locale	The locale to use for the command output.
--timezone	The timezone for the dates to be formatted.
--encoding	The encoding to use for the command outputs and some inputs.
--colors	Whether colorized output shall be enabled.
--brief	Whether the output should contains only brief information.
--verbose	Whether the output should contains more detailed information.
--debug	Prints full stack trace in case of failure.
--help	Lists the options available for a specific command.

The --locale, --timezone and --encoding options apply to the command output sent to the standard output stream, but usually do not apply to the error messages sent to the standard error stream. The reason is that command output may be targeted to a client, while the error messages are usually for the operator.

SIS installation on remote machines

Some sub-commands can operate on SIS installation on remote machines, provided that remote access has been enabled at the Java Virtual Machine startup time. See package javadoc for more information.

Since:

0.3

Defined in the sis-console module

Field Summary

Fields

Modifier and Type	Field	Description
static int	INVALID_ARGUMENT_EXIT_CODE	The code given to System.exit(int) when the program failed because of an illegal user argument.
static int	INVALID_COMMAND_EXIT_CODE	The code given to System.exit(int) when the program failed because of a unknown sub-command.
static int	INVALID_OPTION_EXIT_CODE	The code given to System.exit(int) when the program failed because of a unknown option.
static int	IO_EXCEPTION_EXIT_CODE	The code given to System.exit(int) when the program failed because of an IOException.
static int	OTHER_ERROR_EXIT_CODE	The code given to System.exit(int) when the program failed for a reason other than the ones enumerated in the above constants.
static int	SQL_EXCEPTION_EXIT_CODE	The code given to System.exit(int) when the program failed because of an SQLException.
static int	UNKNOWN_STORAGE_EXIT_CODE	The code given to System.exit(int) when a file given in argument uses an unknown file format.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Command(String[] args)	Creates a new command for the given arguments.

Method Summary

Modifier and Type	Method	Description
static int	exitCodeFor(Throwable cause)	Returns the exit code for the given exception, or 0 if unknown.
static void	main(String[] args)	Prints the information to the standard output stream.
int	run()	Runs the command.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Field Detail

INVALID_COMMAND_EXIT_CODE

public static final int INVALID_COMMAND_EXIT_CODE

The code given to System.exit(int) when the program failed because of a unknown sub-command.

See Also:

Constant Field Values

INVALID_OPTION_EXIT_CODE

public static final int INVALID_OPTION_EXIT_CODE

The code given to System.exit(int) when the program failed because of a unknown option. The set of valid options depend on the sub-command to execute.

See Also:

Constant Field Values

INVALID_ARGUMENT_EXIT_CODE

public static final int INVALID_ARGUMENT_EXIT_CODE

The code given to System.exit(int) when the program failed because of an illegal user argument. The user arguments are everything which is not a command name or an option. They are typically file names, but can occasionally be other types like URL.

See Also:

Constant Field Values

UNKNOWN_STORAGE_EXIT_CODE

public static final int UNKNOWN_STORAGE_EXIT_CODE

The code given to System.exit(int) when a file given in argument uses an unknown file format.

See Also:

Constant Field Values

IO_EXCEPTION_EXIT_CODE

public static final int IO_EXCEPTION_EXIT_CODE

The code given to System.exit(int) when the program failed because of an IOException.

See Also:

Constant Field Values

SQL_EXCEPTION_EXIT_CODE

public static final int SQL_EXCEPTION_EXIT_CODE

The code given to System.exit(int) when the program failed because of an SQLException.

See Also:

Constant Field Values

OTHER_ERROR_EXIT_CODE

public static final int OTHER_ERROR_EXIT_CODE

The code given to System.exit(int) when the program failed for a reason other than the ones enumerated in the above constants.

See Also:

Constant Field Values

Constructor Detail

Command

protected Command(String[] args)
           throws InvalidCommandException,
                  InvalidOptionException

Creates a new command for the given arguments. The first value in the given array which is not an option is taken as the command name. All other values are options or filenames.

Parameters:

args - the command-line arguments.

Throws:

Invalid­Command­Exception - if an invalid command has been given.

Invalid­Option­Exception - if the given arguments contain an invalid option.

Method Detail

run

public int run()
        throws Exception

Runs the command. If an exception occurs, then the exception message is sent to the error output stream before to be thrown. Callers can map the exception to a system exit code by the exit­Code­For(Throwable) method.

Returns:

0 on success, or an exit code if the command failed for a reason other than a Java exception.

Throws:

Exception - if an error occurred during the command execution. This is typically, but not limited, to IOException, SQLException, Data­Store­Exception or Transform­Exception.

exitCodeFor

public static int exitCodeFor(Throwable cause)

Returns the exit code for the given exception, or 0 if unknown. This method iterates through the causes until an exception matching a *_EXIT_CODE constant is found.

Parameters:

cause - the exception for which to get the exit code.

Returns:

the exit code as one of the *_EXIT_CODE constant, or OTHER_ERROR_EXIT_CODE if unknown.

main

public static void main(String[] args)

Prints the information to the standard output stream.

Parameters:

args - command-line options.