ucar.nc2
Class Dimension

java.lang.Object
  ucar.nc2.Dimension

All Implemented Interfaces:

java.lang.Comparable

public class Dimension
extends java.lang.Object
implements java.lang.Comparable

A Dimension is used to define the array shape of a Variable. It may be shared among Variables, which provides a simple yet powerful way of associating Variables. When a Dimension is shared, it has a unique name within its Group. It may have a coordinate Variable, which gives each index a coordinate value. A private Dimension cannot have a coordinate Variable, so use shared dimensions with coordinates when possible.

Dimensions are considered immutable : do not change them after they have been constructed. Only the Unlimited Dimension can grow.

Version:

$Revision:51 $ $Date:2006-07-12 17:13:13Z $

Author:

caron

Field Summary

static Dimension	UNKNOWN
static Dimension	UNLIMITED

Constructor Summary

Dimension(java.lang.String name, Dimension from)
Copy Constructor used to make global dimensions

Dimension(java.lang.String name, int length, boolean isShared)
Constructor

Dimension(java.lang.String name, int length, boolean isShared, boolean isUnlimited, boolean isVariableLength)
Constructor

Method Summary

void	addCoordinateVariable(Variable v) Add a coordinate variable or coordinate variable alias.
int	compareTo(java.lang.Object o) Dimensions with the same name are equal.
boolean	equals(java.lang.Object oo) Instances which have same contents are equal.
java.util.List	getCoordinateVariables() Get the coordinate variables or coordinate variable aliases if the dimension has any, else return an empty list.
int	getLength() Get the length of the Dimension.
java.lang.String	getName() Returns the name of this Dimension; may be null.
int	hashCode() Override Object.hashCode() to implement equals.
boolean	isShared() If this Dimension is shared, or is private to a Variable.
boolean	isUnlimited() If unlimited, then the length can increase; otherwise it is immutable.
boolean	isVariableLength() If variable length, then the length is unknown until the data is read.
void	setLength(int n) Set the Dimension length.
void	setName(java.lang.String name) rename
void	setShared(boolean b) Set whether this is shared.
void	setUnlimited(boolean b) Set whether this is unlimited, meaning length can increase.
void	setVariableLength(boolean b) Set whether the length is variable.
java.lang.String	toString() String representation.
java.lang.String	writeCDL(boolean strict) String representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNLIMITED

public static Dimension UNLIMITED

UNKNOWN

public static Dimension UNKNOWN

Constructor Detail

Dimension

public Dimension(java.lang.String name,
                 int length,
                 boolean isShared)

Constructor

Parameters:

name - name must be unique within group

length - length, or UNLIMITED.length or UNKNOWN.length

isShared - whether its shared or local to Variable.

Dimension

public Dimension(java.lang.String name,
                 int length,
                 boolean isShared,
                 boolean isUnlimited,
                 boolean isVariableLength)

Constructor

Parameters:

name - name must be unique within group. Can be null only if not shared.

length - length, or UNLIMITED.length or UNKNOWN.length

isShared - whether its shared or local to Variable.

isUnlimited - whether the length can grow.

isVariableLength - whether the length is unknown until the data is read.

Dimension

public Dimension(java.lang.String name,
                 Dimension from)

Copy Constructor used to make global dimensions

Method Detail

getName

public java.lang.String getName()

Returns the name of this Dimension; may be null. A Dimension with a null name is called "anonymous" and must be private. Dimension names are unique within a Group.

getLength

public int getLength()

Get the length of the Dimension.

isUnlimited

public boolean isUnlimited()

If unlimited, then the length can increase; otherwise it is immutable.

isVariableLength

public boolean isVariableLength()

If variable length, then the length is unknown until the data is read.

isShared

public boolean isShared()

If this Dimension is shared, or is private to a Variable. All Dimensions in NetcdfFile.getDimensions() or Group.getDimensions() are shared. Dimensions in the Variable.getDimensions() may be shared or private.

getCoordinateVariables

public java.util.List getCoordinateVariables()

Get the coordinate variables or coordinate variable aliases if the dimension has any, else return an empty list. A coordinate variable has this as its single dimension, and names this Dimensions's the coordinates. A coordinate variable alias is the same as a coordinate variable, but its name must match the dimension name. If numeric, coordinate axis must be strictly monotonically increasing or decreasing.

Returns:

List of Variable

See Also:

Variable.getCoordinateDimension()

equals

public boolean equals(java.lang.Object oo)

Instances which have same contents are equal. Careful!! this is not object identity !!

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

String representation.

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Dimensions with the same name are equal.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - compare to this Dimension

Returns:

0, 1, or -1

writeCDL

public java.lang.String writeCDL(boolean strict)

String representation.

addCoordinateVariable

public void addCoordinateVariable(Variable v)

Add a coordinate variable or coordinate variable alias. Remove previous if matches full name.

setUnlimited

public void setUnlimited(boolean b)

Set whether this is unlimited, meaning length can increase.

setVariableLength

public void setVariableLength(boolean b)

Set whether the length is variable.

setShared

public void setShared(boolean b)

Set whether this is shared.

setLength

public void setLength(int n)

Set the Dimension length.

setName

public void setName(java.lang.String name)

rename