oracle.jdeveloper.audit.service
Interface AuditModel

public interface AuditModel

A model of the results of an audit. It collects the displayable constructs, violations, attribute values (measurements), exception approvals, and some miscellaneous 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 of opaque Objects, where the objects correspond to audited constructs and to violations and have attributes and approvals.

Method Summary

void	addAuditModelListener(AuditModelListener listener) Adds an audit model listener to this model.
void	clear() Clears this model.
boolean	containsChildren(java.lang.Object object) Gets whether an object has children.
boolean	containsDefaultTransforms(java.lang.Object object) Gets whether an object contains exceptions or violations.
boolean	containsExceptionsOrViolations(java.lang.Object object) Gets whether an object contains exceptions or violations.
java.util.List	getChildren(java.lang.Object object) Gets the children of an object.
Attribute	getColumn(int index) Gets the column at an index.
int	getColumnCount() Gets the number of columns in this model.
Displayable	getDisplayable(java.lang.Object object) Gets a Displayable describing an object.
int	getDocumentCount() Gets the number of visible documents (excluding root, workspace, project, and package pseudo-documents) in this model.
int	getDocumentTotal() Gets the total number of documents (excluding root, workspace, project and package pseudo-documents) in this model.
int	getExceptionCount() Gets the number of visible exceptions in this model.
int	getExceptionTotal() Gets the total number of exceptions in this model.
AuditModelFilter	getFilter() Gets the filter for this model.
int	getIndex(Attribute column) Gets the index of a column.
Location	getLocation(java.lang.Object object) Gets the Location of an object in this model.
Location[]	getLocations() Gets the locations audited to create this model.
java.lang.Object	getParent(java.lang.Object object) Gets the parent object of an object, or null if the object is the root.
Profile	getProfile() Gets the profile used to create this model.
java.lang.Object	getRoot() Gets the root object of this model, or null if not yet set.
Rule	getRule(java.lang.Object object) Gets the rule from a violation object, or null if the object is not a violation object.
AuditModelSorter	getSorter() Gets the sorter for this model.
AuditType	getType() Gets the feature type (audit or metrics) of this model.
java.lang.Class	getType(java.lang.Object object) Gets the type of an object.
java.lang.Object	getValue(java.lang.Object object, int index) Gets the value of an attribute of an object.
Violation	getViolation(java.lang.Object object) Gets the object as a violation, or null if the object is not a violation.
int	getViolationCount() Gets the number of visible violations in this model.
int	getViolationTotal() Gets the total number of violations in this model.
boolean	isExceptional(java.lang.Object object, int index) Gets whether the value of an attribute of an object is exceptional.
boolean	isViolation(java.lang.Object object) Gets whether the object is a violation.
boolean	isVisible(java.lang.Object object) Gets whether an object is currently visible.
java.lang.Object	iterateChildren(java.lang.Object object, Iteration iteration) Iterates the child objects of an object.
Transform	iterateDefaultTransforms(java.lang.Object object, Iteration iteration) Iterates the default violations descended from an object.
void	removeAuditModelListener(AuditModelListener listener) Removes an audit model listener from this model.
void	setFilter(AuditModelFilter filter) Sets the filter for this model.
void	setSorter(AuditModelSorter sorter) Sets the sorter for this model.
void	setValue(java.lang.Object object, int index, java.lang.Object value) Sets the value of an attribute of an object.

Method Detail

addAuditModelListener

public void addAuditModelListener(AuditModelListener listener)

Adds an audit model listener to this model.

removeAuditModelListener

public void removeAuditModelListener(AuditModelListener listener)

Removes an audit model listener from this model.

clear

public void clear()

Clears this model.

getType

public AuditType getType()

Gets the feature type (audit or metrics) of this model.

getProfile

public Profile getProfile()

Gets the profile used to create this model.

getLocations

public Location[] getLocations()

Gets the locations audited to create this model.

getFilter

public AuditModelFilter getFilter()

Gets the filter for this model.

setFilter

public void setFilter(AuditModelFilter filter)

Sets the filter for this model.

getSorter

public AuditModelSorter getSorter()

Gets the sorter for this model.

setSorter

public void setSorter(AuditModelSorter sorter)

Sets the sorter for this model.

getColumnCount

public int getColumnCount()

Gets the number of columns in this model.

getColumn

public Attribute getColumn(int index)

Gets the column at an index.

getIndex

public int getIndex(Attribute column)

Gets the index of a column.

getDocumentCount

public int getDocumentCount()

Gets the number of visible documents (excluding root, workspace, project, and package pseudo-documents) in this model.

getExceptionCount

public int getExceptionCount()

Gets the number of visible exceptions in this model.

getViolationCount

public int getViolationCount()

Gets the number of visible violations in this model.

getDocumentTotal

public int getDocumentTotal()

Gets the total number of documents (excluding root, workspace, project and package pseudo-documents) in this model.

getExceptionTotal

public int getExceptionTotal()

Gets the total number of exceptions in this model.

getViolationTotal

public int getViolationTotal()

Gets the total number of violations in this model.

getRoot

public java.lang.Object getRoot()

Gets the root object of this model, or null if not yet set.

getLocation

public Location getLocation(java.lang.Object object)

Gets the Location of an object in this model.

getType

public java.lang.Class getType(java.lang.Object object)

Gets the type of an object. If the object is a construct, the type is one of the types returned by:

     getLocation(object).getDocument().getType().getViewTypes()
 

If the object is a violation, the type is Violation.

See Also:

DocumentTypeAdapter.getViewTypes()

isViolation

public boolean isViolation(java.lang.Object object)

Gets whether the object is a violation.

getViolation

public Violation getViolation(java.lang.Object object)

Gets the object as a violation, or null if the object is not a violation.

getRule

public Rule getRule(java.lang.Object object)

Gets the rule from a violation object, or null if the object is not a violation object.

isVisible

public boolean isVisible(java.lang.Object object)

Gets whether an object is currently visible.

getDisplayable

public Displayable getDisplayable(java.lang.Object object)

Gets a Displayable describing an object.

getParent

public java.lang.Object getParent(java.lang.Object object)

Gets the parent object of an object, or null if the object is the root.

containsChildren

public boolean containsChildren(java.lang.Object object)

Gets whether an object has children.

getChildren

public java.util.List getChildren(java.lang.Object object)

Gets the children of an object.

iterateChildren

public java.lang.Object iterateChildren(java.lang.Object object,
                                        Iteration iteration)

Iterates the child objects of an object.

Returns:

null if the iteration completed normally, or the last object processed if the iteration was aborted.

containsExceptionsOrViolations

public boolean containsExceptionsOrViolations(java.lang.Object object)

Gets whether an object contains exceptions or violations.

containsDefaultTransforms

public boolean containsDefaultTransforms(java.lang.Object object)

Gets whether an object contains exceptions or violations.

iterateDefaultTransforms

public Transform iterateDefaultTransforms(java.lang.Object object,
                                          Iteration iteration)

Iterates the default violations descended from an object.

Returns:

null if the iteration completed normally, or the last object processed if the iteration was aborted.

getValue

public java.lang.Object getValue(java.lang.Object object,
                                 int index)

Gets the value of an attribute of an object.

Parameters:

index - The index of the attribute.

setValue

public void setValue(java.lang.Object object,
                     int index,
                     java.lang.Object value)

Sets the value of an attribute of an object.

isExceptional

public boolean isExceptional(java.lang.Object object,
                             int index)

Gets whether the value of an attribute of an object is exceptional.

Parameters:

index - The index of the attribute.