oracle.jdevimpl.audit.model

Class DirectoryModelAdapter

java.lang.Object

oracle.jdeveloper.audit.model.ModelAdapter

oracle.jdeveloper.audit.model.ContainerModelAdapter

oracle.jdevimpl.audit.model.DirectoryModelAdapter

All Implemented Interfaces:

java.lang.Comparable<ModelAdapter>, Located

public class DirectoryModelAdapter
extends ContainerModelAdapter

A ModelAdapter which adapts the Audit framework to a directory in a content set. The @link ContentDirectory} object is the root construct of the model, its contained constructs are the model adapters for the Node and ContentDirectory elements corresponding to the files and directories in the directory.

See Also:

ModelAdapter, ContainerModelAdapter, DirectoryModelType

Method Summary

Modifier and Type	Method and Description
protected void	collectContainedElements() Collects the contained Elements of the root construct.
int	compareTo(ModelAdapter that) Gets whether this model is less than, equal to, or greater than another using the natural order defined by this class.
boolean	contains(ModelAdapter that) Gets whether this model contains a model.
boolean	contains(java.lang.Object construct, Location location) Gets whether a construct in this model contains a location.
ContainerModelAdapter	getContainingAdapter() Gets the model adapter containing this model adapter, or null if this is the root node.
ContentDirectory	getDirectory() Gets the package directory containing this model, or null if none.
Location[]	getElementLocations(Element element) Gets the locations of the constructs in this model corresponding to an IDE element.
javax.swing.Icon	getIcon(java.lang.Object construct) Gets the icon for a construct of this model.
java.lang.Object	getLabel(java.lang.Object construct) Gets the label for a construct of this model.
Node	getNode() Gets the IDE Node corresponding to this model, or null if none (in particular, if this is the root or a directory model).
java.lang.Object	getSummary(java.lang.Object construct) Gets the summary for a construct of this model.
java.lang.String	toString()

Methods inherited from class oracle.jdeveloper.audit.model.ContainerModelAdapter

addContainedElement, addContainedModel, addEmbeddedModel, getConstruct, getContainedConstructs, getContainedUnauditableElements, getLocation, getRootHook, getUrl, isFile

Methods inherited from class oracle.jdeveloper.audit.model.ModelAdapter

acquireReadLock, acquireReadLock, acquireReadLock, beginRead, beginRead, beginReadHook, cancelRead, compareSiblings, contains, contains, contextDescription, createModelAccessError, createModelAccessError, createModelAccessError, edit, endRead, endRead, endReadHook, enter, equals, exit, getAttribute, getCharacter, getColumnOffset, getConstruct, getDependency, getDirectoryAdapter, getElement, getEndLocation, getFactory, getFileAdapter, getFocusLocation, getFocusLocation, getIcon, getIdeContext, getInitialLength, getLabel, getLine, getLineOffset, getLocation, getLocation, getLock, getNavigationPoint, getPrimaryCollationKey, getProject, getProjectAdapter, getRoot, getSecondaryCollationKey, getSecondaryCollationString, getShortLabel, getSimpleName, getSummary, getText, getType, getUrl, getURL, getWorkspace, getWorkspaceAdapter, hashCode, isAccessible, isModifiable, isModified, isModified, isNavigable, isReadLockHeld, isWriteLockHeld, release, releaseReadLock, releaseReadLock, setAttribute, verifyModelAccess, verifyReadTransaction

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getContainingAdapter

public ContainerModelAdapter getContainingAdapter()

Description copied from class: ModelAdapter

Gets the model adapter containing this model adapter, or null if this is the root node.

Specified by:

getContainingAdapter in class ModelAdapter

getDirectory

public ContentDirectory getDirectory()

Description copied from class: ModelAdapter

Gets the package directory containing this model, or null if none.

Overrides:

getDirectory in class ModelAdapter

getElementLocations

public Location[] getElementLocations(Element element)

Description copied from class: ModelAdapter

Gets the locations of the constructs in this model corresponding to an IDE element. A read transaction must be active on this model.

Implementations need only deal with IDE element types that are returned by the getRootElementTypes and getContainedElementTypes methods of the model type for this model.

Overrides:

getElementLocations in class ContainerModelAdapter

Parameters:

element - an IDE Element of a type supported by this model.

Returns:

the locations corresponding to the element, or null or an empty array if none.

collectContainedElements

protected void collectContainedElements()

Collects the contained Elements of the root construct. Implementations must call ContainerModelAdapter.addContainedElement(oracle.ide.model.Element, java.net.URL) for each contained element. This method is invoked by the first invocation of ContainerModelAdapter.getContainedConstructs(java.lang.Object) or #getContainedUnauditableElements, unless {@link #addContainedModel} has already been invoked.

The Audit framework invokes this method with a read transaction active on this model.

Collects the Node and ContentDirectory elements corresponding to the files and directories directly contained by the adapted directory.

Specified by:

collectContainedElements in class ContainerModelAdapter

compareTo

public int compareTo(ModelAdapter that)

Description copied from class: ModelAdapter

Gets whether this model is less than, equal to, or greater than another using the natural order defined by this class. Model adapters created by different ModelFactory instances cannot be compared.

Specified by:

compareTo in interface java.lang.Comparable<ModelAdapter>

Specified by:

compareTo in class ModelAdapter

Parameters:

that - The model to which to compare this model.

Returns:

a negative integer, zero, or a positive integer as this model is less than, equal to, or greater than the other model.

contains

public boolean contains(ModelAdapter that)

Description copied from class: ModelAdapter

Gets whether this model contains a model.

Specified by:

contains in class ModelAdapter

Parameters:

that - The ModelAdapter to test.

contains

public boolean contains(java.lang.Object construct,
                        Location location)

Description copied from class: ModelAdapter

Gets whether a construct in this model contains a location. A construct does not contain an empty location at its boundary.

The default ModelAdapter location returns true if the construct is this or the location returned for the construct by ModelAdapter.getLocation(Object) contains the construct (getLocation(construct).contains(location).

Subclasses that can determine containment trivially for some constructs, or can extract offset and length directly from some constructs and so avoid the expense of creating a Location object should override this method, delegating to super for any constructs they can't optimize. To determine containment of the location by an offset and length, use ModelAdapter.contains(int, int, Location) to ensure correct results for containment of an empty location.

Overrides:

contains in class ModelAdapter

Parameters:

construct - The construct in this node to test.

location - The Location to test.

toString

public java.lang.String toString()

Overrides:

toString in class ModelAdapter

getNode

public Node getNode()

Description copied from class: ModelAdapter

Gets the IDE Node corresponding to this model, or null if none (in particular, if this is the root or a directory model).

Overrides:

getNode in class ModelAdapter

getLabel

public java.lang.Object getLabel(java.lang.Object construct)

Description copied from class: ModelAdapter

Gets the label for a construct of this model. A read transaction must be active on this model.

Note that the return type is Object, and Audit waits until the String is needed to invoke String.valueOf(Object) to get a string. Typically, implementations of this method do return a string, but the return type allows returning an object which defers expensive formatting to its toString() method. If necessary, the string should be localized.

Specified by:

getLabel in class ModelAdapter

getSummary

public java.lang.Object getSummary(java.lang.Object construct)

Description copied from class: ModelAdapter

Gets the summary for a construct of this model. The summary will be used, for example, as the tool tip text if the construct appears as a row in an Audit report. A read transaction must be active on this model.

Note that the return type is Object, and Audit waits until the String is needed to invoke String.valueOf(Object) to get a string. Typically, implementations of this method do return a string, but the return type allows returning an object which defers expensive formatting to its toString() method. The string should be localized.

Specified by:

getSummary in class ModelAdapter

getIcon

public javax.swing.Icon getIcon(java.lang.Object construct)

Description copied from class: ModelAdapter

Gets the icon for a construct of this model. A read transaction must be a active on this model. If necessary, the icon should be localized.

Specified by:

getIcon in class ModelAdapter