oracle.jdeveloper.rescat2.model.nodes

Class DirContextNode

java.lang.Object

oracle.ide.model.Node

oracle.jdeveloper.rescat2.model.nodes.GenericNode<E>

oracle.jdeveloper.rescat2.model.nodes.ExtendedGenericNode<Element>

oracle.jdeveloper.rescat2.model.nodes.DirContextNode

All Implemented Interfaces:

Displayable, Element, LazyLoadable, Locatable, Subject, Dirtyable, InlineSearchable

Direct Known Subclasses:

CatalogContextNode, RepositoryRootNode

public class DirContextNode
extends ExtendedGenericNode<Element>
implements InlineSearchable

Field Summary

Fields inherited from class oracle.ide.model.Node

LOG_READONLY

Constructor Summary

Constructors

Constructor and Description
DirContextNode(RescatContext rescatContext, Element parent, oracle.adf.rc.core.CatalogContext catalogContext, java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
boolean	canClearInlineSearch()
void	clearCache()
protected void	forceRefreshImpl() hook for subclasses to extend the behavior of forceRefresh() such as clearing intermediate caches.
void	getAttributeDescriptors(java.util.HashMap<java.lang.String,oracle.adf.rc.attribute.AttributeDescriptor> attributeDescriptors) Fills attributeDescriptors with distinct AttributeDescriptors.
oracle.adf.rc.core.CatalogContext	getCatalogContext()
java.util.Iterator<Element>	getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
protected java.util.Comparator<Element>	getElementComparator() Returns the Comparator that should be used for sorting the children of this node.
java.lang.String	getFilter()
javax.swing.Icon	getIcon() Displayable interface method.
protected javax.swing.Icon	getIconOverlays(javax.swing.Icon icon)
java.lang.String	getLongLabel() Displayable interface method.
java.lang.String	getName()
java.lang.String	getShortLabel() Displayable interface method.
java.lang.String	getToolTipText() Displayable interface method.
java.net.URL	getURL() Returns the URL that identifies this Locatable.
protected void	installFilter()
protected void	installListeners(oracle.adf.rc.core.CatalogContext catalogContext)
protected boolean	isTrackedInNodeCache() The return value of this method indicates whether this Node should be tracked by the NodeFactory cache.
protected void	loadCache() loadCache is invoked to populate the child cache the first time the node is expanded or after the cache has been cleared either by calling ExtendedGenericNode.clearCache() or GenericNode.forceRefresh().
javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	search(java.lang.String filter)
protected void	setCatalogContext(oracle.adf.rc.core.CatalogContext ctx)
void	setFilter(java.lang.String filterExpression)
void	setSearchRunnable(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable)
protected void	updateCache() updateCache is invoked when GenericNode.getChildren() is called and the cache has previously been loaded by ExtendedGenericNode.loadCache().
void	whenInlineSearchCancelled(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable)
void	whenInlineSearchCleared()
void	whenInlineSearchFinished(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable, oracle.jdevimpl.rescat2.model.search.SearchParameters search, Folder searchResults)
void	whenInlineSearchStarted(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable, oracle.jdevimpl.rescat2.model.search.SearchParameters search)

Methods inherited from class oracle.jdeveloper.rescat2.model.nodes.ExtendedGenericNode

addChild, containsChild, containsKey, getCacheKeys, getChild, getChildrenImpl, getDummyChild, removeChild

Methods inherited from class oracle.jdeveloper.rescat2.model.nodes.GenericNode

equalsImpl, forceRefresh, getFullPath, getParent, getPathFrom, getRescatContext, mayHaveChildren, setAttributes, setFilterControl, whenDelete, whenDelete, whenProperties, whenRename, whenRename

Methods inherited from class oracle.ide.model.Node

addNodeListener, addNodeListenerForType, addNodeListenerForTypeHierarchy, addWeakNodeListener, attach, beginThreadNodeUsageCycle, callUnderReadLock, callUnderWriteLock, close, closeImpl, createSubject, delete, deleteImpl, detach, endThreadNodeUsage, endThreadNodeUsageCycle, ensureOpen, equalsImpl, getAttributes, getData, getInputStream, getSubject, getTimestamp, getTimestampLoadedUnsafe, getTransientProperties, getUnmodifiedTimestamp, isDirty, isLoaded, isLockHeld, isMigrating, isNew, isOpen, isReadLocked, isReadLockHeld, isReadOnly, isReadOrWriteLocked, isTrackingThreadNodeUsage, isWriteLocked, isWriteLockHeld, lockCount, markDirty, markDirtyImpl, nodeLock, notifyObservers, open, openImpl, readLock, readLockCount, readLockInterruptibly, readUnlock, refreshTimestamp, removeNodeListener, removeNodeListenerForType, removeNodeListenerForTypeHierarchy, removeWeakNodeListener, rename, renameImpl, reportOpenException, revert, revertImpl, runUnderReadLock, runUnderWriteLock, save, saveImpl, setEventLog, setMigrating, setOpen, setReadOnly, setTimestampDirectly, setURL, toString, tryRunUnderReadLock, tryRunUnderWriteLock, unsetMigrating, upgradeLock, upgradeUnlock, urlReadOnlyChanged, writeLock, writeLockCount, writeLockInterruptibly, writeUnlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel

Constructor Detail

DirContextNode

public DirContextNode(RescatContext rescatContext,
                      Element parent,
                      oracle.adf.rc.core.CatalogContext catalogContext,
                      java.lang.String name,
                      java.lang.String description)

Method Detail

installListeners

protected void installListeners(oracle.adf.rc.core.CatalogContext catalogContext)

loadCache

protected void loadCache()

Description copied from class: ExtendedGenericNode

loadCache is invoked to populate the child cache the first time the node is expanded or after the cache has been cleared either by calling ExtendedGenericNode.clearCache() or GenericNode.forceRefresh(). Use ExtendedGenericNode.addChild(java.lang.String, E) to add each child element to the cache.

Specified by:

loadCache in class ExtendedGenericNode<Element>

updateCache

protected void updateCache()

Description copied from class: ExtendedGenericNode

updateCache is invoked when GenericNode.getChildren() is called and the cache has previously been loaded by ExtendedGenericNode.loadCache(). This method lets you review the contents of cache and add or remove entries as needed. If the list of children is static, then this method should be a no-op. However, if the list of children is relatively dynamic, you may want to review the contents of the cache and add/remove children as needed. The advantage of keeping the same child instance in the cache rather than re-creating it frequently is that each child's own cache can be retained.

Specified by:

updateCache in class ExtendedGenericNode<Element>

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Node

Displayable interface method. The Node class returns the file name part of the currently set URL. If the currently set URL is null, then this method returns "<null>".

Specified by:

getShortLabel in interface Displayable

Overrides:

getShortLabel in class Node

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getName

public java.lang.String getName()

getLongLabel

public java.lang.String getLongLabel()

Description copied from class: Node

Displayable interface method. The Node class returns the path name part of the currently set URL. If the currently set URL is null, then this method returns "<null>".

Specified by:

getLongLabel in interface Displayable

Overrides:

getLongLabel in class GenericNode<Element>

Returns:

a long descriptive label of the Displayable that can be shown to the user.

getCatalogContext

public final oracle.adf.rc.core.CatalogContext getCatalogContext()

setCatalogContext

protected final void setCatalogContext(oracle.adf.rc.core.CatalogContext ctx)

getAttributeDescriptors

public final void getAttributeDescriptors(java.util.HashMap<java.lang.String,oracle.adf.rc.attribute.AttributeDescriptor> attributeDescriptors)
                                   throws javax.naming.NamingException

Fills attributeDescriptors with distinct AttributeDescriptors.

Parameters:

attributeDescriptors - a map of AttributeDescriptor.getId()/ AttributeDescriptor

Throws:

javax.naming.NamingException

search

public final javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> search(java.lang.String filter)
                                                                                 throws javax.naming.NamingException

Throws:

javax.naming.NamingException

getURL

public final java.net.URL getURL()

Description copied from interface: Locatable

Returns the URL that identifies this Locatable. Parts of the IDE will use the value of this URL as a hash key for caching UI components for this Locatable. Therefore, URL uniqueness is important.

Specified by:

getURL in interface Locatable

Overrides:

getURL in class Node

Returns:

The URL identifying this Locatable.

isTrackedInNodeCache

protected final boolean isTrackedInNodeCache()

Description copied from class: Node

The return value of this method indicates whether this Node should be tracked by the NodeFactory cache. The default return value is true. Node types that should not be tracked by the NodeFactory cache should override this method to return false.

Overrides:

isTrackedInNodeCache in class Node

Returns:

true if this Node should be tracked by the IDE's NodeFactory cache; false otherwise.

getToolTipText

public java.lang.String getToolTipText()

Description copied from class: Node

Displayable interface method. The Node class returns returns the String form of the currently set URL.

Specified by:

getToolTipText in interface Displayable

Overrides:

getToolTipText in class Node

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

getFilter

public final java.lang.String getFilter()

setFilter

public final void setFilter(java.lang.String filterExpression)

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Node

Displayable interface method. The Node class returns a generic icon.

Specified by:

getIcon in interface Displayable

Overrides:

getIcon in class GenericNode<Element>

Returns:

the Icon to be displayed for the Displayable.

getIconOverlays

protected javax.swing.Icon getIconOverlays(javax.swing.Icon icon)

Overrides:

getIconOverlays in class GenericNode<Element>

clearCache

public void clearCache()

Overrides:

clearCache in class ExtendedGenericNode<Element>

forceRefreshImpl

protected void forceRefreshImpl()

Description copied from class: GenericNode

hook for subclasses to extend the behavior of forceRefresh() such as clearing intermediate caches.

Overrides:

forceRefreshImpl in class ExtendedGenericNode<Element>

getElementComparator

protected java.util.Comparator<Element> getElementComparator()

Description copied from class: GenericNode

Returns the Comparator that should be used for sorting the children of this node.

Overrides:

getElementComparator in class GenericNode<Element>

Returns:

the Comparator that should be used for sorting the children of this node.

installFilter

protected void installFilter()

getChildren

public java.util.Iterator<Element> getChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return null from this method. An implementation of Element that could represent a non-leaf in a tree structure should return either an Iterator over the child Elements or null if there are no children.

Specified by:

getChildren in interface Element

Overrides:

getChildren in class GenericNode<Element>

Returns:

an Iterator over any child Elements contained by this Element. If there are no children, null is returned.

whenInlineSearchStarted

public void whenInlineSearchStarted(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable,
                                    oracle.jdevimpl.rescat2.model.search.SearchParameters search)

Specified by:

whenInlineSearchStarted in interface InlineSearchable

whenInlineSearchCancelled

public void whenInlineSearchCancelled(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable)

Specified by:

whenInlineSearchCancelled in interface InlineSearchable

whenInlineSearchFinished

public void whenInlineSearchFinished(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable,
                                     oracle.jdevimpl.rescat2.model.search.SearchParameters search,
                                     Folder searchResults)

Specified by:

whenInlineSearchFinished in interface InlineSearchable

whenInlineSearchCleared

public void whenInlineSearchCleared()

Specified by:

whenInlineSearchCleared in interface InlineSearchable

setSearchRunnable

public void setSearchRunnable(oracle.jdevimpl.rescat2.model.search.SearchRunnable runnable)

canClearInlineSearch

public boolean canClearInlineSearch()

Specified by:

canClearInlineSearch in interface InlineSearchable