|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jdeveloper.audit.transform.TransformAdapter
public abstract class TransformAdapter
An adapter between the Audit framework and transforms of a specific type. It allows the framework to create a transform context and to invoke type-specific setup and teardown code (e.g., for a model which requires that a transaction be created).
Nested Class Summary | |
---|---|
class |
TransformAdapter.ConstructRegion
|
class |
TransformAdapter.LocationRegion
|
class |
TransformAdapter.Region
|
Constructor Summary | |
---|---|
TransformAdapter()
|
Method Summary | |
---|---|
void |
addHighlight(ModelAdapter model,
java.lang.Object construct)
Adds a highlight region for a construct in the model for this context. |
void |
addRemovedHighlight(ModelAdapter model,
java.lang.Object construct)
Adds a highlight region for an about-to-be-removed construct in the model for this context. |
abstract void |
beginTransform(TransformContext context)
Begins a transform of this type. |
void |
beginTransform(TransformContext context,
TransformSequenceContext sequenceContext)
The default implementation simply calls beginTransform with the current transform context. |
void |
beginTransformSequence(TransformSequenceContext sequenceContext)
Begins a transform sequence. |
abstract void |
cancelTransform(TransformContext context)
Cancels a transform of this type. |
void |
cancelTransformSequence(TransformSequenceContext sequenceContext)
Cancels a transform sequence of this type. |
abstract TransformContext |
createContext(Transform transform,
Violation violation,
Location location)
Creates a context for a transform over a violation. |
abstract void |
endTransform(TransformContext context)
Ends a transform of this type. |
void |
endTransformSequence(TransformSequenceContext sequenceContext)
Ends a transform sequence. |
abstract java.lang.Class |
getContextClass()
Gets the class of the context created by createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location) . |
java.util.List |
getDeferredCommands()
Gets the commands deferred by the apply method of a transform, or an empty list if none. |
java.util.Collection<Location> |
getHighlightRegions(TransformContext context)
Gets the highlight regions set by the apply method of a transform for its model, or an empty list if none. |
Location |
getSelection()
Gets the selection set by the apply method of a transform, or null if none. |
void |
invokeLater(Command command)
Invokes a command after the command currently being executed by the Audit framework completes. |
void |
setPredecessorApplyData(TransformContext context,
java.lang.Object applyData)
Sets the predecessor apply data for a transform. |
void |
setSelection(Location location,
int margin,
int endMargin)
Sets the selection to be set after a transform is applied. |
void |
setSelection(ModelAdapter model,
java.lang.Object construct,
int margin,
int endMargin)
Sets the selection to be set after a transform is applied. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TransformAdapter()
Method Detail |
---|
public abstract java.lang.Class getContextClass()
createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location)
.
public abstract TransformContext createContext(Transform transform, Violation violation, Location location)
public abstract void beginTransform(TransformContext context) throws java.lang.Exception
CommandProcessor.beginTrans(java.lang.String)
has been
invoked to start a command processor batch operation;
context
- A transform context created by this adapter.
java.lang.Exception
public abstract void endTransform(TransformContext context) throws java.lang.Exception
beginTransform(oracle.jdeveloper.audit.transform.TransformContext)
has been invoked (its preconditions still
hold);
context
- A transform context created by this adapter.
java.lang.Exception
public void beginTransform(TransformContext context, TransformSequenceContext sequenceContext) throws java.lang.InterruptedException, java.lang.Exception
context
- sequenceContext
-
java.lang.InterruptedException
java.lang.Exception
public abstract void cancelTransform(TransformContext context) throws java.lang.Exception
beginTransform(oracle.jdeveloper.audit.transform.TransformContext)
has been invoked (its preconditions still
hold);
endTransform(oracle.jdeveloper.audit.transform.TransformContext)
method has thrown an
exception.
context
- A transform context created by this type.
java.lang.Exception
public void setPredecessorApplyData(TransformContext context, java.lang.Object applyData)
context
- applyData
- public void beginTransformSequence(TransformSequenceContext sequenceContext)
CommandProcessor.beginTrans(java.lang.String)
has been
invoked to start a command processor batch operation;
sequenceContext
- A transform sequence context created by this adapter.public void endTransformSequence(TransformSequenceContext sequenceContext) throws java.lang.Exception
beginTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext)
has been invoked and its preconditions still
hold.
sequenceContext
- A transform sequence context created by this adapter.
java.lang.Exception
public void cancelTransformSequence(TransformSequenceContext sequenceContext) throws java.lang.Exception
beginTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext)
has been invoked (its preconditions still
hold);
endTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext)
method has thrown an
exception.
sequenceContext
- A transform sequence context created by this type.
java.lang.Exception
public void invokeLater(Command command)
public java.util.List getDeferredCommands()
endTransform(oracle.jdeveloper.audit.transform.TransformContext)
and invokes the commands returned in order.
List
of Command
s.public void setSelection(ModelAdapter model, java.lang.Object construct, int margin, int endMargin)
TransformContext.setSelection(java.lang.Object, int, int)
.
model
- The model containing the construct to select.construct
- The construct at which to place the caret.margin
- Margin from start of construct to start of selection.endMargin
- Margin from end of construct to end of selection.public void setSelection(Location location, int margin, int endMargin)
TransformContext.setSelection(java.lang.Object, int, int)
.
location
- The location to select.margin
- Margin from start of construct to start of selection.endMargin
- Margin from end of construct to end of selection.public Location getSelection()
endTransform(oracle.jdeveloper.audit.transform.TransformContext)
.
Location
of length 0.public void addHighlight(ModelAdapter model, java.lang.Object construct)
construct
- The construct to highlight.public void addRemovedHighlight(ModelAdapter model, java.lang.Object construct)
construct
- The construct to be removed.public java.util.Collection<Location> getHighlightRegions(TransformContext context)
endTransform(oracle.jdeveloper.audit.transform.TransformContext)
.
context
- A transform context created by this adapter.
Collection
of {#link Location}s.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |