oracle.jdeveloper.audit.analyzer

Interface ViolationReport

All Known Subinterfaces:

IssueReport

Deprecated.

Use IssueReport

public interface ViolationReport

An interface for setting additional properties of a reported Audit violation. The violation reporting methods in AuditContext only allow a client to specify the rule and location properties of a violation. To allow a client to specify additional properties--variation, parameters, transforms, recommended transforms, focus location, and related location--the AuditContext report methods return an instance of this interface to the client.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConstructParameter(java.lang.String name, ModelAdapter model, java.lang.Object construct) Deprecated. Adds a parameter to the issue, where the parameter is a construct in a specified model.
void	addConstructParameter(java.lang.String name, java.lang.Object construct) Deprecated. Adds a parameter to the issue, where the parameter is a construct in the model of the issue.
void	addParameter(java.lang.String name, java.lang.Object value) Deprecated. Adds a parameter to the issue.
void	hideAllTransforms() Deprecated. Hides all the tranforms for this violation.
void	hideTransform(Transform transform) Deprecated. Hides a transform for this violation.
void	setDefaultTransform(Transform transform) Deprecated. Sets the default transform for this violation.
void	setFocusLocation(Location location) Deprecated. Sets the focus location of the issue.
void	setFocusLocation(java.lang.Object construct) Deprecated. Sets the focus location of the issue to the location of a construct in the model of the issue.
void	setVariation(java.lang.String name) Deprecated. Sets the name of the rule variation which applies to this violation.
void	showTransform(Transform transform) Deprecated. Shows a transform for this violation.

Method Detail

addParameter

void addParameter(java.lang.String name,
                java.lang.Object value)

Deprecated.

Adds a parameter to the issue. Parameters are numbered in the order they are added, starting at 0. In the message string associated with the rule, a parameter can be referred to by index or by name.

Adding constructs directly as a parameter to an issue typically pins the entire model in memory so Audit uses Locations to track constructs over time. This method attempts to detect if the parameter is a construct in the model with the issue and substitutes a Location if so.

Parameters:

name - the name of the parameter

value - the value of the parameter

See Also:

addConstructParameter(java.lang.String, java.lang.Object)

addConstructParameter

void addConstructParameter(java.lang.String name,
                         java.lang.Object construct)

Deprecated.

Adds a parameter to the issue, where the parameter is a construct in the model of the issue. Adding constructs directly as a parameter to an issue typically pins the entire model in memory so Audit uses Locations to track constructs over time. This method is more or less a convenience method for:

   addParameter(name, context.getModel().getLocation(construct));
 

Parameters:

name - the name of the parameter.

construct - the construct that is the intended parameter value.

Throws:

java.lang.IllegalArgumentException - if the construct is not a construct in the model of the issue.

See Also:

addParameter(java.lang.String, java.lang.Object)

addConstructParameter

void addConstructParameter(java.lang.String name,
                         ModelAdapter model,
                         java.lang.Object construct)

Deprecated.

Adds a parameter to the issue, where the parameter is a construct in a specified model. Adding constructs directly as a parameter to an issue typically pins the entire model in memory so Audit uses Locations to track constructs over time. This method is more or less a convenience method for:

   model.beginRead(true);
   try
   {
     addParameter(name, model.getLocation(construct));
   }
   finally
   {
     model.endRead(true);
   }
 

It should be noted that the above implementation presents a deadlock hazard which the actual implementation avoids.

Parameters:

name - the name of the parameter.

model - the model containing the construct

construct - the construct that is the intended parameter value.

Throws:

java.lang.IllegalArgumentException - if the construct is not a construct in the model with the issue.

See Also:

addParameter(java.lang.String, java.lang.Object)

setFocusLocation

void setFocusLocation(java.lang.Object construct)

Deprecated.

Sets the focus location of the issue to the location of a construct in the model of the issue. Typically, the focus location is contained by the location of the issue and does not span a line boundary. If the focus location is null, the framework uses the location returned by ModelAdapter.getFocusLocation(java.lang.Object, oracle.jdeveloper.audit.model.Location) if not null, otherwise it uses the location of the issue.

setFocusLocation

void setFocusLocation(Location location)

Deprecated.

Sets the focus location of the issue. Typically, the focus location is contained by the location of the issue and does not span a line boundary. If the focus location is null, the framework uses the location returned by ModelAdapter.getFocusLocation(java.lang.Object, oracle.jdeveloper.audit.model.Location) if not null, otherwise it uses the location of the issue.

setVariation

void setVariation(java.lang.String name)

Deprecated.

Sets the name of the rule variation which applies to this violation. If not specified, the framework uses the default variation.

Parameters:

name - The name of the variation: one of the names returned by Rule.variations().

hideAllTransforms

void hideAllTransforms()

Deprecated.

Hides all the tranforms for this violation.

showTransform

void showTransform(Transform transform)

Deprecated.

Shows a transform for this violation.

hideTransform

void hideTransform(Transform transform)

Deprecated.

Hides a transform for this violation.

setDefaultTransform

void setDefaultTransform(Transform transform)

Deprecated.

Sets the default transform for this violation. This overrides the default fix set by the user and inherited from the rule, so the rule help should make clear that this will happen.