CDMNode (NetCDF-Java CDM API v5.0.0)

java.lang.Object
- ucar.nc2.CDMNode

Direct Known Subclasses:

Attribute, Dimension, EnumTypedef, Group, Variable
```
public abstract class CDMNode
extends Object
```
Define a superclass for all the CDM node classes: Group, Dimension, etc. Define the sort of the node CDMSort so that we can 1. do true switching on node type 2. avoid use of instanceof 3. Use container classes that have more than one kind of node
Also move various common fields and methods to here.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<Object,Object>`	`annotations`
`protected String`	`dodsname`
`protected Group`	`group`
`protected boolean`	`immutable`
`protected Structure`	`parentstruct`
`protected String`	`shortName`
`protected CDMSort`	`sort`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CDMNode()

CDMNode(String name)

Constructors
Modifier	Constructor and Description
`protected`	`CDMNode()`
	`CDMNode(String name)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`annotate(Object id, Object value)`
`Object`	`annotation(Object id)`
`String`	`getDODSName()` Get the dodsname
`String`	`getFullName()` Get the Full name of this object.
`String`	`getFullNameEscaped()` Alias for getFullName
`Group`	`getGroup()` Alias for getParentGroup
`boolean`	`getImmutable()` Get immutable flag As a rule, subclasses will access directly
`String`	`getName()` Deprecated. Replaced by `getShortName()` and `getFullName()`
`Group`	`getParentGroup()` Get its parent Group, or null if its the root group.
`Structure`	`getParentStructure()` Get its parent structure, or null if not in structure
`String`	`getShortName()` Get the short name of this Variable.
`CDMSort`	`getSort()`
`abstract void`	`hashCodeShow(Indent indent)`
`boolean`	`isMemberOfStructure()` Test for presence of parent Structure
`int`	`localhash()`
`void`	`setDODSName(String name)` Store the original dods name
`CDMNode`	`setImmutable()` Set the immutable flag to true.
`void`	`setParentGroup(Group parent)` Set the parent Group
`void`	`setParentStructure(Structure parent)` Set the parent Structure
`void`	`setShortName(String name)` Set the short name of this Variable.
`void`	`setSort(CDMSort sort)`
`static CDMNode`	`unwrap(CDMNode node)` NetcdfDataset can end up wrapping a variable in multiple wrapping classes (e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sort
```
protected CDMSort sort
```
  - group
```
protected Group group
```
  - parentstruct
```
protected Structure parentstruct
```
  - immutable
```
protected boolean immutable
```
  - shortName
```
protected String shortName
```
  - annotations
```
protected Map<Object,Object> annotations
```
  - dodsname
```
protected String dodsname
```
- Constructor Detail
  - CDMNode
```
protected CDMNode()
```
  - CDMNode
```
public CDMNode(String name)
```
- Method Detail
  - getSort
```
public CDMSort getSort()
```
  - setSort
```
public void setSort(CDMSort sort)
```
  - getShortName
```
public String getShortName()
```
    Get the short name of this Variable. The name is unique within its parent group.
  - setShortName
```
public void setShortName(String name)
```
    Set the short name of this Variable. The name is unique within its parent group.
    
    Parameters:
    
    name - new short name
  - getParentGroup
```
public Group getParentGroup()
```
    Get its parent Group, or null if its the root group.
    
    Returns:
    
    parent Group
  - getGroup
```
public Group getGroup()
```
    Alias for getParentGroup
    
    Returns:
    
    parent Group
  - setParentGroup
```
public void setParentGroup(Group parent)
```
    Set the parent Group
    
    Parameters:
    
    parent - The new parent group
  - getParentStructure
```
public Structure getParentStructure()
```
    Get its parent structure, or null if not in structure
    
    Returns:
    
    parent structure
  - setParentStructure
```
public void setParentStructure(Structure parent)
```
    Set the parent Structure
    
    Parameters:
    
    parent - The new parent structure
  - isMemberOfStructure
```
public boolean isMemberOfStructure()
```
    Test for presence of parent Structure
    
    Returns:
    
    true iff struct != null
  - getImmutable
```
public boolean getImmutable()
```
    Get immutable flag As a rule, subclasses will access directly
    
    Returns:
    
    Immutable flag
  - setImmutable
```
public CDMNode setImmutable()
```
    Set the immutable flag to true. Once set, cannot be unset
  - getDODSName
```
public String getDODSName()
```
    Get the dodsname
    
    Returns:
    
    the original names from the DDS or DAS; if null, then return the short name
  - setDODSName
```
public void setDODSName(String name)
```
    Store the original dods name
    
    Parameters:
    
    name - The original name from the DDS/DAS
  - getFullName
```
public String getFullName()
```
    Get the Full name of this object. Certain characters are backslash escaped (see NetcdfFile)
    
    Returns:
    
    full name with backslash escapes
  - getFullNameEscaped
```
public String getFullNameEscaped()
```
    Alias for getFullName
    
    Returns:
    
    full name with backslash escapes
  - getName
```
@Deprecated
public String getName()
```
    Deprecated. Replaced by getShortName() and getFullName()
    
    getName is deprecated because, as the code below shows, it has no consistent meaning. Sometimes it returns the short name, sometimes it returns the full name.
  - hashCodeShow
```
public abstract void hashCodeShow(Indent indent)
```
  - localhash
```
public int localhash()
```
  - unwrap
```
public static CDMNode unwrap(CDMNode node)
```
    NetcdfDataset can end up wrapping a variable in multiple wrapping classes (e.g. VariableDS). Goal of this procedure is to get down to the lowest level Variable instance
    
    Parameters:
    
    node - possibly wrapped ode
    
    Returns:
    
    the lowest level node instance
  - annotation
```
public Object annotation(Object id)
```
  - annotate
```
public Object annotate(Object id,
                       Object value)
```

Class CDMNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sort

group

parentstruct

immutable

shortName

annotations

dodsname

Constructor Detail

CDMNode

CDMNode

Method Detail

getSort

setSort

getShortName

setShortName

getParentGroup

getGroup

setParentGroup

getParentStructure

setParentStructure

isMemberOfStructure

getImmutable

setImmutable

getDODSName

setDODSName

getFullName

getFullNameEscaped

getName

hashCodeShow

localhash

unwrap

annotation

annotate