au.csiro.netcdf.cli
Interface Command

All Known Implementing Classes:

NcCSVExtract, NcDefineAttributes, NcDefineDimension, NcDefineVariable, NcWriteVariable

public interface Command

This interface represents the generic functionality of a netCDF Tools command.

It forms part of a command pattern.

Copyright 2010, CSIRO Australia All rights reserved.

Version:

$Revision: 78 $ $Date: 2010-07-24 16:23:13 +1000 (Sat, 24 Jul 2010) $

Author:

Robert Bridle on 17/03/2010

Field Summary

static long	MAX_32BIT_OFFSET_FILE_SIZE The maximum file size, in bytes, before a 64-bit file offset is required.
static int	PRINT_WIDTH The column width for printing helps and usage statements.

Method Summary

org.apache.commons.cli.Options	createOptions() Create the command line options for this command.
void	execute(String[] args) Run the command.
String	getCommandName()
String	getUsageString()
String	validCommand(String[] args) Determine if this command is valid, check its syntax.

Field Detail

PRINT_WIDTH

static final int PRINT_WIDTH

The column width for printing helps and usage statements.

See Also:

Constant Field Values

MAX_32BIT_OFFSET_FILE_SIZE

static final long MAX_32BIT_OFFSET_FILE_SIZE

The maximum file size, in bytes, before a 64-bit file offset is required. A 64-bit file offset is specified via the large file support flag.

Method Detail

execute

void execute(String[] args)
             throws org.apache.commons.cli.ParseException,
                    IOException

Run the command.

Parameters:

args - command line arguments.

Throws:

org.apache.commons.cli.ParseException - thrown if the command line arguments can not be parsed.

IOException - thrown if netCDF can to be written to or read from.

createOptions

org.apache.commons.cli.Options createOptions()

Create the command line options for this command.

Returns:

the command line options for this command.

validCommand

String validCommand(String[] args)

Determine if this command is valid, check its syntax.

Parameters:

args - command line arguments.

Returns:

error if found.

getCommandName

String getCommandName()

Returns:

the command name for this command.

getUsageString

String getUsageString()

Returns:

the usage for this command.