org.das2.catalog.impl

Class AbstractDirNode

java.lang.Object

org.das2.catalog.impl.AbstractNode

org.das2.catalog.impl.AbstractDirNode

All Implemented Interfaces:

DasDirNode, DasNode

public abstract class AbstractDirNode
extends AbstractNode
implements DasDirNode

All nodes which have child catalog nodes should inherit from this package private class. In addition to the 3-phase construction interface, this abstract class adds the ability to have sub-nodes, which is provided via the resolve() and nearest() functions. The two main data members intended for inheritance are dSubNodes and sSep. If derived classes use this sub-node list and fill in their separator string the sub-node resolution can be handled by this class with out overriding resolve() and nearest().

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,AbstractNode>	dSubNodes
protected java.lang.String	sSep The separator string used for sub-paths of this node, may be set to null or some other value by some nodes, defaults to "/".

Fields inherited from class org.das2.catalog.impl.AbstractNode

lLocs, parent, sName

Method Summary

Modifier and Type	Method and Description
java.lang.String	childPath(DasNode child) Given a child object get the complete path to it
DasNode	get(java.lang.String sChildId) Get a child node by it's ID.
java.lang.String[]	list() List child nodes of this directory type item
DasNode	nearest(java.lang.String sSubPath, ProgressMonitor mon) Walk down a given sub-path as far as possible and retrieve the closest descendant FIXME: Find a better name for this function, maybe resolveDeepest
java.lang.String	pathSeparator(ProgressMonitor mon) Get the separator string to place after my path but before then names of any child items when generating a child path string.
DasNode	resolve(java.lang.String sSubPath, ProgressMonitor mon) Walk down a given sub-path and retrieve a fully constructed descendant node.

Methods inherited from class org.das2.catalog.impl.AbstractNode

getRoot, isRoot, name, path, prettyPrintLoc, toString

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

getRoot, isDir, isInfo, isLoaded, isRoot, isSrc, load, name, path, prop, prop, toString, type

Field Detail

dSubNodes

protected java.util.Map<java.lang.String,AbstractNode> dSubNodes

sSep

protected java.lang.String sSep

The separator string used for sub-paths of this node, may be set to null or some other value by some nodes, defaults to "/".

Method Detail

childPath

public java.lang.String childPath(DasNode child)

Description copied from interface: DasDirNode

Given a child object get the complete path to it

Specified by:

childPath in interface DasDirNode

Parameters:

child - The child object for which the path is desired.

Returns:

pathSeparator

public java.lang.String pathSeparator(ProgressMonitor mon)

Description copied from interface: DasDirNode

Get the separator string to place after my path but before then names of any child items when generating a child path string.

Specified by:

pathSeparator in interface DasDirNode

Parameters:

mon - The separator may be defined in the object data which may trigger Phase-2 construction. Since this is a network operation a progress monitor may be supplied.

Returns:

The path separator string, which may be zero length (and that's okay).

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 sSubPath,
                       ProgressMonitor mon)
                throws DasResolveException

Description copied from interface: DasDirNode

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

Specified by:

resolve in interface DasDirNode

Parameters:

sSubPath - 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.

Throws:

DasResolveException

nearest

public DasNode nearest(java.lang.String sSubPath,
                       ProgressMonitor mon)

Description copied from interface: DasDirNode

Walk down a given sub-path as far as possible and retrieve the closest descendant FIXME: Find a better name for this function, maybe resolveDeepest

Specified by:

nearest in interface DasDirNode

Parameters:

sSubPath - 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 deepest resolvable node which may just be "this", or even the "parent" in cases where this node is a stub that can't even resolve itself.

get

public DasNode get(java.lang.String sChildId)

Description copied from interface: DasDirNode

Get a child node by it's ID.

Specified by:

get in interface DasDirNode

Returns:

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