TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.core.category
Class DefaultAnalysisCategory

java.lang.Object
  extended by org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
      extended by org.eclipse.tptp.platform.analysis.core.category.DefaultAnalysisCategory
All Implemented Interfaces:
org.eclipse.core.runtime.IExecutableExtension, IAnalysisCategory, IAnalysisElement
Direct Known Subclasses:
AbstractAnalysisCategory

public class DefaultAnalysisCategory
extends AbstractAnalysisElement
implements IAnalysisCategory, org.eclipse.core.runtime.IExecutableExtension

The common behavior for an analysis category. This class can be used to provide analysis categoy functionality in 99% of all applications.


Field Summary
 
Fields inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
CATEGORY_ELEMENT_TYPE, COMBO_VALUE, DETAIL_PROVIDER, PROVIDER_ELEMENT_TYPE, PROVIDER_MANAGER_ELEMENT_TYPE, RESULT_ELEMENT_TYPE, RULE_ELEMENT_TYPE
 
Constructor Summary
DefaultAnalysisCategory()
          Constructor
 
Method Summary
 void analyze(AnalysisHistory history)
          Analyze the categories selected by the user
 IAnalysisViewer getViewer()
           
 boolean isCustom()
          Used Internally
 void setCustom(boolean value)
          Used Internally
 void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
           
 
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, getOwnedElements, 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
 
Methods inherited from interface org.eclipse.tptp.platform.analysis.core.category.IAnalysisCategory
getProvider
 
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
 

Constructor Detail

DefaultAnalysisCategory

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

getViewer

public IAnalysisViewer getViewer()
Specified by:
getViewer in interface IAnalysisCategory
Returns:
the viewer for this category
See Also:
IAnalysisCategory.getViewer()

analyze

public void analyze(AnalysisHistory history)
Description copied from interface: IAnalysisCategory
Analyze the categories selected by the user

Specified by:
analyze in interface IAnalysisCategory
Parameters:
history - A reference to the history record for this analysis
See Also:
IAnalysisCategory.analyze(org.eclipse.tptp.platform.analysis.core.history.AnalysisHistory)

isCustom

public final boolean isCustom()
Description copied from interface: IAnalysisCategory
Used Internally

Specified by:
isCustom in interface IAnalysisCategory
Returns:
true if this is a user-defined custom category
See Also:
IAnalysisCategory.isCustom()

setCustom

public final void setCustom(boolean value)
Description copied from interface: IAnalysisCategory
Used Internally

Specified by:
setCustom in interface IAnalysisCategory
See Also:
IAnalysisCategory.setCustom(boolean)

TPTP 4.5.0 Platform Project
Public API Specification