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

All Superinterfaces:

IAnalysisElement, org.eclipse.core.runtime.IExecutableExtension

All Known Implementing Classes:

AbstractAnalysisProvider

public interface IAnalysisProvider

extends IAnalysisElement, org.eclipse.core.runtime.IExecutableExtension

Method Summary

void	analyze(org.eclipse.core.runtime.IProgressMonitor parentMonitor) Analyze the categories selected by the user
java.lang.String	getId()
java.lang.Object	getProperty(java.lang.String name) Retrieve the data from a previously set property value
java.util.List	getResources() Return a list of IResources that were selected through the user interface.
void	removeProperty(java.lang.String name) Remove a property and it's data from the property table
void	setProperty(java.lang.String name, java.lang.Object data) 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

addOwnedElement, addOwnedElements, canAddElements, getConfiguration, getDescription, getIconName, getIconUrl, getLabel, getOwnedElements, getOwner, getPath, getProvider, getProviderManager, getViewer, isEnabled, setDescription, setEnabled, setIconName, setLabel, setOwner

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

setInitializationData

Method Detail

getId

public java.lang.String getId()

Returns:

The id of this provider

analyze

public void analyze(org.eclipse.core.runtime.IProgressMonitor parentMonitor)
             throws org.eclipse.core.runtime.CoreException

Analyze the categories selected by the user

Throws:

org.eclipse.core.runtime.CoreException

getResources

public java.util.List getResources()

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

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

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:

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

data - The data to store

getProperty

public java.lang.Object getProperty(java.lang.String name)

Retrieve the data from a previously set property value

Parameters:

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

Returns:

The data object or null if not found

removeProperty

public void removeProperty(java.lang.String name)

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

Parameters:

name - The name of the property to be removes