org.das2.catalog

Interface DasDirNode

All Superinterfaces:

DasNode

All Known Implementing Classes:

AbstractDirNode

public interface DasDirNode
extends DasNode

All directory node objects can have children

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 interface org.das2.catalog.DasNode

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

Method Detail

list

java.lang.String[] list()

List child nodes of this directory type item

Returns:

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

get

DasNode get(java.lang.String sChildId)

Get a child node by it's ID.

Parameters:

sChildId -

Returns:

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

childPath

java.lang.String childPath(DasNode child)

Given a child object get the complete path to it

Parameters:

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

Returns:

pathSeparator

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.

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

resolve

DasNode resolve(java.lang.String sSubPath,
                ProgressMonitor mon)
         throws DasResolveException

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

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:

org.das2.util.catalog.DasResolveException - If the given sub-path could not be resolved by the catalog.

DasResolveException

nearest

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

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.