TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.core.manager
Class AnalysisProviderManager

java.lang.Object
  extended byorg.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
      extended byorg.eclipse.tptp.platform.analysis.core.manager.AnalysisProviderManager
All Implemented Interfaces:
IAnalysisElement, IAnalysisProviderManager, org.eclipse.core.runtime.IExecutableExtension

public class AnalysisProviderManager
extends AbstractAnalysisElement
implements IAnalysisProviderManager


Field Summary
 
Fields inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
DETAIL_PROVIDER
 
Constructor Summary
AnalysisProviderManager()
          Constructor
 
Method Summary
 void addAnalysisListener(IAnalysisListener listener)
          Add a listener for analysis events
 void analyze(AnalysisHistory history, java.util.List resourceList)
          Execute the selected analysis rules on a list of projects for each provider and provider manager
 java.util.List getOwnedElements()
          Obtain a list of providers supported by this manager
 java.util.List getResources()
           
 IAnalysisViewer getViewer()
           
 void notifyAnalysisListeners(IAnalysisElement element)
          This method is used internally to notify any analysis listeners that analysis of a given element has been completed
 void removeAnalysisListener(IAnalysisListener listener)
          remove an analysis event listener
 void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
           
 void synchronousAnalyze(AnalysisHistory history, java.util.List resourceList, org.eclipse.core.runtime.IProgressMonitor monitor)
          FOR INTERNAL USE ONLY.
 
Methods inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, deleteHistoryResults, dispose, getDetailProviders, getElementType, getExecutionHistory, getHelpID, getHistoryResults, getIconName, getId, getLabel, getOwner, getPluginId, getViewerID, preAnalyze, removeHistoryResultSet, setElementType, setHelpID, setIconName, setId, setInitializationData, setLabel, setOwner, setPluginId, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.tptp.platform.analysis.core.element.IAnalysisElement
addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, dispose, getDetailProviders, getElementType, getHelpID, getHistoryResults, getIconName, getId, getLabel, getOwner, getPluginId, preAnalyze, removeHistoryResultSet, setElementType, setHelpID, setIconName, setId, setLabel, setOwner, setPluginId
 

Constructor Detail

AnalysisProviderManager

public AnalysisProviderManager()
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

addAnalysisListener

public void addAnalysisListener(IAnalysisListener listener)
Add a listener for analysis events

Specified by:
addAnalysisListener in interface IAnalysisProviderManager
Parameters:
listener - The analysis listener to add

notifyAnalysisListeners

public void notifyAnalysisListeners(IAnalysisElement element)
This method is used internally to notify any analysis listeners that analysis of a given element has been completed

Specified by:
notifyAnalysisListeners in interface IAnalysisProviderManager
Parameters:
element - The element that has completed its analysis

removeAnalysisListener

public void removeAnalysisListener(IAnalysisListener listener)
remove an analysis event listener

Specified by:
removeAnalysisListener in interface IAnalysisProviderManager
Parameters:
listener - The analysis listener to remove

analyze

public void analyze(AnalysisHistory history,
                    java.util.List resourceList)
Execute the selected analysis rules on a list of projects for each provider and provider manager

Specified by:
analyze in interface IAnalysisProviderManager
Parameters:
history - A reference to the history record for this analysis
resourceList - A list of project resources that will be anaylzed

synchronousAnalyze

public void synchronousAnalyze(AnalysisHistory history,
                               java.util.List resourceList,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
FOR INTERNAL USE ONLY. Execute the selected analysis rules on a list of projects for each provider and provider manager, synchronously.

Specified by:
synchronousAnalyze in interface IAnalysisProviderManager
Parameters:
monitor - A progress monitor

getViewer

public IAnalysisViewer getViewer()
Specified by:
getViewer in interface IAnalysisProviderManager
Returns:
the viewer for this category

getOwnedElements

public java.util.List getOwnedElements()
Obtain a list of providers supported by this manager

Specified by:
getOwnedElements in interface IAnalysisProviderManager
Overrides:
getOwnedElements in class AbstractAnalysisElement
Returns:
An list of IAnalysisProviders supported by this manager

getResources

public java.util.List getResources()
Specified by:
getResources in interface IAnalysisProviderManager
Returns:
Return a list of project names that will be analyzed

TPTP 4.2.0 Platform Project
Public API Specification