oracle.jdeveloper.audit.model

Class TextFileModelAdapter

java.lang.Object

oracle.jdeveloper.audit.model.ModelAdapter

oracle.jdeveloper.audit.model.FileModelAdapter

oracle.jdeveloper.audit.model.TextFileModelAdapter

All Implemented Interfaces:

java.lang.Comparable<ModelAdapter>, Located

public abstract class TextFileModelAdapter
extends FileModelAdapter

An abstract ModelAdapter adapter which adapts a text file node.

When the node is open, this adapter tracks changes to the text buffer associated with the node and maps offsets across edits to the node. When the node is opened, this adapter attaches an observer to the text buffer.

See Also:

ModelAdapter

Constructor Summary

Constructors

Constructor and Description
TextFileModelAdapter(ModelFactory factory, ModelType type, ContainerModelAdapter workspace, ContainerModelAdapter project, ContainerModelAdapter directory, Node node, java.net.URL url)
TextFileModelAdapter(ModelFactory factory, ModelType type, ContainerModelAdapter workspace, ContainerModelAdapter project, ContainerModelAdapter directory, Node node, java.net.URL url, java.lang.String primaryCollationString)

Method Summary

Modifier and Type	Method and Description
protected void	acquireReadLock(WriteLockRequestListener listener) Acquires a read lock for this model.
protected void	beginReadHook() A subclass hook invoked by ModelAdapter.beginRead() after it invokes ModelAdapter.acquireReadLock(oracle.jdeveloper.audit.model.LockPolicy).
java.lang.String	contextDescription(Location location) Gets a description of a location of this model.
protected void	endReadHook() A subclass hook invoked by ModelAdapter.endRead() before it invokes ModelAdapter.releaseReadLock(oracle.jdeveloper.audit.model.LockPolicy).
char	getCharacter(int offset) Gets a character from this model, or 0 if no text is available.
int	getColumnOffset(int offset) Gets the zero-based column offset of a character offset in this model, or the character offset if this model does not have lines and columns.
protected int	getDeltaLength(int offset, int length, int version)
protected int	getDeltaOffset(int offset, int version)
Location	getFocusLocation(Location location) Gets the focus location for a location in this model.
int	getInitialLength() Gets the initial length of this model.
java.lang.String	getLine(int offset) Gets a line of text from this model, or null if no text is available.
int	getLineOffset(int offset) Gets the zero-based line offset of a character offset in this model, or 0 if this model does not have lines and columns.
Location	getLocation(int offset, int length) Gets a location in this model.
oracle.ide.navigation.NavigationPoint	getNavigationPoint(Location location) Gets a NavigationPoint to navigate to a location in this model, or null if the location is not navigable.
java.lang.Object	getRootHook() A subclass hook invoked by ModelAdapter.getRoot() to get the root construct of this model.
java.lang.Object	getRootImplementation() Deprecated. Override getRootHook() instead.
java.lang.String	getText(int offset, int length) Gets text from this model, or null if the model is not a text model.
TextBuffer	getTextBuffer() Gets the text buffer for this model.
TextNode	getTextNode() Gets the IDE {@link TextNode) containing this model.
boolean	isModifiable() Gets whether this model is modifiable.
boolean	isModified() Gets whether the model has been modified since this representation of it was created.
boolean	isModified(Location location) Gets whether a region of this model has been modified since this model adapter was created.
boolean	isNavigable(Location location) Gets whether a location in this model is navigable.
void	release() Releases resources used by this model.
protected void	releaseReadLock(WriteLockRequestListener listener) Releases a read lock for this model.
void	verifyReadTransaction() Verifies that a read transaction is in progress for 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, beginRead, beginRead, cancelRead, compareSiblings, contains, contains, contains, createModelAccessError, createModelAccessError, createModelAccessError, edit, endRead, endRead, enter, equals, exit, getAttribute, getConstruct, getConstruct, getContainedConstructs, getDirectory, getDirectoryAdapter, getElement, getElementLocations, getEndLocation, getFactory, getFocusLocation, getIcon, getIcon, getIdeContext, getLabel, getLabel, getLocation, getLocation, getLock, getNode, getPrimaryCollationKey, getProject, getProjectAdapter, getRoot, getSecondaryCollationKey, getSecondaryCollationString, getShortLabel, getSimpleName, getSummary, getSummary, getType, getURL, getUrl, getWorkspace, getWorkspaceAdapter, hashCode, isAccessible, isReadLockHeld, isWriteLockHeld, releaseReadLock, setAttribute, toString, verifyModelAccess

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFileModelAdapter

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

TextFileModelAdapter

public TextFileModelAdapter(ModelFactory factory,
                            ModelType type,
                            ContainerModelAdapter workspace,
                            ContainerModelAdapter project,
                            ContainerModelAdapter directory,
                            Node node,
                            java.net.URL url,
                            java.lang.String primaryCollationString)

Method Detail

getTextNode

public TextNode getTextNode()

Gets the IDE {@link TextNode) containing this model.

isModifiable

public boolean isModifiable()

Description copied from class: ModelAdapter

Gets whether this model is modifiable. The default ModelAdapter implementation returns false.

Overrides:

isModifiable in class ModelAdapter

isModified

public boolean isModified()

Description copied from class: ModelAdapter

Gets whether the model has been modified since this representation of it was created. Note that this indicates nothing about whether this model is modified relative to its representation on disk. The default ModelAdapter implementation returns false.

Overrides:

isModified in class ModelAdapter

isModified

public boolean isModified(Location location)

Description copied from class: ModelAdapter

Gets whether a region of this model has been modified since this model adapter was created. Note that this indicates nothing about whether this region is modified relative to its representation on disk.

Overrides:

isModified in class ModelAdapter

getInitialLength

public int getInitialLength()

Description copied from class: ModelAdapter

Gets the initial length of this model. Gets Integer.MAX_VALUE if this node has not been opened. The default ModelAdapter implementation returns Integer.MAX_VALUE.

Overrides:

getInitialLength in class ModelAdapter

getLocation

public Location getLocation(int offset,
                            int length)

Description copied from class: ModelAdapter

Gets a location in this model.

Overrides:

getLocation in class ModelAdapter

getDeltaLength

protected int getDeltaLength(int offset,
                             int length,
                             int version)

getDeltaOffset

protected int getDeltaOffset(int offset,
                             int version)

acquireReadLock

protected void acquireReadLock(WriteLockRequestListener listener)
                        throws java.lang.InterruptedException

Acquires a read lock for this model. Invoked by ModelAdapter.beginRead() with no read transaction for this model active on the current thread. The default ModelAdapter implementation does nothing.

The default TextFileModelAdapter implementation is the following:

     ReadWriteLock lock = getLock();
     lock.readLock();
     if (listener != null && lock.addWriteLockRequestListener(listener))
     {
       lock.removeWriteLockRequestListener(listener);
       lock.readUnlock();
       throw new InterruptedException("self-cancellation: write lock request pending");
     }
 

.

Overrides:

acquireReadLock in class ModelAdapter

Parameters:

listener - The listener to notify if a thread requests the write lock, or null.

Throws:

java.lang.InterruptedException - if the current thread is in or gets put in the interrupted state, or if listener is not null and other threads are already waiting for a write lock. The interrupted state is cleared when this exception is thrown.

verifyReadTransaction

public void verifyReadTransaction()

Description copied from class: ModelAdapter

Verifies that a read transaction is in progress for this model. The default ModelAdapter implementation does nothing.

Overrides:

verifyReadTransaction in class ModelAdapter

releaseReadLock

protected void releaseReadLock(WriteLockRequestListener listener)

Releases a read lock for this model. Invoked by ModelAdapter.endRead() with a read transaction for this model active on the current thread. The default TextFileModelAdapter implementation is the following:

     ReadWriteLock lock = getLock();
     if (listener != null) lock.removeWriteLockRequestListener(listener);
     lock.readUnlock();
 

.

Overrides:

releaseReadLock in class ModelAdapter

Parameters:

listener - The value given to the matching acquireReadLock(oracle.javatools.buffer.WriteLockRequestListener).

beginReadHook

protected void beginReadHook()
                      throws java.lang.InterruptedException

A subclass hook invoked by ModelAdapter.beginRead() after it invokes ModelAdapter.acquireReadLock(oracle.jdeveloper.audit.model.LockPolicy). The default ModelAdapter implementation does nothing.

The TextFileModelAdapter implementation pins the text buffer for use during the read transaction. Subclasses should not invoke this method from inside a synchronized block, on peril of deadlock!

Overrides:

beginReadHook in class ModelAdapter

Throws:

java.lang.InterruptedException

See Also:

ModelAdapter.beginRead(), endReadHook()

endReadHook

protected void endReadHook()

A subclass hook invoked by ModelAdapter.endRead() before it invokes ModelAdapter.releaseReadLock(oracle.jdeveloper.audit.model.LockPolicy). The default ModelAdapter implementation does nothing. The TextFileModelAdapter implementation unpins the text buffer.

Overrides:

endReadHook in class ModelAdapter

See Also:

ModelAdapter.endRead(), beginReadHook()

getCharacter

public char getCharacter(int offset)

Description copied from class: ModelAdapter

Gets a character from this model, or 0 if no text is available. A read transaction must be active on this node. The ModelAdapter implementation returns 0.

Overrides:

getCharacter in class ModelAdapter

Parameters:

offset - The index of the character to return.

getColumnOffset

public int getColumnOffset(int offset)

Description copied from class: ModelAdapter

Gets the zero-based column offset of a character offset in this model, or the character offset if this model does not have lines and columns. A read transaction must be active on this model. The ModelAdapter implementation returns the character offset.

Overrides:

getColumnOffset in class ModelAdapter

getFocusLocation

public Location getFocusLocation(Location location)

Description copied from class: ModelAdapter

Gets the focus location for a location in this model. This is a region within the location which should be highlighted. The default ModelAdapter.getFocusLocation(java.lang.Object, oracle.jdeveloper.audit.model.Location) implementation gets the whole location. A read transaction must be active on this node.

Overrides:

getFocusLocation in class ModelAdapter

Parameters:

location - a location in this model.

getLine

public java.lang.String getLine(int offset)

Description copied from class: ModelAdapter

Gets a line of text from this model, or null if no text is available. A read transaction must be active on this node. The ModelAdapter implementation returns null.

Overrides:

getLine in class ModelAdapter

Parameters:

offset - The index of a character in the line to return.

getLineOffset

public int getLineOffset(int offset)

Description copied from class: ModelAdapter

Gets the zero-based line offset of a character offset in this model, or 0 if this model does not have lines and columns. A read transaction must be active on this node. The ModelAdapter implementation returns 0.

Overrides:

getLineOffset in class ModelAdapter

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

getRootImplementation

public java.lang.Object getRootImplementation()

Deprecated. Override getRootHook() instead.

getText

public java.lang.String getText(int offset,
                                int length)

Description copied from class: ModelAdapter

Gets text from this model, or null if the model is not a text model. A read transaction must be active on this node. The default ModelAdapter implementation returns null.

Overrides:

getText in class ModelAdapter

Parameters:

offset - The index of the first character to return.

length - The number of characters to return.

getTextBuffer

public TextBuffer getTextBuffer()

Gets the text buffer for this model.

A read transaction must be active for this model on the current thread.

isNavigable

public boolean isNavigable(Location location)

Gets whether a location in this model is navigable. The default ModelAdapter implementation returns true if ModelAdapter.getNavigationPoint(Location) returns a non-null value.

The default TextFileModelAdapter implementation returns true.

Overrides:

isNavigable in class ModelAdapter

getNavigationPoint

public oracle.ide.navigation.NavigationPoint getNavigationPoint(Location location)

Gets a NavigationPoint to navigate to a location in this model, or null if the location is not navigable. The default ModelAdapter implementation returns null.

The default TextFileModelAdapter implementation creates an OffsetNavigationPoint which will navigate to the code editor.

Overrides:

getNavigationPoint in class ModelAdapter

release

public void release()

Description copied from class: ModelAdapter

Releases resources used by this model.

Overrides:

release in class ModelAdapter

contextDescription

public java.lang.String contextDescription(Location location)

Gets a description of a location of this model.

The ModelAdapter implementation includes the file name and offsets of the location.

The TextFileModelAdapter implementation adds the line and column numbers and the text of the location.

Overrides:

contextDescription in class ModelAdapter