org.eclipse.tptp.platform.analysis.core.provider
Interface IAnalysisProvider

All Superinterfaces:

IAnalysisElement, org.eclipse.core.runtime.IExecutableExtension

Deprecated. Use AbstractAnalysisClass instead

public interface IAnalysisProvider
extends IAnalysisElement, org.eclipse.core.runtime.IExecutableExtension

The interface used to implement analysis providers

Method Summary

void	addTemplate(RuleTemplate template) Deprecated. INTERNAL USE ONLY Used internally to add new templates to the provider.
void	analyze(org.eclipse.core.runtime.IProgressMonitor parentMonitor, AnalysisHistory history) Deprecated. Analyze the categories selected by the user
java.util.List	getDataExporters() Deprecated. Return a list of data exporters associated with this provider.
org.eclipse.core.runtime.IProgressMonitor	getProgressMonitor() Deprecated.
java.lang.Object	getProperty(java.lang.String historyId, java.lang.String name) Deprecated. Retrieve the data from a previously set property value
java.util.List	getResources() Deprecated. Return a list of IResources that were selected through the user interface.
java.util.List	getRuleTemplates() Deprecated. INTERNAL USE ONLY
IAnalysisViewer	getViewer() Deprecated.
void	removeProperty(java.lang.String historyId, java.lang.String name) Deprecated. Remove a property and it's data from the property table
void	setProgressMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor) Deprecated. This method assigns the progress monitor to the provider.
void	setProperty(java.lang.String historyId, java.lang.String name, java.lang.Object data) Deprecated. Provides a place to store data that may be common across multiple categories and/or rules.

Methods inherited from interface org.eclipse.tptp.platform.analysis.core.element.IAnalysisElement

addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, dispose, getDetailProviders, getElementType, getExternalDataMap, getHelpID, getHistoryResults, getIconName, getId, getLabel, getOwnedElements, getOwner, getPluginId, preAnalyze, removeHistoryResultSet, setElementType, setExternalDataMap, setHelpID, setIconName, setId, setLabel, setOwner, setPluginId

Methods inherited from interface org.eclipse.core.runtime.IExecutableExtension

setInitializationData

Method Detail

analyze

void analyze(org.eclipse.core.runtime.IProgressMonitor parentMonitor,
             AnalysisHistory history)

Deprecated.

Analyze the categories selected by the user

Parameters:

parentMonitor - The progress monitor of the parent task

history - A reference to the history record for this analysis

getResources

java.util.List getResources()

Deprecated.

Return a list of IResources that were selected through the user interface. This method can also be called by any owned category or rule if required.

Returns:

A list of IResources to be analyzed

setProperty

void setProperty(java.lang.String historyId,
                 java.lang.String name,
                 java.lang.Object data)

Deprecated.

Provides a place to store data that may be common across multiple categories and/or rules. The data is specific to the provider and its children.

Parameters:

historyId - The unique identifier for the analysis run that stores the properties

name - The name of the property where the data will be stored

data - The data to store

getProperty

java.lang.Object getProperty(java.lang.String historyId,
                             java.lang.String name)

Deprecated.

Retrieve the data from a previously set property value

Parameters:

historyId - The unique identifier for the analysis run that stores the properties

name - The name of the property where the data is stored

Returns:

The data object or null if not found

removeProperty

void removeProperty(java.lang.String historyId,
                    java.lang.String name)

Deprecated.

Remove a property and it's data from the property table

Parameters:

historyId - The unique identifier for the analysis run that stores the properties

name - The name of the property to be removes

addTemplate

void addTemplate(RuleTemplate template)

Deprecated.

INTERNAL USE ONLY Used internally to add new templates to the provider. This should not be called by developer code

Parameters:

template - The rule template to add to the provider

getRuleTemplates

java.util.List getRuleTemplates()

Deprecated.

INTERNAL USE ONLY

Returns:

A list of rule templates suypported by this provider

getProgressMonitor

org.eclipse.core.runtime.IProgressMonitor getProgressMonitor()

Deprecated.

Returns:

The progress monitor used by the analysis provider

setProgressMonitor

void setProgressMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Deprecated.

This method assigns the progress monitor to the provider. Use this with caution. It should be called only from within the analysis() method of a custom analysis provider.

Parameters:

progressMonitor - The progress monitor from the analysis provider

getViewer

IAnalysisViewer getViewer()

Deprecated.

Returns:

the viewer for this result.

getDataExporters

java.util.List getDataExporters()

Deprecated.

Return a list of data exporters associated with this provider.

Returns:

a list of IAnalysisExporter instances related to this provider