org.das2.util.catalog

Class DasDirNodeCat

java.lang.Object

org.das2.util.catalog.DasDirNodeCat

All Implemented Interfaces:

DasDirNode, DasNode

public class DasDirNodeCat
extends java.lang.Object

This represents a catalog node. It has a 2-phase construction sequence A minimal version may reside in memory representing just a referenced item from a higher level container, or it may be fully realized by a catalog lookup. Loading the full node is delayed until the functionality of a full definition is needed. For example a minimal catalog entry will load itself when a list of sub items is called for. A minimal data source entry will load itself when a data request or interface definition request occurs. All Nodes have the following data members: path - The Path URI of this object. This is a conceptual location, not a physical path. Even nodes loaded from a local file can have a path URI. A root node for a given tree has a 'null' path URI. You can't navigate above a root node, but, depending on the node type, you can navigate down. type - The type of object, cannot be null name - The name of the object url - Where the item was loaded from (if fully realized) locs - Where you can get the full item definition from if needed data - The string information read in to generate the node. The actual format of this data is may be JSON, XML, or some other format. * @author cwp

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.das2.util.catalog.DasAbstractNode>	dSubNodes
protected java.util.List<org.das2.util.catalog.DasAbstractNode.NodeDefLoc>	lLocs
protected DasDirNode	nodePar
protected java.lang.String	sId
protected java.lang.String	sName
protected java.lang.String	sSep
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
DasDirNodeCat(DasDirNode parent, java.lang.String id, java.lang.String name, java.util.List<java.lang.String> locations)

Method Summary

Modifier and Type	Method and Description
DasNode	get(java.lang.String sChildId) Get a child node by it's ID.
DasNode	getRootNode() Return the highest node reachable by this catalog node.
protected void	initFromJson(org.json.JSONObject jo)
boolean	isDataSource() Can this catalog node provide data
boolean	isDir() Can this catalog node have the sub-nodes?
boolean	isRootNode() Is this object a detached root of a catalog tree.
java.lang.String[]	list() List child nodes of this directory type item
protected void	mergeFromJson(org.json.JSONObject jo)
java.lang.String	name() get the node name
java.lang.String	prettyPrintLoc(java.lang.String sPre, java.lang.String sSep) Get the root node list as a string with some separator and prefix
DasNode	resolve(java.lang.String sPath, ProgressMonitor mon) Walk down a give sub-path and retrieve a fully constructed descendant node.
java.lang.String	type() Get the node type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.util.catalog.DasNode

getRootNode, isRootNode, name

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

dSubNodes

protected java.util.Map<java.lang.String,org.das2.util.catalog.DasAbstractNode> dSubNodes

sSep

protected java.lang.String sSep

sId

protected java.lang.String sId

sName

protected java.lang.String sName

nodePar

protected DasDirNode nodePar

lLocs

protected java.util.List<org.das2.util.catalog.DasAbstractNode.NodeDefLoc> lLocs

Constructor Detail

DasDirNodeCat

public DasDirNodeCat(DasDirNode parent,
                     java.lang.String id,
                     java.lang.String name,
                     java.util.List<java.lang.String> locations)

Method Detail

type

public java.lang.String type()

Description copied from interface: DasNode

Get the node type.

Returns:

A string representing the node type

isDataSource

public boolean isDataSource()

Description copied from interface: DasNode

Can this catalog node provide data

Returns:

true if this node describes one or more data sources

isDir

public boolean isDir()

Description copied from interface: DasNode

Can this catalog node have the sub-nodes?

Returns:

true if this node can have child nodes, not that it necessarily contains any.

initFromJson

protected void initFromJson(org.json.JSONObject jo)
                     throws org.json.JSONException,
                            java.text.ParseException

Throws:

org.json.JSONException

java.text.ParseException

mergeFromJson

protected void mergeFromJson(org.json.JSONObject jo)

get

public DasNode get(java.lang.String sChildId)

Description copied from interface: DasDirNode

Get a child node by it's ID.

Returns:

The child node, or null if no child node has the id sChildId

list

public java.lang.String[] list()

Description copied from interface: DasDirNode

List child nodes of this directory type item

Specified by:

list in interface DasDirNode

Returns:

A list of child node string ids. Return values may be used in the get node function below.

resolve

public DasNode resolve(java.lang.String sPath,
                       ProgressMonitor mon)
                throws ResolutionException

Description copied from interface: DasDirNode

Walk down a give sub-path and retrieve a fully constructed descendant node.

Specified by:

resolve in interface DasDirNode

Parameters:

sPath - A sub-path to resolve into a fully loaded node. If this node is a root catalog, then the sub-path is the complete path.

mon - A progress monitor since sub-node lookup can involve network operations

Returns:

The full constructed child node object, or null if no such fully loadable sub object exits.

Throws:

ResolutionException - If the given sub-path could not be resolved by the catalog.

name

public java.lang.String name()

Description copied from interface: DasNode

get the node name

Specified by:

name in interface DasNode

prettyPrintLoc

public java.lang.String prettyPrintLoc(java.lang.String sPre,
                                       java.lang.String sSep)

Get the root node list as a string with some separator and prefix

Parameters:

sPre - A prefix to place before each root node URL, may be null

sSep - The separator to use between each root node URL, may be null

Returns:

A formatted string containing a list of all root node URLs

isRootNode

public boolean isRootNode()

Description copied from interface: DasNode

Is this object a detached root of a catalog tree. Note that the build in root URLs are always detached roots because there is no higher node to find.

Specified by:

isRootNode in interface DasNode

Returns:

true if no higher node is reachable from this one.

getRootNode

public DasNode getRootNode()

Description copied from interface: DasNode

Return the highest node reachable by this catalog node.

Specified by:

getRootNode in interface DasNode

Returns:

the highest node reachable by this catalog node, which may just be itself.