org.das2.catalog.impl

Class AbstractNode

java.lang.Object

org.das2.catalog.impl.AbstractNode

All Implemented Interfaces:

DasNode

Direct Known Subclasses:

AbstractDirNode, AbstractSrcNode

public abstract class AbstractNode
extends java.lang.Object
implements DasNode

All nodes loadable by the DasNodeFactory should inherit from this package private abstract class. It supports the general 3-phase construction. In general the construction phases are: 1. Create a stub object that knows what kind of thing it is and who it's parents are. 2. Resolve one of the URLs to get a full definition of the object. 3. Possibly merge information from a secondary URL if requested.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.das2.catalog.impl.AbstractNode.NodeDefLoc>	lLocs
protected DasDirNode	parent
protected java.lang.String	sName

Method Summary

Modifier and Type	Method and Description
DasNode	getRoot() Return the highest node reachable by this catalog node.
boolean	isRoot() Is this object a detached root of a catalog tree.
java.lang.String	name() get the node name
java.lang.String	path() get the node path
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
java.lang.String	toString() A summary of the node

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.catalog.DasNode

isDir, isInfo, isLoaded, isSrc, load, prop, prop, type

Field Detail

sName

protected java.lang.String sName

parent

protected DasDirNode parent

lLocs

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

Method Detail

name

public java.lang.String name()

Description copied from interface: DasNode

get the node name

Specified by:

name in interface DasNode

Returns:

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

path

public java.lang.String path()

Description copied from interface: DasNode

get the node path

Specified by:

path in interface DasNode

Returns:

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

toString

public java.lang.String toString()

Description copied from interface: DasNode

A summary of the node

Specified by:

toString in interface DasNode

Overrides:

toString in class java.lang.Object

Returns:

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

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

isRoot

public boolean isRoot()

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

Specified by:

isRoot in interface DasNode

Returns:

true if no higher node is reachable from this one.

getRoot

public DasNode getRoot()

Description copied from interface: DasNode

Return the highest node reachable by this catalog node.

Specified by:

getRoot in interface DasNode

Returns:

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