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, Located

public class UnauditableFileModelAdapter
extends FileModelAdapter

Field Summary

oracle.jdevimpl.audit.model.UnauditableFileModelAdapter.UnauditableElement

root

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

index, log

Constructor Summary

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

Method Summary

void	enter(AuditContext context) Invoked as an auditor traversal enters this model.
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.
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	getRoot() Gets the root construct of this model.
javax.swing.Icon	icon(java.lang.Object construct) Gets the icon for a construct of this model.
java.lang.Object	label(java.lang.Object construct) Gets the label for a construct of this model.
java.lang.Object	summary(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, getUrl, isFile

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

acquireReadLock, beginRead, beginRead, beginReadHook, cancelRead, compareSiblings, contains, contains, contextDescription, edit, endRead, endRead, endReadHook, equals, exit, getAttribute, getCharacter, getColumnOffset, getConstruct, getConstruct, getDirectory, getDirectoryAdapter, getElement, getEndLocation, getFactory, getFocusLocation, getFocusLocation, getIdeContext, getInitialLength, getLine, getLineOffset, getLocation, getLocation, getLock, getNode, getPrimaryCollationKey, getProject, getProjectAdapter, getSecondaryCollationKey, getSecondaryCollationString, getShortLabel, getText, getType, getURL, getWorkspace, getWorkspaceAdapter, icon, isEditable, isModifiable, isModified, isModified, label, release, releaseReadLock, setAttribute, summary, toString, verifyReadTransaction

Methods inherited from class java.lang.Object

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

Field Detail

root

public oracle.jdevimpl.audit.model.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 transacton 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.

Implementations must extract offset and length from the construct to create a Location.

Specified by:

getLocation in class ModelAdapter

Parameters:

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

getRoot

public java.lang.Object getRoot()

Description copied from class: ModelAdapter

Gets the root construct of this model. A read transaction must be active on this model.

Specified by:

getRoot in class ModelAdapter

label

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

Description copied from class: ModelAdapter

Gets the label for a construct of this model. Note that the return type is Object, and Audit uses String.valueOf(Object) to get a string. Typically, implementations of this method will return a string, but the return type allows an implementation to return an object which defers expensive formatting to its toString() method. If necessary, the label should be localized.

Specified by:

label in class ModelAdapter

summary

public java.lang.Object summary(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. Note that the return type is Object, and Audit uses String.valueOf(Object) to get a string. Typically, implementations of this method will return a string, but the return type allows an implementation to return an object which defers expensive formatting to its toString() method. The summary should be localized.

Specified by:

summary in class ModelAdapter

icon

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

Description copied from class: ModelAdapter

Gets the icon for a construct of this model. If necessary, the icon should be localized.

Specified by:

icon in class ModelAdapter

enter

public void enter(AuditContext context)

Description copied from class: ModelAdapter

Invoked as an auditor traversal enters this model. The auditor invokes this method after acquiring the read lock and getting the root construct and before invoking any analyzer enter methods for the root construct.

Overrides:

enter in class ModelAdapter

Parameters:

context - The audit context for the root construct of this model.