dap4.core.dmr

Class DapNode

java.lang.Object

dap4.core.dmr.DapNode

Direct Known Subclasses:

DapAttribute, DapDimension, DapEnumConst, DapGroup, DapMap, DapType, DapVariable

public abstract class DapNode
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Object,java.lang.Object>	annotations
protected java.util.Map<java.lang.String,DapAttribute>	attributes DAP Attributes attached to this node (as opposed to the xml attributes)
protected DapDataset	dataset
protected java.lang.String	escapedname Escaped version of shortname
protected java.lang.String	fqn Fully qualified name; note that this is always backslash escaped
protected int	index Assign unique id to all nodes.
protected DapNode	parent Parent DapNode; may be: - Group (for e.g.
protected java.lang.String	shortname Unqualified (short) name of this node wrt the tree.
protected DapSort	sort Assign a "sort" to this node to avoid use of instanceof().
protected java.util.Map<java.lang.String,java.lang.String>	xmlattributes XML Attributes attached to this node.

Constructor Summary

Constructors

Constructor and Description
DapNode()
DapNode(java.lang.String shortname)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(DapAttribute attr)
void	addXMLAttribute(java.lang.String name, java.lang.String value)
DapNode	annotate(java.lang.Object id, java.lang.Object value)
java.lang.Object	annotation(java.lang.Object id)
java.lang.String	computefqn() Compute the FQN of this node
DapAttribute	findAttribute(java.lang.String name)
java.util.Map<java.lang.String,DapAttribute>	getAttributes()
DapNode	getContainer() Closest containing group, structure, sequence
java.util.List<DapNode>	getContainerPath() Get the transitive list of containers Not including this node
DapDataset	getDataset()
java.lang.String	getEscapedShortName() Here, escaped means backslash escaped short name
java.lang.String	getFQN()
DapGroup	getGroup() Closest containing group
java.util.List<DapGroup>	getGroupPath() Get the transitive list of containing groups Possibly including this node
int	getIndex()
DapNode	getParent()
java.util.List<DapNode>	getPath() Compute the path upto, and including some specified containing node (null=>root) The containing node is included as is this node.
java.lang.String	getShortName()
DapSort	getSort()
java.util.Map<java.lang.String,java.lang.String>	getXMLAttributes()
boolean	isTopLevel()
void	overrideParent(DapNode parent) Same as setparent except existing parent can be non-null
void	removeAttribute(DapAttribute attr) Used by AbstractDSP to suppress certain attributes.
void	removeXMLAttribute(java.lang.String name)
DapAttribute	setAttribute(DapAttribute attr)
void	setAttributes(java.util.Map<java.lang.String,DapAttribute> alist)
void	setDataset(DapDataset dataset)
void	setIndex(int index)
void	setParent(DapNode parent) Set the parent DapNode; may sometimes be same as container, but not always (think attributes or maps).
void	setShortName(java.lang.String shortname)
void	setSort(DapSort sort)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sort

protected DapSort sort

Assign a "sort" to this node to avoid use of instanceof().

index

protected int index

Assign unique id to all nodes. Id is unique relative to the whole tree only. and reflects the order within nodelist

shortname

protected java.lang.String shortname

Unqualified (short) name of this node wrt the tree. This is raw (unescaped)

escapedname

protected java.lang.String escapedname

Escaped version of shortname

parent

protected DapNode parent

Parent DapNode; may be: - Group (for e.g. variables, dimensions, and Types), - Structure, Sequence for Fields - Variable (for e.g. attributes or maps).

dataset

protected DapDataset dataset

fqn

protected java.lang.String fqn

Fully qualified name; note that this is always backslash escaped

attributes

protected java.util.Map<java.lang.String,DapAttribute> attributes

DAP Attributes attached to this node (as opposed to the xml attributes)

xmlattributes

protected java.util.Map<java.lang.String,java.lang.String> xmlattributes

XML Attributes attached to this node. Used to pass reserved extra info to the client.

annotations

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

Constructor Detail

DapNode

public DapNode()

DapNode

public DapNode(java.lang.String shortname)

Method Detail

annotate

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

annotation

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

getAttributes

public java.util.Map<java.lang.String,DapAttribute> getAttributes()

setAttributes

public void setAttributes(java.util.Map<java.lang.String,DapAttribute> alist)

setAttribute

public DapAttribute setAttribute(DapAttribute attr)
                          throws DapException

Throws:

DapException

addAttribute

public void addAttribute(DapAttribute attr)
                  throws DapException

Throws:

DapException

removeAttribute

public void removeAttribute(DapAttribute attr)
                     throws DapException

Used by AbstractDSP to suppress certain attributes.

Parameters:

attr -

Throws:

DapException

findAttribute

public DapAttribute findAttribute(java.lang.String name)

getXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> getXMLAttributes()

addXMLAttribute

public void addXMLAttribute(java.lang.String name,
                            java.lang.String value)
                     throws DapException

Throws:

DapException

removeXMLAttribute

public void removeXMLAttribute(java.lang.String name)
                        throws DapException

Throws:

DapException

getSort

public DapSort getSort()

setSort

public void setSort(DapSort sort)

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

getDataset

public DapDataset getDataset()

setDataset

public void setDataset(DapDataset dataset)

getGroup

public DapGroup getGroup()

Closest containing group

Returns:

closest group not equal to this or null if this is a DapDataset

getContainer

public DapNode getContainer()

Closest containing group, structure, sequence

Returns:

closest container

getParent

public DapNode getParent()

setParent

public void setParent(DapNode parent)

Set the parent DapNode; may sometimes be same as container, but not always (think attributes or maps). Invariant: parent must be either a group or a variable. We can infer the container, so set that also.

Parameters:

parent - the proposed parent node

overrideParent

public void overrideParent(DapNode parent)

Same as setparent except existing parent can be non-null

Parameters:

parent - the proposed parent node

getShortName

public java.lang.String getShortName()

setShortName

public void setShortName(java.lang.String shortname)

getEscapedShortName

public java.lang.String getEscapedShortName()

Here, escaped means backslash escaped short name

Returns:

escaped name

getFQN

public java.lang.String getFQN()

getPath

public java.util.List<DapNode> getPath()

Compute the path upto, and including some specified containing node (null=>root) The containing node is included as is this node.

Returns:

ordered list of parent nodes

getContainerPath

public java.util.List<DapNode> getContainerPath()

Get the transitive list of containers Not including this node

Returns:

list of container nodes

getGroupPath

public java.util.List<DapGroup> getGroupPath()

Get the transitive list of containing groups Possibly including this node

Returns:

list of group nodes

computefqn

public java.lang.String computefqn()

Compute the FQN of this node

isTopLevel

public boolean isTopLevel()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object