com.metamatrix.common.tree.directory
Interface DirectoryEntryView

All Superinterfaces:

PropertiedObjectView, TreeView, UserTransactionFactory

All Known Implementing Classes:

FileSystemView, RuledDirectoryEntryViewImpl

public interface DirectoryEntryView
extends TreeView

This interface defines a view of a hierarchy of DirectoryEntry instances. A directory has a constraint above and beyond tree that requires no two children of a DirectoryEntry may have the same name.

Method Summary

DirectoryEntryEditor	getDirectoryEntryEditor() Return the directory entry editor for this view.
DirectoryEntry	lookup(java.lang.String path) Lookup the node referenced by the relative path in this view.
DirectoryEntry	lookup(java.lang.String path, java.lang.String separator) Lookup the node referenced by the relative path in this view, but specify a separator.

Methods inherited from interface com.metamatrix.common.tree.TreeView

allowsChild, allowsChildren, getChildren, getComparator, getFilter, getHome, getMarked, getParent, getPath, getPropertyDefinitions, getRoots, getSeparator, getSeparatorChar, getTreeNodeEditor, isAncestorOf, isHidden, isMarked, isParentOf, isRoot, iterator, iterator, setComparator, setFilter, setMarked

Methods inherited from interface com.metamatrix.common.object.PropertiedObjectView

getPropertiedObjectEditor

Methods inherited from interface com.metamatrix.common.transaction.UserTransactionFactory

createReadTransaction, createWriteTransaction, createWriteTransaction

Method Detail

getDirectoryEntryEditor

DirectoryEntryEditor getDirectoryEntryEditor()

Return the directory entry editor for this view.

Returns:

the DirectoryEntryEditor instance

lookup

DirectoryEntry lookup(java.lang.String path)

Lookup the node referenced by the relative path in this view. Depending upon the implementation, this method may return a null reference if a node with the specified path is not found.

Parameters:

path - the path of the desired node specified in terms of this view (i.e., the result of calling getPath() on this view with the returned node as the parameter should result in the same value as path); may not be null or zero-length

Returns:

the node referenced by the specified path, or null if no such node exists

Throws:

java.lang.AssertionError - if the path is null or zero-length

lookup

DirectoryEntry lookup(java.lang.String path,
                      java.lang.String separator)

Lookup the node referenced by the relative path in this view, but specify a separator. This method allows the lookup of a path with a different separator than used by this view. Depending upon the implementation, this method may return a null reference if a node with the specified path is not found.

Parameters:

path - the path of the desired node specified in terms of this view (i.e., the result of calling getPath() on this view with the returned node as the parameter should result in the same value as path); may not be null or zero-length

separater - the string used to separate the components of a name.

Returns:

the node referenced by the specified path, or null if no such node exists

Throws:

java.lang.AssertionError - if the path is null or zero-length