DapDataset (d4core 5.1.0-SNAPSHOT API)

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 class defines a non-Gridd Grid: i.e. one with an atomic type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<DapStructure>`	`allcompounds`
`protected List<DapDimension>`	`alldimensions`
`protected List<DapEnumeration>`	`allenums`
`protected List<DapGroup>`	`allgroups`
`protected List<DapVariable>`	`allvariables`
`protected List<DapDimension>`	`anonymousdims`
`protected String`	`base`
`protected CEConstraint`	`ce`
`protected String`	`dapversion`
`protected String`	`dmrversion`
`protected boolean`	`finished`
`protected Map<String,DapNode>`	`fqnmap`
`protected List<DapNode>`	`nodelist`
`protected String`	`ns`
`protected List<DapVariable>`	`topvariables`
`protected 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(String name)

Constructors
Constructor and Description
`DapDataset()`
`DapDataset(String name)`

Method Summary

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

Methods inherited from class dap4.core.dmr.DapGroup
addDecl, 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 List<DapNode> nodelist
```

fqnmap
```
protected Map<String,DapNode> fqnmap
```

anonymousdims

protected List<DapDimension> anonymousdims

visiblenodes
```
protected List<DapNode> visiblenodes
```

dapversion
```
protected String dapversion
```

dmrversion
```
protected String dmrversion
```

base
```
protected String base
```

ns
```
protected String ns
```

topvariables

protected List<DapVariable> topvariables

allvariables

protected List<DapVariable> allvariables

allgroups
```
protected List<DapGroup> allgroups
```

allenums

protected List<DapEnumeration> allenums

allcompounds

protected List<DapStructure> allcompounds

alldimensions

protected List<DapDimension> alldimensions

finished
```
protected boolean finished
```

Constructor Detail

DapDataset
```
public DapDataset()
```

DapDataset
```
public DapDataset(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 DapDataset setConstraint(CEConstraint ce)
```
- getDapVersion
```
public String getDapVersion()
```
- setDapVersion
```
public void setDapVersion(String value)
```
- getDMRVersion
```
public String getDMRVersion()
```
- setDMRVersion
```
public void setDMRVersion(String value)
```
- getNS
```
public String getNS()
```
- setNS
```
public void setNS(String value)
```
- getBase
```
public String getBase()
```
- setBase
```
public void setBase(String value)
```
- getFQNMap
```
public Map<String,DapNode> getFQNMap()
```
- setFQNMap
```
public void setFQNMap(Map<String,DapNode> fqnmap)
```
- getNodeList
```
public List<DapNode> getNodeList()
```
- getTopVariables
```
public List<DapVariable> getTopVariables()
```
- addNode
```
public void addNode(DapNode newnode)
```
- createAnonymous
```
public DapDimension createAnonymous(long size)
                             throws DapException
```
  Throws:
  
  DapException
- getIterator
```
public DapIterator getIterator(EnumSet<DapSort> sortset)
```
- lookup
```
public DapNode lookup(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,
                  List<DapNode> sortlist)
```
  Sort helper
  
  Parameters:
  
  node - the current node we are traversing

Class DapDataset

Field Summary

Fields inherited from class dap4.core.dmr.DapGroup

Fields inherited from class dap4.core.dmr.DapNode

Constructor Summary

Method Summary

Methods inherited from class dap4.core.dmr.DapGroup

Methods inherited from class dap4.core.dmr.DapNode

Methods inherited from class java.lang.Object

Field Detail

ce

nodelist

fqnmap

anonymousdims

visiblenodes

dapversion

dmrversion

base

ns

topvariables

allvariables

allgroups

allenums

allcompounds

alldimensions

finished

Constructor Detail

DapDataset

DapDataset

Method Detail

finish

finishR

getConstraint

setConstraint

getDapVersion

setDapVersion

getDMRVersion

setDMRVersion

getNS

setNS

getBase

setBase

getFQNMap

setFQNMap

getNodeList

getTopVariables

addNode

createAnonymous

getIterator

lookup

sort

sortR