ucar.nc2

Class CDMNode

java.lang.Object

ucar.nc2.CDMNode

Direct Known Subclasses:

Attribute, Dimension, EnumTypedef, Group, Variable

Deprecated.

Will move to Dap4 module in version 6.

@Deprecated
public abstract class CDMNode
extends java.lang.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 java.util.Map<java.lang.Object,java.lang.Object>	annotations Deprecated.
protected java.lang.String	dodsname Deprecated.
protected Group	group Deprecated.
protected boolean	immutable Deprecated.
protected Structure	parentstruct Deprecated.
protected java.lang.String	shortName Deprecated.
protected CDMSort	sort Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CDMNode() Deprecated.
	CDMNode(java.lang.String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	annotate(java.lang.Object id, java.lang.Object value) Deprecated. do not use
java.lang.Object	annotation(java.lang.Object id) Deprecated. do not use
java.lang.String	getDODSName() Deprecated. Do not use.
java.lang.String	getFullName() Deprecated. use NetcdfFiles.makeFullName(*)
java.lang.String	getFullNameEscaped() Deprecated. use getFullName() when it exists in ver6.
Group	getGroup() Deprecated. Do not use.
boolean	getImmutable() Deprecated. Do not use.
java.lang.String	getName() Deprecated. Replaced by getShortName() and getFullName()
Group	getParentGroup() Deprecated. Do not use for Dimension or Attribute
Structure	getParentStructure() Deprecated. Do not use.
java.lang.String	getShortName() Deprecated. Get the short name of this Variable.
CDMSort	getSort() Deprecated. do not use
boolean	isMemberOfStructure() Deprecated. Do not use.
int	localhash() Deprecated. do not use
void	setDODSName(java.lang.String name) Deprecated. Do not use.
CDMNode	setImmutable() Deprecated. Do not use.
void	setParentGroup(Group parent) Deprecated. Do not use.
void	setParentStructure(Structure parent) Deprecated. Do not use.
void	setShortName(java.lang.String name) Deprecated. Do not use.
void	setSort(CDMSort sort) Deprecated. do not use
static CDMNode	unwrap(CDMNode node) Deprecated. Do not use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sort

protected CDMSort sort

Deprecated.

group

protected Group group

Deprecated.

parentstruct

protected Structure parentstruct

Deprecated.

immutable

protected boolean immutable

Deprecated.

shortName

protected java.lang.String shortName

Deprecated.

annotations

protected java.util.Map<java.lang.Object,java.lang.Object> annotations

Deprecated.

dodsname

protected java.lang.String dodsname

Deprecated.

Constructor Detail

CDMNode

protected CDMNode()

Deprecated.

CDMNode

public CDMNode(java.lang.String name)

Deprecated.

Method Detail

getSort

@Deprecated
public CDMSort getSort()

Deprecated. do not use

setSort

@Deprecated
public void setSort(CDMSort sort)

Deprecated. do not use

getShortName

public java.lang.String getShortName()

Deprecated.

Get the short name of this Variable. The name is unique within its parent group.

setShortName

@Deprecated
public void setShortName(java.lang.String name)

Deprecated. Do not use.

Set the short name of this Variable. The name is unique within its parent group.

Parameters:

name - new short name

getParentGroup

@Deprecated
public Group getParentGroup()

Deprecated. Do not use for Dimension or Attribute

Get its parent Group, or null if its the root group.

Returns:

parent Group

getGroup

@Deprecated
public Group getGroup()

Deprecated. Do not use.

Alias for getParentGroup

Returns:

parent Group

setParentGroup

@Deprecated
public void setParentGroup(Group parent)

Deprecated. Do not use.

Set the parent Group

Parameters:

parent - The new parent group

getParentStructure

@Deprecated
public Structure getParentStructure()

Deprecated. Do not use.

Get its parent structure, or null if not in structure

Returns:

parent structure

setParentStructure

@Deprecated
public void setParentStructure(Structure parent)

Deprecated. Do not use.

Set the parent Structure

Parameters:

parent - The new parent structure

isMemberOfStructure

@Deprecated
public boolean isMemberOfStructure()

Deprecated. Do not use.

Test for presence of parent Structure

Returns:

true iff struct != null

getImmutable

@Deprecated
public boolean getImmutable()

Deprecated. Do not use.

Get immutable flag As a rule, subclasses will access directly

Returns:

Immutable flag

setImmutable

@Deprecated
public CDMNode setImmutable()

Deprecated. Do not use.

Set the immutable flag to true. Once set, cannot be unset

getDODSName

@Deprecated
public java.lang.String getDODSName()

Deprecated. Do not use.

Get the dodsname

Returns:

the original names from the DDS or DAS; if null, then return the short name

setDODSName

@Deprecated
public void setDODSName(java.lang.String name)

Deprecated. Do not use.

Store the original dods name

Parameters:

name - The original name from the DDS/DAS

getFullName

@Deprecated
public java.lang.String getFullName()

Deprecated. use NetcdfFiles.makeFullName(*)

Get the Full name of this object. Certain characters are backslash escaped (see NetcdfFile)

Returns:

full name with backslash escapes

getFullNameEscaped

public java.lang.String getFullNameEscaped()

Deprecated. use getFullName() when it exists in ver6.

Alias for getFullName

Returns:

full name with backslash escapes

getName

@Deprecated
public java.lang.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.

localhash

public int localhash()

Deprecated. do not use

unwrap

@Deprecated
public static CDMNode unwrap(CDMNode node)

Deprecated. Do not use.

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

@Deprecated
public java.lang.Object annotation(java.lang.Object id)

Deprecated. do not use

annotate

public java.lang.Object annotate(java.lang.Object id,
                                 java.lang.Object value)

Deprecated. do not use