ucar.nc2

Class Dimension

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Dimension

All Implemented Interfaces:

java.lang.Comparable

public class Dimension
extends CDMNode
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. The Dimension length must be > 0, except for an unlimited dimension which may have length = 0, and a vlen Dimension which has length = -1.

Immutable if setImmutable() was called, except for an Unlimited Dimension, whose size can change.

Note: this class has a natural ordering that is inconsistent with equals.

Field Summary

Fields

Modifier and Type	Field and Description
static Dimension	VLEN A variable-length dimension: the length is not known until the data is read.

Fields inherited from class ucar.nc2.CDMNode

annotations, dodsname, group, immutable, parentstruct, shortName, sort

Constructor Summary

Constructors

Constructor and Description
Dimension(java.lang.String name, Dimension from) Copy Constructor.
Dimension(java.lang.String name, int length) Constructor
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

Modifier and Type	Method and Description
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.
Group	getGroup() Get the Group that owns this Dimension.
int	getLength() Get the length of the Dimension.
int	hashCode() Override Object.hashCode() to implement equals.
void	hashCodeShow(Indent indent)
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.
static java.util.List<Dimension>	makeDimensionsAnon(int[] shape)
static java.util.List<Dimension>	makeDimensionsList(Group parentGroup, java.lang.String dimString) Create a dimension list using the dimensions names.
static java.lang.String	makeDimensionsString(java.util.List<Dimension> dimensions) Make a space-delineated String from a list of Dimension names.
java.lang.String	makeFullName()
void	setGroup(Group g) Set the group
Dimension	setImmutable() Make this immutable.
void	setLength(int n) Set the Dimension length.
java.lang.String	setName(java.lang.String name) Set the name, converting to valid CDM object name if needed.
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() CDL representation, not strict.
java.lang.String	writeCDL(boolean strict) CDL representation.
protected void	writeCDL(java.util.Formatter out, Indent indent, boolean strict)

Methods inherited from class ucar.nc2.CDMNode

annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getImmutable, getName, getParentGroup, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentGroup, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VLEN

public static Dimension VLEN

A variable-length dimension: the length is not known until the data is read.

Constructor Detail

Dimension

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

Constructor

Parameters:

name - name must be unique within group

length - length of Dimension

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

Parameters:

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

from - copy all other fields from here.

Method Detail

makeDimensionsString

public static java.lang.String makeDimensionsString(java.util.List<Dimension> dimensions)

Make a space-delineated String from a list of Dimension names. Inverse of makeDimensionsList().

Returns:

space-delineated String of Dimension names.

makeDimensionsList

public static java.util.List<Dimension> makeDimensionsList(Group parentGroup,
                                                           java.lang.String dimString)
                                                    throws java.lang.IllegalArgumentException

Create a dimension list using the dimensions names. The dimension is searched for recursively in the parent groups, so it must already have been added. Inverse of makeDimensionsString().

Parameters:

parentGroup - containing group, may not be null

dimString - : whitespace separated list of dimension names, or '*' for Dimension.UNKNOWN, or number for anon dimension. null or empty String is a scalar.

Returns:

list of dimensions

Throws:

java.lang.IllegalArgumentException - if cant find dimension or parse error.

makeDimensionsAnon

public static java.util.List<Dimension> makeDimensionsAnon(int[] shape)

getLength

public int getLength()

Get the length of the Dimension.

Returns:

length of Dimension

isUnlimited

public boolean isUnlimited()

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

Returns:

if its an "unlimited" Dimension

isVariableLength

public boolean isVariableLength()

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

Returns:

if its a "variable length" Dimension.

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.

Returns:

if its a "shared" Dimension.

getGroup

public Group getGroup()

Get the Group that owns this Dimension.

Overrides:

getGroup in class CDMNode

Returns:

owning group or null if !isShared

makeFullName

public java.lang.String makeFullName()

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

hashCodeShow

public void hashCodeShow(Indent indent)

Specified by:

hashCodeShow in class CDMNode

toString

public java.lang.String toString()

CDL representation, not strict.

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Dimensions with the same name are equal. This method is inconsistent with equals()!

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)

CDL representation.

Parameters:

strict - if true, write in strict adherence to CDL definition.

Returns:

CDL representation.

writeCDL

protected void writeCDL(java.util.Formatter out,
                        Indent indent,
                        boolean strict)

setUnlimited

public void setUnlimited(boolean b)

Set whether this is unlimited, meaning length can increase.

Parameters:

b - true if unlimited

setVariableLength

public void setVariableLength(boolean b)

Set whether the length is variable.

Parameters:

b - true if variable length

setShared

public void setShared(boolean b)

Set whether this is shared.

Parameters:

b - true if shared

setLength

public void setLength(int n)

Set the Dimension length.

Parameters:

n - length of Dimension

setName

public java.lang.String setName(java.lang.String name)

Set the name, converting to valid CDM object name if needed.

Parameters:

name - set to this value

Returns:

valid CDM object name

setGroup

public void setGroup(Group g)

Set the group

Parameters:

g - parent group

setImmutable

public Dimension setImmutable()

Make this immutable.

Returns:

this