AuditModel (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

All Superinterfaces:

AuditListener, java.util.EventListener

All Known Implementing Classes:

AbstractAuditModel, DefaultAuditModel
```
public interface AuditModel
extends AuditListener
```
A model of the results of an audit. It collects the displayable constructs, violations, attribute values (measurements), exception approvals, and statistics produced by an Auditor as it audits. This model is usable while the audit is in progress, as well as after it completes. It is presented as a tree table of opaque Objects, where the objects correspond to audited constructs and violations, and have attributes and approvals.
The model supports filtering and sorting. Clients of this interface see the filtered, sorted view; in particular, through the following tree structure methods:

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class AuditModel.Count
The count attributes maintained for each row of the model.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`AuditModel.Count` The count attributes maintained for each row of the model.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAuditModelListener(AuditModelListener listener)` Adds an audit model listener to this model.
`void`	`addFilter(AuditModelFilter filter)` Adds a filter to this model.
`void`	`clear()` Clears all rows from the model.
`<T extends AuditModelFilter> T`	`findFilter(java.lang.Class<T> type)` Finds a filter of this model of a specified type.
`java.util.Comparator<java.lang.Object>`	`getChildComparator()` Gets the comparator used to sort the children of row of this model.
`int`	`getChildCount(java.lang.Object row)` Gets the number of children of a row of this model.
`java.util.List<?>`	`getChildren(java.lang.Object row)` Gets the children of a row of this model.
`Metric`	`getColumn(int index)` Gets the column at an index.
`int`	`getColumnCount()` Gets the number of columns in this model.
`int`	`getColumnIndex(Metric column)` Gets the index of a column.
`int`	`getCount(java.lang.Object row, AuditModel.Count count)` Gets the value of a `count` of a row of this model.
`Displayable`	`getDisplayable(java.lang.Object row)` Gets a `Displayable` describing a row of this model.
`Location`	`getFocusLocation(java.lang.Object row)` Gets the focus `Location` of an object represented by a row in this model.
`int`	`getIndexOf(java.lang.Object row)` Gets the index of a row of this model in the children of its parent, 0 for the root row.
`Location`	`getLocation(java.lang.Object row)` Gets the `Location` of an object represented by a row of this model.
`java.util.List<Location>`	`getLocations()` Gets the locations audited to create this model.
`java.lang.Object`	`getParent(java.lang.Object row)` Gets the parent row of a row of this model, null for the root row.
`Profile`	`getProfile()` Gets the profile used to create this model.
`java.lang.Object`	`getRoot()` Gets the root row of this model, null if none.
`Severity`	`getSeverity(java.lang.Object row)` Gets the worst severity of the issues contained by a row of this model, or null if none.
`int`	`getSortColumn()` Gets the selected primary sort column.
`int`	`getSortDirection()` Gets the sort direction of the primary sort column, 1 for ascending, -1 for descending.
`java.util.List<Transform>`	`getTransformsApplied(Violation violation)` Gets the transforms applied to a violation of this model, in application order.
`java.lang.Class<?>`	`getType(java.lang.Object row)` Gets the type of an object of this model.
`java.lang.Object`	`getValue(java.lang.Object row, int columnIndex)` Gets the value of a column of a row of this model.
`Violation`	`getViolation(java.lang.Object row)` Gets the violation represented by a row of this model, or null if the row does not represent a violation.
`int`	`getVisibleChildCount(java.lang.Object row)` Gets the number of visible children of a row of this model.
`java.util.List<?>`	`getVisibleChildren(java.lang.Object row)` Gets the visible children of a row of this model.
`int`	`getVisibleIndexOf(java.lang.Object row)` Gets the index of a row of this model in the visible children of its visible parent, 0 for the root row.
`java.lang.Object`	`getVisibleParent(java.lang.Object row)` Gets the visible parent row of a row of this model, null for the root row.
`boolean`	`hasChildren(java.lang.Object row)` Gets whether a row of this model has children.
`boolean`	`hasVisibleChildren(java.lang.Object row)` Gets whether a row of this model has visible children.
`boolean`	`isLeaf(java.lang.Object row)` Gets whether a row of this model ,i>can have children.
`boolean`	`isOutOfBand(java.lang.Object row)` Gets whether the value of any column of a row of this model is out-of-band.
`boolean`	`isOutOfBand(java.lang.Object row, int columnIndex)` Gets whether the value of a column of a row of this model is out-of-band.
`boolean`	`isViolation(java.lang.Object row)` Gets whether the object represented by a row of this model is a violation.
`boolean`	`isVisible(java.lang.Object row)` Gets whether a row of this model is visible.
`java.lang.Object`	`iterateChildren(java.lang.Object row, Iteration iteration)` Iterates the children of a row of this model.
`Violation`	`iterateViolations(java.lang.Object row, Iteration iteration)` Iterates the violations contained by a row of this model.
`void`	`removeAuditModelListener(AuditModelListener listener)` Removes an audit model listener from this model.
`void`	`removeFilter(AuditModelFilter filter)` Removes a filter from this model.
`void`	`setSortColumn(int column)` Sets the primary sort column for children of a row of this model, or null to sort by `getLocation(java.lang.Object)`.
`void`	`setTransformDone(Transform transform, Violation violation)` Sets a transform done for a violation of this model.
`void`	`setTransformUndone(Transform transform, Violation violation)` Sets a transform undone for a violation of this model.
`void`	`setValue(java.lang.Object row, int columnIndex, java.lang.Object value)` Sets the value of an column of a row of this model.

Methods inherited from interface oracle.jdeveloper.audit.service.AuditListener
auditorCleared, auditStarted, auditStopped, issueReported, locationEntered, locationExited, modelEntered, modelExited, phaseStarted, valueReported

- Method Detail
  - addAuditModelListener
```
void addAuditModelListener(AuditModelListener listener)
```
    Adds an audit model listener to this model.
  - removeAuditModelListener
```
void removeAuditModelListener(AuditModelListener listener)
```
    Removes an audit model listener from this model.
  - getProfile
```
Profile getProfile()
```
    Gets the profile used to create this model.
  - getLocations
```
java.util.List<Location> getLocations()
```
    Gets the locations audited to create this model.
  - getColumnCount
```
int getColumnCount()
```
    Gets the number of columns in this model.
  - getColumn
```
Metric getColumn(int index)
```
    Gets the column at an index.
  - getColumnIndex
```
int getColumnIndex(Metric column)
```
    Gets the index of a column.
  - setSortColumn
```
void setSortColumn(int column)
```
    Sets the primary sort column for children of a row of this model, or null to sort by getLocation(java.lang.Object). If the specified column is already the primary sort column, toggles the sort direction.
  - getSortColumn
```
int getSortColumn()
```
    Gets the selected primary sort column. If null, natural row order
  - getSortDirection
```
int getSortDirection()
```
    Gets the sort direction of the primary sort column, 1 for ascending, -1 for descending.
  - clear
```
void clear()
```
    Clears all rows from the model.
  - getRoot
```
java.lang.Object getRoot()
```
    Gets the root row of this model, null if none.
  - getParent
```
java.lang.Object getParent(java.lang.Object row)
```
    Gets the parent row of a row of this model, null for the root row.
  - getIndexOf
```
int getIndexOf(java.lang.Object row)
```
    Gets the index of a row of this model in the children of its parent, 0 for the root row.
  - isLeaf
```
boolean isLeaf(java.lang.Object row)
```
    Gets whether a row of this model ,i>can have children.
  - hasChildren
```
boolean hasChildren(java.lang.Object row)
```
    Gets whether a row of this model has children.
  - getChildCount
```
int getChildCount(java.lang.Object row)
```
    Gets the number of children of a row of this model.
  - getChildren
```
java.util.List<?> getChildren(java.lang.Object row)
```
    Gets the children of a row of this model.
  - getChildComparator
```
java.util.Comparator<java.lang.Object> getChildComparator()
```
    Gets the comparator used to sort the children of row of this model.
    The order reflects invocations of setSortColumn(int).
  - isVisible
```
boolean isVisible(java.lang.Object row)
```
    Gets whether a row of this model is visible.
  - addFilter
```
void addFilter(AuditModelFilter filter)
```
    Adds a filter to this model.
    The model hides any row for which any filter of the model returns false from AuditModelFilter.isVisible(java.lang.Object).
  - removeFilter
```
void removeFilter(AuditModelFilter filter)
```
    Removes a filter from this model.
  - findFilter
```
<T extends AuditModelFilter> T findFilter(java.lang.Class<T> type)
```
    Finds a filter of this model of a specified type.
  - getVisibleParent
```
java.lang.Object getVisibleParent(java.lang.Object row)
```
    Gets the visible parent row of a row of this model, null for the root row.
  - getVisibleIndexOf
```
int getVisibleIndexOf(java.lang.Object row)
```
    Gets the index of a row of this model in the visible children of its visible parent, 0 for the root row.
  - hasVisibleChildren
```
boolean hasVisibleChildren(java.lang.Object row)
```
    Gets whether a row of this model has visible children.
  - getVisibleChildCount
```
int getVisibleChildCount(java.lang.Object row)
```
    Gets the number of visible children of a row of this model.
  - getVisibleChildren
```
java.util.List<?> getVisibleChildren(java.lang.Object row)
```
    Gets the visible children of a row of this model.
  - iterateChildren
```
java.lang.Object iterateChildren(java.lang.Object row,
                               Iteration iteration)
```
    Iterates the children of a row of this model.
    
    Returns:
    null if the iteration completed normally, or the last object processed if the iteration was aborted.
  - iterateViolations
```
Violation iterateViolations(java.lang.Object row,
                          Iteration iteration)
```
    Iterates the violations contained by a row of this model.
    
    Returns:
    null if the iteration completed normally, or the last object processed if the iteration was aborted.
  - getType
```
java.lang.Class<?> getType(java.lang.Object row)
```
    Gets the type of an object of this model. If the object represented by the row is a construct, the type is one of the types returned by:
```
     getLocation(row).getModel().getType().getPresentationTypes()
 
```
    If the object is a violation, the type is Violation.
    See Also:
    ModelType.getPresentationTypes()
  - getLocation
```
Location getLocation(java.lang.Object row)
```
    Gets the Location of an object represented by a row of this model.
  - getFocusLocation
```
Location getFocusLocation(java.lang.Object row)
```
    Gets the focus Location of an object represented by a row in this model.
  - getValue
```
java.lang.Object getValue(java.lang.Object row,
                        int columnIndex)
```
    Gets the value of a column of a row of this model.
  - setValue
```
void setValue(java.lang.Object row,
            int columnIndex,
            java.lang.Object value)
```
    Sets the value of an column of a row of this model.
  - isOutOfBand
```
boolean isOutOfBand(java.lang.Object row,
                  int columnIndex)
```
    Gets whether the value of a column of a row of this model is out-of-band.
  - isOutOfBand
```
boolean isOutOfBand(java.lang.Object row)
```
    Gets whether the value of any column of a row of this model is out-of-band.
  - isViolation
```
boolean isViolation(java.lang.Object row)
```
    Gets whether the object represented by a row of this model is a violation.
  - getViolation
```
Violation getViolation(java.lang.Object row)
```
    Gets the violation represented by a row of this model, or null if the row does not represent a violation.
  - getSeverity
```
Severity getSeverity(java.lang.Object row)
```
    Gets the worst severity of the issues contained by a row of this model, or null if none.
  - getCount
```
int getCount(java.lang.Object row,
           AuditModel.Count count)
```
    Gets the value of a count of a row of this model.
  - getDisplayable
```
Displayable getDisplayable(java.lang.Object row)
```
    Gets a Displayable describing a row of this model.
  - getTransformsApplied
```
java.util.List<Transform> getTransformsApplied(Violation violation)
```
    Gets the transforms applied to a violation of this model, in application order. Transforms done and then undone are not included.
  - setTransformDone
```
void setTransformDone(Transform transform,
                    Violation violation)
```
    Sets a transform done for a violation of this model.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the transform is not returned by Violation.getTransform(int) for some index.
  - setTransformUndone
```
void setTransformUndone(Transform transform,
                      Violation violation)
```
    Sets a transform undone for a violation of this model.
    
    Throws:
    
    java.lang.IllegalStateException - if the transform is not the last transform set done by setTransformDone(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation) for this violation.

Interface AuditModel

Nested Class Summary

Method Summary

Methods inherited from interface oracle.jdeveloper.audit.service.AuditListener

Method Detail

addAuditModelListener

removeAuditModelListener

getProfile

getLocations

getColumnCount

getColumn

getColumnIndex

setSortColumn

getSortColumn

getSortDirection

clear

getRoot

getParent

getIndexOf

isLeaf

hasChildren

getChildCount

getChildren

getChildComparator

isVisible

addFilter

removeFilter

findFilter

getVisibleParent

getVisibleIndexOf

hasVisibleChildren

getVisibleChildCount

getVisibleChildren

iterateChildren

iterateViolations

getType

getLocation

getFocusLocation

getValue

setValue

isOutOfBand

isOutOfBand

isViolation

getViolation

getSeverity

getCount

getDisplayable

getTransformsApplied

setTransformDone

setTransformUndone