org.das2.util.catalog

Interface DasNode

All Known Subinterfaces:

DasDirNode, DasSrcNode

All Known Implementing Classes:

HttpGetSrcNode

public interface DasNode

A single node from the das2 federated catalog

Method Summary

Modifier and Type	Method and Description
DasNode	getRoot() Return the highest node reachable by this catalog node.
boolean	isDir() Can this catalog node have the sub-nodes?
boolean	isInfo() Is this object an information node.
boolean	isRoot() Is this object a detached root of a catalog tree.
boolean	isSrc() Can this catalog node provide data
java.lang.String	name() get the node name
java.lang.String	path() get the node path
java.lang.String	toString() A summary of the node
java.lang.String	type() Get the node type.

Method Detail

type

java.lang.String type()

Get the node type.

Returns:

A string representing the node type

name

java.lang.String name()

get the node name

Returns:

The human readable name of the node, not it's path ID

path

java.lang.String path()

get the node path

Returns:

The catalog path to this node. For root nodes this is null

toString

java.lang.String toString()

A summary of the node

Overrides:

toString in class java.lang.Object

Returns:

A short string describing the node, not an info dump of the contents

isRoot

boolean isRoot()

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. A detached source or info node can still be a root node without also being a directory.

Returns:

true if no higher node is reachable from this one.

isSrc

boolean isSrc()

Can this catalog node provide data

Returns:

true if this node describes one or more data sources

isDir

boolean isDir()

Can this catalog node have the sub-nodes?

Returns:

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

isInfo

boolean isInfo()

Is this object an information node.

Returns:

true if this node in the catalog provides a description of a mission, spacecraft, instrument, person or any other item category

getRoot

DasNode getRoot()

Return the highest node reachable by this catalog node.

Returns:

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