public class Dimension extends CDMNode implements Comparable
Immutable if setImmutable() was called, except for an Unlimited Dimension, whose size can change.
Modifier and Type | Field and Description |
---|---|
static Dimension |
VLEN
A variable-length dimension: the length is not known until the data is read.
|
Constructor and Description |
---|
Dimension(String name,
Dimension from)
Copy Constructor.
|
Dimension(String name,
int length)
Constructor
|
Dimension(String name,
int length,
boolean isShared)
Constructor
|
Dimension(String name,
int length,
boolean isShared,
boolean isUnlimited,
boolean isVariableLength)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addCoordinateVariable(Variable v)
Deprecated.
- do not use
|
int |
compareTo(Object o)
Dimensions with the same name are equal.
|
boolean |
equals(Object oo)
Instances which have same contents are equal.
|
List<Variable> |
getCoordinateVariables()
Deprecated.
- do not use
|
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.
|
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 String |
makeDimensionList(List<Dimension> dimList) |
String |
makeFullName() |
void |
setGroup(Group g)
Set the group
|
Dimension |
setImmutable()
Make this immutable.
|
void |
setLength(int n)
Set the Dimension length.
|
String |
setName(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.
|
String |
toString()
CDL representation, not strict.
|
String |
writeCDL(boolean strict)
CDL representation.
|
protected void |
writeCDL(Formatter out,
Indent indent,
boolean strict) |
getDODSName, getFullName, getFullNameEscaped, getImmutable, getName, getParentGroup, getParentStructure, getShortName, getSort, isMemberOfStructure, setDODSName, setImmutable, setParentGroup, setParentStructure, setShortName, setSort
public static Dimension VLEN
public Dimension(String name, int length)
name
- name must be unique within grouplength
- length of Dimensionpublic Dimension(String name, int length, boolean isShared)
name
- name must be unique within grouplength
- length, or UNLIMITED.length or UNKNOWN.lengthisShared
- whether its shared or local to Variable.public Dimension(String name, int length, boolean isShared, boolean isUnlimited, boolean isVariableLength)
name
- name must be unique within group. Can be null only if not shared.length
- length, or UNLIMITED.length or UNKNOWN.lengthisShared
- whether its shared or local to Variable.isUnlimited
- whether the length can grow.isVariableLength
- whether the length is unknown until the data is read.public int getLength()
public boolean isUnlimited()
public boolean isVariableLength()
public boolean isShared()
public Group getGroup()
public String makeFullName()
public boolean equals(Object oo)
public int hashCode()
public String toString()
public int compareTo(Object o)
compareTo
in interface Comparable
o
- compare to this Dimensionpublic String writeCDL(boolean strict)
strict
- if true, write in strict adherence to CDL definition.public void setUnlimited(boolean b)
b
- true if unlimitedpublic void setVariableLength(boolean b)
b
- true if variable lengthpublic void setShared(boolean b)
b
- true if sharedpublic void setLength(int n)
n
- length of Dimensionpublic String setName(String name)
name
- set to this valuepublic void setGroup(Group g)
g
- parent grouppublic Dimension setImmutable()
public void addCoordinateVariable(Variable v)
v
- coord varCopyright © 1999–2014 UCAR/Unidata. All rights reserved.