org.eclipse.tptp.platform.analysis.core.provider
Class AbstractAnalysisProvider

java.lang.Object
  org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
      org.eclipse.tptp.platform.analysis.core.provider.AbstractAnalysisProvider

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultAnalysisProvider

public abstract class AbstractAnalysisProvider

extends AbstractAnalysisElement

implements IAnalysisProvider

Constructor Summary

AbstractAnalysisProvider()
Constructor

Method Summary

void	analyze(org.eclipse.core.runtime.IProgressMonitor parentMonitor) Analyze the categories selected by the user
java.lang.String	getId()
java.util.List	getOwnedElements() Obtain a list of categories supported by this provider
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.
IAnalysisViewer	getViewer()
void	removeProperty(java.lang.String name) Remove a property and it's data from the property table
void	setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
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 class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

AbstractAnalysisProvider

public AbstractAnalysisProvider()

Constructor

Method Detail

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)
                           throws org.eclipse.core.runtime.CoreException

Specified by:

setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

Throws:

org.eclipse.core.runtime.CoreException

getId

public java.lang.String getId()

Specified by:

getId in interface IAnalysisProvider

Returns:

The id of this provider

getViewer

public IAnalysisViewer getViewer()

Specified by:

getViewer in interface IAnalysisElement

Overrides:

getViewer in class AbstractAnalysisElement

Returns:

the viewer for this category

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.

Specified by:

getResources in interface IAnalysisProvider

Returns:

A list of IResources to be analyzed

analyze

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

Analyze the categories selected by the user

Specified by:

analyze in interface IAnalysisProvider

Throws:

org.eclipse.core.runtime.CoreException

getOwnedElements

public java.util.List getOwnedElements()

Obtain a list of categories supported by this provider

Specified by:

getOwnedElements in interface IAnalysisElement

Overrides:

getOwnedElements in class AbstractAnalysisElement

Returns:

An list of IAnalysisCagtegory supported by this provider

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.

Specified by:

setProperty in interface IAnalysisProvider

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

Specified by:

getProperty in interface IAnalysisProvider

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

Specified by:

removeProperty in interface IAnalysisProvider

Parameters:

name - The name of the property to be removes