ucar.nc2

Class Dimension

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Dimension

All Implemented Interfaces:

java.lang.Comparable<Dimension>

public class Dimension
extends ucar.nc2.CDMNode
implements java.lang.Comparable<Dimension>

A Dimension is used to define the array shape of a Variable. A Variable can be thought of as a sampled function with Domain its Dimensions. A Dimension 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 a length known only when the variable is read.

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. TODO Dimension will be immutable in 6. TODO Dimension will not extend CDMNode in 6. TODO Dimension will not have a reference to its owning Group in 6. TODO Dimension.getFullName() will not exist in 6.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dimension.Builder A builder of Dimensions.

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Dimension.Builder	builder()
static Dimension.Builder	builder(java.lang.String name, int length) A builder with the Dimension name and length set
int	compareTo(Dimension odim) Dimensions with the same name are equal.
boolean	equals(java.lang.Object oo)
int	getLength() Get the length of the Dimension.
java.lang.String	getName() Get the name of the Dimension.
java.lang.String	getShortName() Get the name of the Dimension.
int	hashCode() Override Object.hashCode() to implement equals.
boolean	isShared() If this Dimension is shared, or is private to a Variable.
boolean	isUnlimited() If this is a NetCDF unlimited dimension.
boolean	isVariableLength() If variable length, then the length is unknown until the data is read.
Dimension.Builder	toBuilder() Turn into a mutable Builder, use toBuilder().build() to make a copy.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

VLEN

public static final 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,
                 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.

Method Detail

builder

public static Dimension.Builder builder()

builder

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

A builder with the Dimension name and length set

compareTo

public int compareTo(Dimension odim)

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

Specified by:

compareTo in interface java.lang.Comparable<Dimension>

Parameters:

odim - compare to this Dimension

Returns:

0, 1, or -1

equals

public boolean equals(java.lang.Object oo)

Overrides:

equals in class java.lang.Object

getLength

public int getLength()

Get the length of the Dimension.

getName

public java.lang.String getName()

Get the name of the Dimension. Same as getShortName. Not deprecated.

Overrides:

getName in class ucar.nc2.CDMNode

getShortName

public java.lang.String getShortName()

Get the name of the Dimension.

Overrides:

getShortName in class ucar.nc2.CDMNode

hashCode

public int hashCode()

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class java.lang.Object

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.

isUnlimited

public boolean isUnlimited()

If this is a NetCDF unlimited dimension. The length might increase between invocations, but it remains fixed for the lifetime of the NetcdfFile. If you modify the file in a separate process, you must close and reopen the file.

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.

toBuilder

public Dimension.Builder toBuilder()

Turn into a mutable Builder, use toBuilder().build() to make a copy.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object