dap4.core.dmr

Class DapDataset

java.lang.Object

dap4.core.dmr.DapNode

dap4.core.dmr.DapGroup

dap4.core.dmr.DapDataset

All Implemented Interfaces:

DapDecl

public class DapDataset
extends DapGroup

This is the root object of a DMR tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DapStructure>	allcompounds
protected java.util.List<DapDimension>	alldimensions
protected java.util.List<DapEnumeration>	allenums
protected java.util.List<DapGroup>	allgroups
protected java.util.List<DapVariable>	allvariables
protected java.util.List<DapDimension>	anonymousdims
protected java.lang.String	base
protected CEConstraint	ce
protected java.util.Map<DapVariable,java.lang.Long>	checksummap
protected java.lang.String	dapversion
protected java.lang.String	dmrversion
protected boolean	finished
protected java.util.Map<java.lang.String,DapNode>	fqnmap
protected java.util.List<DapNode>	nodelist
protected java.lang.String	ns
protected java.util.List<DapVariable>	topvariables
protected java.util.List<DapNode>	visiblenodes

Fields inherited from class dap4.core.dmr.DapGroup

compounds, decls, dimensions, enums, groups, variables

Fields inherited from class dap4.core.dmr.DapNode

annotations, attributes, dataset, escapedname, fqn, index, parent, shortname, sort, xmlattributes

Constructor Summary

Constructors

Constructor and Description
DapDataset()
DapDataset(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addNode(DapNode newnode)
DapDimension	createAnonymous(long size)
void	finish()
protected void	finishR(DapNode node) Recursive helper
java.lang.String	getBase()
CEConstraint	getConstraint()
java.lang.String	getDapVersion()
java.lang.String	getDMRVersion()
java.util.Map<java.lang.String,DapNode>	getFQNMap()
DapIterator	getIterator(java.util.EnumSet<DapSort> sortset)
java.util.List<DapNode>	getNodeList()
java.lang.String	getNS()
java.util.List<DapVariable>	getTopVariables()
DapNode	lookup(java.lang.String fqn, DapSort... sortset) Parse an FQN and use it to trace to a specific object in a dataset.
void	setBase(java.lang.String value)
void	setConstraint(CEConstraint ce)
void	setDapVersion(java.lang.String value)
void	setDMRVersion(java.lang.String value)
void	setFQNMap(java.util.Map<java.lang.String,DapNode> fqnmap)
void	setNS(java.lang.String value)
void	sort() Sort the nodelist into prefix left to right order
void	sortR(DapNode node, java.util.List<DapNode> sortlist) Sort helper

Methods inherited from class dap4.core.dmr.DapGroup

addDecl, containsDecl, findByFQN, findByName, findInGroup, findVariable, getCompounds, getDecls, getDimensions, getEnums, getGroups, getVariables, setDecls

Methods inherited from class dap4.core.dmr.DapNode

addAttribute, addXMLAttribute, annotate, annotation, computefqn, findAttribute, getAttributes, getContainer, getContainerPath, getDataset, getEscapedShortName, getFQN, getGroup, getGroupPath, getIndex, getParent, getPath, getShortName, getSort, getXMLAttributes, isTopLevel, overrideParent, removeAttribute, removeXMLAttribute, setAttribute, setAttributes, setDataset, setIndex, setParent, setShortName, setSort, toString

Methods inherited from class java.lang.Object

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

Field Detail

ce

protected CEConstraint ce

nodelist

protected java.util.List<DapNode> nodelist

fqnmap

protected java.util.Map<java.lang.String,DapNode> fqnmap

anonymousdims

protected java.util.List<DapDimension> anonymousdims

visiblenodes

protected java.util.List<DapNode> visiblenodes

dapversion

protected java.lang.String dapversion

dmrversion

protected java.lang.String dmrversion

base

protected java.lang.String base

ns

protected java.lang.String ns

topvariables

protected java.util.List<DapVariable> topvariables

allvariables

protected java.util.List<DapVariable> allvariables

allgroups

protected java.util.List<DapGroup> allgroups

allenums

protected java.util.List<DapEnumeration> allenums

allcompounds

protected java.util.List<DapStructure> allcompounds

alldimensions

protected java.util.List<DapDimension> alldimensions

finished

protected boolean finished

checksummap

protected java.util.Map<DapVariable,java.lang.Long> checksummap

Constructor Detail

DapDataset

public DapDataset()

DapDataset

public DapDataset(java.lang.String name)

Method Detail

finish

public void finish()

finishR

protected void finishR(DapNode node)

Recursive helper

Parameters:

node - to walk

getConstraint

public CEConstraint getConstraint()

setConstraint

public void setConstraint(CEConstraint ce)

getDapVersion

public java.lang.String getDapVersion()

setDapVersion

public void setDapVersion(java.lang.String value)

getDMRVersion

public java.lang.String getDMRVersion()

setDMRVersion

public void setDMRVersion(java.lang.String value)

getNS

public java.lang.String getNS()

setNS

public void setNS(java.lang.String value)

getBase

public java.lang.String getBase()

setBase

public void setBase(java.lang.String value)

getFQNMap

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

setFQNMap

public void setFQNMap(java.util.Map<java.lang.String,DapNode> fqnmap)

getNodeList

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

getTopVariables

public java.util.List<DapVariable> getTopVariables()

addNode

public void addNode(DapNode newnode)

createAnonymous

public DapDimension createAnonymous(long size)
                             throws DapException

Throws:

DapException

getIterator

public DapIterator getIterator(java.util.EnumSet<DapSort> sortset)

lookup

public DapNode lookup(java.lang.String fqn,
                      DapSort... sortset)
               throws DapException

Parse an FQN and use it to trace to a specific object in a dataset. Note that this is quite tricky in the face of backslash escapes. Because of backslash escapes, we cannot use the String.split function because it does appear to be possible to write a regexp that handles preceding backslashes correctly. Instead, we must parse character by character left to right. Traversal into structs: In theory, a map variable could point to a field of a structure. However, in practice, this will not work because we would need a specific instance of that field, which means including dimension indices must be included starting from some top-level variable. We choose, for now, to make that illegal until such time as there is a well-defined meaning for this. Note: this assumes the fqn is absolute (i.e. starts with '/').

Parameters:

fqn - the fully qualified name

sortset - the kind(s) of object we are looking for

Returns:

the matching Dap Node or null if not found

Throws:

DapException

sort

public void sort()

Sort the nodelist into prefix left to right order

sortR

public void sortR(DapNode node,
                  java.util.List<DapNode> sortlist)

Sort helper

Parameters:

node - the current node we are traversing