oracle.jdevimpl.audit.model

Class UnauditableFileModelAdapter

java.lang.Object

oracle.jdeveloper.audit.model.ModelAdapter

oracle.jdeveloper.audit.model.FileModelAdapter

oracle.jdevimpl.audit.model.UnauditableFileModelAdapter

All Implemented Interfaces:

java.lang.Comparable<ModelAdapter>, Located

public class UnauditableFileModelAdapter
extends FileModelAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnauditableFileModelAdapter.UnauditableElement

Field Summary

Fields

Modifier and Type	Field and Description
UnauditableFileModelAdapter.UnauditableElement	root

Constructor Summary

Constructors

Constructor and Description
UnauditableFileModelAdapter(ModelFactory factory, ModelType model, ContainerModelAdapter workspace, ContainerModelAdapter project, ContainerModelAdapter directory, Node node, java.net.URL url)

Method Summary

Modifier and Type	Method and Description
java.util.Iterator	getContainedConstructs(java.lang.Object construct) Gets the constructs contained by a construct in this model.
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.
Location	getLocation(java.lang.Object construct) Gets the location for a construct in this model, or null if the object is not a construct in this model.
java.lang.Object	getRootHook() A subclass hook invoked by ModelAdapter.getRoot() to get the root construct of this model.
java.lang.Object	getSummary(java.lang.Object construct) Gets the summary for a construct of this model.

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

compareTo, contains, getContainingAdapter, getDependency, getFileAdapter, getRelativePath, getUrl, isFile

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

acquireReadLock, acquireReadLock, acquireReadLock, beginRead, beginRead, beginReadHook, cancelRead, compareSiblings, contains, contains, contains, contextDescription, createModelAccessError, createModelAccessError, createModelAccessError, edit, endRead, endRead, endReadHook, enter, equals, exit, getAttribute, getCharacter, getColumnOffset, getConstruct, getConstruct, getDirectory, getDirectoryAdapter, getElement, getEndLocation, getFactory, getFocusLocation, getFocusLocation, getIcon, getIdeContext, getInitialLength, getLabel, getLine, getLineOffset, getLocation, getLocation, getLock, getNavigationPoint, getNode, 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, toString, verifyModelAccess, verifyReadTransaction

Methods inherited from class java.lang.Object

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

Field Detail

root

public UnauditableFileModelAdapter.UnauditableElement root

Constructor Detail

UnauditableFileModelAdapter

public UnauditableFileModelAdapter(ModelFactory factory,
                                   ModelType model,
                                   ContainerModelAdapter workspace,
                                   ContainerModelAdapter project,
                                   ContainerModelAdapter directory,
                                   Node node,
                                   java.net.URL url)

Method Detail

getContainedConstructs

public java.util.Iterator getContainedConstructs(java.lang.Object construct)

Description copied from class: ModelAdapter

Gets the constructs contained by a construct in this model. A read transaction must be active on this model.

Implementations must return an iterator which iterates the constructs in document order.

Specified by:

getContainedConstructs in class ModelAdapter

Parameters:

construct - A construct of this model, created by either ModelAdapter.getRoot() or ModelAdapter.getContainedConstructs(java.lang.Object)

Returns:

An iterator over the constructs contained by the construct.

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.

Specified by:

getElementLocations in class ModelAdapter

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.

getLocation

public Location getLocation(java.lang.Object construct)

Description copied from class: ModelAdapter

Gets the location for a construct in this model, or null if the object is not a construct in this model. A read transaction must be active on this model.

If the construct is the root construct, implementations must return ModelAdapter.getLocation(); otherwise implementations must extract offset and length from the construct to create a Location (typically with ModelAdapter.getLocation(int, int)).

Specified by:

getLocation in class ModelAdapter

Parameters:

construct - a construct in this model, created by either ModelAdapter.getRoot() or ModelAdapter.getContainedConstructs(java.lang.Object).

getRootHook

public java.lang.Object getRootHook()

Description copied from class: ModelAdapter

A subclass hook invoked by ModelAdapter.getRoot() to get the root construct of this model. A read transaction must be active on this model.

If an implementation cannot access its content and can provide a useful description of the cause, it should throw ModelAccessError with that localized description. Otherwise, it should return null, and ModelAdapter.getRoot() will probe the file and construct and throw the exception based on its findings.

Specified by:

getRootHook 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