au.csiro.netcdf
Class NcDefineAttributes

java.lang.Object
  au.csiro.netcdf.NcDefineAttributes

All Implemented Interfaces:

Command

public class NcDefineAttributes
extends Object
implements Command

The ncdefineAtt command defines global or variable Attributes in a netCDF file.

Copyright 2010, CSIRO Australia All rights reserved.

Version:

$Revision: 84 $ $Date: 2010-08-25 15:56:46 +1000 (Wed, 25 Aug 2010) $ $Id: NcDefineDimension.java 6520 2010-03-17 06:17:50Z bri26e $

Author:

$Author: robertbridle $ on 17/03/2010

Field Summary

static String	ATTRIBUTE_DATA_TYPE The name of the command line option used for specifying the data type of the attribute.
static String	ATTRIBUTES The name of the command line option used for specifying the attributes of a netCDF file.
static String	FILENAME_PATTERN The pattern for accepted file names where multiple files are accepted.
static String	INPUT_FILE The name of the command line option used for specifying the input text file name.
static String	IS_LARGE_FILE Whether the netCDF file should be written with large file support, that is, 64-bit addressing for files greater than 2 GB.
static String	NC_DEFINE_ATT_COMMAND_NAME The command name
static String	OUTPUT_FILE The name of the command line option used for specifying the output netCDF file name.
static String	VARIABLE_NAME The name of the command line option used for specifying the name of the variable receiving the attributes.

Fields inherited from interface au.csiro.netcdf.cli.Command

MAX_32BIT_OFFSET_FILE_SIZE, PRINT_WIDTH

Constructor Summary

NcDefineAttributes()
Constructor

Method Summary

org.apache.commons.cli.Options	createOptions() Create the command line options for this command.
void	execute(String[] args) Run the command.
void	execute(String outputFilename, List<Attribute> attributes, boolean isLargeFileSupport) Allows the command to be run programmatically, instead of from a command line.
void	execute(String outputFilename, List<Attribute> attributes, boolean isLargeFileSupport, String variableName) Allows the command to be run programmatically, instead of from a command line.
String	getCommandName()
String	getUsageString()
static DataType	mapStringToDataType(String variableDataType) Maps a String into a DataType.
String	toString()
String	validCommand(String[] commandLine) Determine if this command is valid, check its syntax.

Methods inherited from class java.lang.Object

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

Field Detail

NC_DEFINE_ATT_COMMAND_NAME

public static final String NC_DEFINE_ATT_COMMAND_NAME

The command name

See Also:

Constant Field Values

OUTPUT_FILE

public static final String OUTPUT_FILE

The name of the command line option used for specifying the output netCDF file name.

See Also:

Constant Field Values

INPUT_FILE

public static final String INPUT_FILE

The name of the command line option used for specifying the input text file name.

See Also:

Constant Field Values

ATTRIBUTES

public static final String ATTRIBUTES

The name of the command line option used for specifying the attributes of a netCDF file.

See Also:

Constant Field Values

VARIABLE_NAME

public static final String VARIABLE_NAME

The name of the command line option used for specifying the name of the variable receiving the attributes.

See Also:

Constant Field Values

IS_LARGE_FILE

public static final String IS_LARGE_FILE

Whether the netCDF file should be written with large file support, that is, 64-bit addressing for files greater than 2 GB.

See Also:

Constant Field Values

FILENAME_PATTERN

public static final String FILENAME_PATTERN

The pattern for accepted file names where multiple files are accepted.

See Also:

Constant Field Values

ATTRIBUTE_DATA_TYPE

public static final String ATTRIBUTE_DATA_TYPE

The name of the command line option used for specifying the data type of the attribute.

See Also:

Constant Field Values

Constructor Detail

NcDefineAttributes

public NcDefineAttributes()

Constructor

Method Detail

execute

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

Description copied from interface: Command

Run the command.

Specified by:

execute in interface 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.

IllegalArgumentException

execute

public void execute(String outputFilename,
                    List<Attribute> attributes,
                    boolean isLargeFileSupport)
             throws IOException,
                    SecurityException

Allows the command to be run programmatically, instead of from a command line.

Parameters:

outputFilename - the netCDF file in which to define a dimension.

attributes - a attributes of the file.

isLargeFileSupport - whether the netCDF file should be written with large file support, i.e. 64-bit addressing for files greater than 2 GB.

Throws:

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

SecurityException - thrown if a security manager exists and it prevents the netCDF file from being created.

execute

public void execute(String outputFilename,
                    List<Attribute> attributes,
                    boolean isLargeFileSupport,
                    String variableName)
             throws IOException,
                    SecurityException

Allows the command to be run programmatically, instead of from a command line.

Parameters:

outputFilename - the netCDF file in which to define a dimension.

attributes - a attributes of the file.

isLargeFileSupport - whether the netCDF file should be written with large file support, i.e. 64-bit addressing for files greater than 2 GB.

variableName - the variable name to assign attributes to

Throws:

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

SecurityException - thrown if a security manager exists and it prevents the netCDF file from being created.

getCommandName

public String getCommandName()

Specified by:

getCommandName in interface Command

Returns:

the command name for this command.

toString

public String toString()

Overrides:

toString in class Object

createOptions

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

Description copied from interface: Command

Create the command line options for this command.

Specified by:

createOptions in interface Command

Returns:

the command line options for this command.

getUsageString

public String getUsageString()

Specified by:

getUsageString in interface Command

Returns:

the usage for this command.

validCommand

public String validCommand(String[] commandLine)

Determine if this command is valid, check its syntax.

Specified by:

validCommand in interface Command

Parameters:

commandLine - command line arguments.

Returns:

error if found.

mapStringToDataType

public static DataType mapStringToDataType(String variableDataType)
                                    throws IllegalArgumentException

Maps a String into a DataType.

Parameters:

variableDataType - a data type description.

Returns:

a DataType

Throws:

IllegalArgumentException - thrown if the String can not be mapped to a DataType.