|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jdeveloper.audit.model.DocumentTypeAdapter
An adapter between a document type of the IDE and the Audit framework.
A type adapter identifies the IDE Element
classes, including the actual Document
class(es), which correspond to its document type. It knows its corresponding
DocumentAdapter
subclass, and manufactures a document adapter for
each document of the document type.
To reduce special case code in the Audit framework, Workspaces, Workspace,
and Project "documents" each have a corresponding
DocumentTypeAdapter
.
IDE extensions which provide type adapters register an
AuditProvider
with the
AuditManager
at startup. When
Audit initializes, it loads and instantiates the adapter classes from the
registered providers.
DocumentAdapter
Constructor Summary | |
DocumentTypeAdapter()
|
Method Summary | |
abstract DocumentAdapter |
createDocument(DocumentAdapterFactory factory,
DocumentAdapter workspace,
DocumentAdapter project,
java.net.URL url)
Creates a document adapter for a workspace, project, and URL. |
abstract java.lang.Class[] |
getDefaultViewTypes(AuditType type)
Gets the view types for this document type included by default in an Audit or Metrics report. |
abstract java.lang.Class[] |
getElementTypes()
Gets the IDE Element types for which this adapter supplies constructs. |
java.lang.Object |
getKey(java.net.URL url,
Project project,
Workspace workspace)
Creates a key for a workspace, project, and URL. |
java.net.URL[] |
getURLs(Element element,
Project project,
Workspace workspace)
Gets the URLs of an element, or null if none. |
abstract java.lang.Class[] |
getViewTypes()
Gets the view types for this document type. |
abstract javax.swing.Icon |
icon(java.lang.Class type)
Gets the icon for a view type of this document type. |
abstract javax.swing.Icon |
icon(java.lang.Object construct)
Gets the icon for a construct of this document type. |
boolean |
isPackaged()
Gets whether this document type has a package. |
abstract java.lang.String |
label(java.lang.Class type)
Gets the label for a view type of this document type. |
java.lang.String |
label(Element element)
Gets the label for an element associated with this document type. |
abstract java.lang.Object |
label(java.lang.Object construct)
Gets the label for a construct of this document type. |
abstract java.lang.String |
summary(java.lang.Class type)
Gets the summary for a view type of this document type. |
abstract java.lang.Object |
summary(java.lang.Object construct)
Gets the summary for a construct of this document type. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DocumentTypeAdapter()
Method Detail |
public abstract java.lang.Class[] getElementTypes()
public boolean isPackaged()
DocumentTypeAdapter
implementation returns false. Document types
that are located at run-time by their package location should override
this to return true. This method will probably be removed, but for now is
required by the Audit framework.
public java.net.URL[] getURLs(Element element, Project project, Workspace workspace)
Node
s will have one URL and other Elements
will have none. Exceptions include Workspaces, Applications, DirectoryFolders,
and PackageFolders.
public java.lang.Object getKey(java.net.URL url, Project project, Workspace workspace)
public abstract java.lang.Class[] getViewTypes()
public abstract java.lang.Class[] getDefaultViewTypes(AuditType type)
getViewTypes()
.
public abstract DocumentAdapter createDocument(DocumentAdapterFactory factory, DocumentAdapter workspace, DocumentAdapter project, java.net.URL url)
public java.lang.String label(Element element)
DocumentTypeAdapter
implementation returns element.getShortLabel()
.
public abstract java.lang.String label(java.lang.Class type)
public abstract java.lang.String summary(java.lang.Class type)
public abstract javax.swing.Icon icon(java.lang.Class type)
public abstract java.lang.Object label(java.lang.Object construct)
Object
, and Audit uses
String.valueOf(Object)
to get a string. Typically,
implementations of this method will return a string, but the return type
allows an implementation to return an object which defers expensive
formatting to its toString()
method. If necessary, the label
should be localized.
public abstract java.lang.Object summary(java.lang.Object construct)
Object
,
and Audit uses String.valueOf(Object)
to get a string. Typically,
implementations of this method will return a string, but the return type
allows an implementation to return an object which defers expensive
formatting to its toString()
method. The summary should be
localized.
public abstract javax.swing.Icon icon(java.lang.Object construct)
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.