oracle.jdeveloper.audit.transform
Class TextTransformAdapter

java.lang.Object
  oracle.jdeveloper.audit.transform.TransformAdapter
      oracle.jdeveloper.audit.transform.TextTransformAdapter

public class TextTransformAdapter
extends TransformAdapter

An adapter between the Audit framework and transforms which modify text buffers directly.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jdeveloper.audit.transform.TransformAdapter

TransformAdapter.ConstructRegion, TransformAdapter.LocationRegion, TransformAdapter.Region

Constructor Summary

TextTransformAdapter()

Method Summary

void	beginTransform(TransformContext context) Begins a transform of this type.
void	cancelTransform(TransformContext context) Cancels a transform of this type.
TransformContext	createContext(Transform transform, Violation violation, Location location) Creates a context for a transform over a violation.
protected UndoableEditCommand	createUndoableEditCommand(TextTransformContext context)
void	endTransform(TransformContext context) Ends a transform of this type.
protected TextBuffer	getBuffer()
java.lang.Class	getContextClass() Gets the class of the context created by TransformAdapter.createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location).

Methods inherited from class oracle.jdeveloper.audit.transform.TransformAdapter

addHighlight, addRemovedHighlight, beginTransform, beginTransformSequence, cancelTransformSequence, endTransformSequence, getDeferredCommands, getHighlightRegions, getSelection, invokeLater, setPredecessorApplyData, setSelection, setSelection

Methods inherited from class java.lang.Object

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

Constructor Detail

TextTransformAdapter

public TextTransformAdapter()

Method Detail

getContextClass

public java.lang.Class getContextClass()

Description copied from class: TransformAdapter

Gets the class of the context created by TransformAdapter.createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location).

Specified by:

getContextClass in class TransformAdapter

createContext

public TransformContext createContext(Transform transform,
                                      Violation violation,
                                      Location location)

Description copied from class: TransformAdapter

Creates a context for a transform over a violation.

Specified by:

createContext in class TransformAdapter

beginTransform

public void beginTransform(TransformContext context)

Begins a transform of this type. The framework ensures the following before invoking this method:

• CommandProcessor.beginTrans(java.lang.String) has been invoked to start a command processor batch operation;
• the calling thread holds a read lock on the model containing the transform location;
• the transform class has an apply method that matches the construct at the violation location;
• if the transform class has an isApplicable method that matches the construct at the violation location, it has been invoked and has returned true;
• if the transform class has a query method that matches the construct at the violation location, it has been invoked and has returned non-null data.

  The TextTransformAdapter implementation of this method acquires and write locks the text buffer containing the text to transform.

  Specified by:

  beginTransform in class TransformAdapter

  Parameters:

  context -

createUndoableEditCommand

protected UndoableEditCommand createUndoableEditCommand(TextTransformContext context)

getBuffer

protected TextBuffer getBuffer()

endTransform

public void endTransform(TransformContext context)
                  throws java.lang.Exception

Ends a transform of this type. The framework ensures the following before invoking this method:

• TransformAdapter.beginTransform(oracle.jdeveloper.audit.transform.TransformContext) has been invoked (its preconditions still hold);
• the apply method that matches this construct has been invoked and has returned normally.

  The TextTransformAdapter implementation of this method creates an UndoableEditCommand for the edits, invokes it, and unlocks and releases the text buffer.

  Specified by:

  endTransform in class TransformAdapter

  Parameters:

  context - A transform context created by this adapter.

  Throws:

  java.lang.Exception

cancelTransform

public void cancelTransform(TransformContext context)
                     throws java.lang.Exception

Cancels a transform of this type. The framework ensures the following before invoking this method:

• TransformAdapter.beginTransform(oracle.jdeveloper.audit.transform.TransformContext) has been invoked (its preconditions still hold);
• the apply method that matches this construct has been invoked;
• the apply method has thrown an exception or the apply method has completed normally and the TransformAdapter.endTransform(oracle.jdeveloper.audit.transform.TransformContext) method has thrown an exception.

  The TextTransformAdapter implementation of this method unlocks and releases the text buffer.

  Specified by:

  cancelTransform in class TransformAdapter

  Parameters:

  context - A transform context created by this type.

  Throws:

  java.lang.Exception