TPTP 4.5.0 Platform Project
Public API Specification

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

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

public final class AnalysisProviderManager
extends AbstractAnalysisElement
implements org.eclipse.core.runtime.IExecutableExtension

This class provides a set of common methods which can be used by any AnalysisProviderManager implementations.


Field Summary
 
Fields inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
CATEGORY_ELEMENT_TYPE, DETAIL_PROVIDER, PROVIDER_ELEMENT_TYPE, PROVIDER_MANAGER_ELEMENT_TYPE, RESULT_ELEMENT_TYPE, RULE_ELEMENT_TYPE
 
Constructor Summary
AnalysisProviderManager()
          Constructor
 
Method Summary
 void addAnalysisListener(IAnalysisListener listener)
          Deprecated. No longer required
 void analyze(AnalysisHistory history, java.util.List resourceList)
           
 void analyze(AnalysisHistory history, java.util.List resourceList, AbstractAnalysisProvider provider)
           
 java.util.List getCategories(AbstractAnalysisProvider provider)
           
 java.util.List getCategories(DefaultAnalysisCategory parentCategory)
           
 java.util.List getExcludedResources()
           
 java.util.List getIncludedResources()
           
 java.util.List getOwnedElements()
          (non-Javadoc)
 java.util.List getResources()
           
 java.util.List getRules(DefaultAnalysisCategory category)
           
 IAnalysisViewer getViewer()
           
 void loadAllCategories()
           
 void loadAllRules()
           
 void mapAllOwnedElements()
           
 void notifyAnalysisListeners(AbstractAnalysisElement element)
          Deprecated. No longer required
 void removeAnalysisListener(IAnalysisListener listener)
          Deprecated. No longer required
 void setExcludedResources(java.util.List list)
          Set a list of resources paths (as strings) that will be excluded from analysis
 void setIncludedResources(java.util.List list)
          Set a list of resources paths (as strings) that will be included for analysis
 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)
           
 
Methods inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, addParameter, addParameters, deleteHistoryResults, dispose, getDetailProviders, getElementType, getExecutionHistory, getExternalDataMap, getHelpID, getHistoryResults, getIconName, getId, getLabel, getOwner, getOwnerId, getParameter, getParameterCount, getParameterList, getPluginId, getProvider, getProviderManager, getViewerID, getVisibleParameterCount, postAnalyze, preAnalyze, removeHistoryResultSet, removeHistoryResultSet, setElementType, setExternalDataMap, setHelpID, setIconName, setId, setInitializationData, setLabel, setOwner, setOwnerId, setPluginId, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AnalysisProviderManager

public AnalysisProviderManager()
Constructor

Method Detail

setInitializationData

public final 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
See Also:
IExecutableExtension.setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)

addAnalysisListener

public final void addAnalysisListener(IAnalysisListener listener)
Deprecated. No longer required

See Also:
IAnalysisProviderManager.addAnalysisListener(org.eclipse.tptp.platform.analysis.core.manager.IAnalysisListener)

notifyAnalysisListeners

public final void notifyAnalysisListeners(AbstractAnalysisElement element)
Deprecated. No longer required

See Also:
IAnalysisProviderManager.notifyAnalysisListeners(org.eclipse.tptp.platform.analysis.core.element.IAnalysisElement)

removeAnalysisListener

public final void removeAnalysisListener(IAnalysisListener listener)
Deprecated. No longer required

See Also:
IAnalysisProviderManager.removeAnalysisListener(org.eclipse.tptp.platform.analysis.core.manager.IAnalysisListener)

analyze

public final void analyze(AnalysisHistory history,
                          java.util.List resourceList)
See Also:
IAnalysisProviderManager.analyze(org.eclipse.tptp.platform.analysis.core.history.AnalysisHistory, java.util.List)

synchronousAnalyze

public final void synchronousAnalyze(AnalysisHistory history,
                                     java.util.List resourceList,
                                     org.eclipse.core.runtime.IProgressMonitor monitor)
See Also:
IAnalysisProviderManager.synchronousAnalyze(org.eclipse.tptp.platform.analysis.core.history.AnalysisHistory, java.util.List, org.eclipse.core.runtime.IProgressMonitor)

analyze

public final void analyze(AnalysisHistory history,
                          java.util.List resourceList,
                          AbstractAnalysisProvider provider)
See Also:
org.eclipse.tptp.platform.analysis.core.manager.IAnalysisProviderManager#analyze(org.eclipse.tptp.platform.analysis.core.history.AnalysisHistory, java.util.List, org.eclipse.tptp.platform.analysis.core.provider.IAnalysisProvider)

getViewer

public final IAnalysisViewer getViewer()
See Also:
IAnalysisProviderManager.getViewer()

getCategories

public java.util.List getCategories(AbstractAnalysisProvider provider)

getCategories

public java.util.List getCategories(DefaultAnalysisCategory parentCategory)

getRules

public java.util.List getRules(DefaultAnalysisCategory category)

getOwnedElements

public final java.util.List getOwnedElements()
(non-Javadoc)

Overrides:
getOwnedElements in class AbstractAnalysisElement
Returns:
A list of IAnalysisElement instances owned by this element
See Also:
AbstractAnalysisElement.getOwnedElements()

getResources

public final java.util.List getResources()
See Also:
IAnalysisProviderManager.getResources()

getIncludedResources

public final java.util.List getIncludedResources()
Returns:
A list of path strings for resources that will be included from analysis

setIncludedResources

public final void setIncludedResources(java.util.List list)
Set a list of resources paths (as strings) that will be included for analysis

Parameters:
list - The list of analysis inclusions

getExcludedResources

public final java.util.List getExcludedResources()
Returns:
A list of path strings for resources that will be excluded from analysis

setExcludedResources

public final void setExcludedResources(java.util.List list)
Set a list of resources paths (as strings) that will be excluded from analysis

Parameters:
list - The list of analysis exclusions

mapAllOwnedElements

public void mapAllOwnedElements()

loadAllCategories

public void loadAllCategories()

loadAllRules

public void loadAllRules()

TPTP 4.5.0 Platform Project
Public API Specification