org.eclipse.tptp.platform.analysis.core.rule
Interface IAnalysisRule

All Superinterfaces:

IAnalysisElement, org.eclipse.core.runtime.IExecutableExtension

All Known Implementing Classes:

AbstractAnalysisRule

public interface IAnalysisRule

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

Method Summary

void	addHistoryResultSet(java.lang.String historyId, IAnalysisResult result) Add a new result to the history.
void	addParameter(RuleParameter parameter) Add a new parameter to the rule
void	addParameters(java.util.List parameters) Add a list of new rule parameters to the rule
void	analyze(AnalysisHistory history) Run the analysis portion of the rule to generate results for any matching data
java.lang.String	getLabelWithVariables()
RuleParameter	getParameter(java.lang.String name) Return the rule variable data of a named variable or null if no value was found
int	getParameterCount()
java.util.List	getParameterList()
IAnalysisProvider	getProvider() Return the provider, which is top-most owner in the category/rule tree
IAnalysisQuickFix	getQuickFix(java.lang.String newId)
int	getQuickFixCount()
java.util.Iterator	getQuickFixIterator() Return an iterator that can be used to crawl a list of quickfix id strings related to this rule
IAnalysisViewer	getViewer()
int	getVisibleVariableCount() Return the number of variables in the rule that are visible in the user interface.
boolean	hasQuickFixes() Determine if the rule has any quickfixes associated with it
boolean	isCustom() Used Internally
void	setCustom(boolean isCustom) Used Internally
void	setQuickFixId(java.lang.String newId) Allows a custom rule to define its own id

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

addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, dispose, getDetailProviders, getElementType, getHelpID, getHistoryResults, getIconName, getId, getLabel, getOwnedElements, getOwner, getPluginId, preAnalyze, removeHistoryResultSet, setElementType, setHelpID, setIconName, setId, setLabel, setOwner, setPluginId

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

setInitializationData

Method Detail

getQuickFixIterator

public java.util.Iterator getQuickFixIterator()

Return an iterator that can be used to crawl a list of quickfix id strings related to this rule

Returns:

A quickfix id iterator or null if no quickfixes relate to this rule

hasQuickFixes

public boolean hasQuickFixes()

Determine if the rule has any quickfixes associated with it

Returns:

true if there are associated quickfixes

setQuickFixId

public void setQuickFixId(java.lang.String newId)

Allows a custom rule to define its own id

Parameters:

newId - The id for the rule

getQuickFixCount

public int getQuickFixCount()

Returns:

The number of quickfixes supported by this rule

getQuickFix

public IAnalysisQuickFix getQuickFix(java.lang.String newId)

Parameters:

newId - The unique id of the quickfix to retrieve

Returns:

The the quickfix for this rule

addParameter

public void addParameter(RuleParameter parameter)

Add a new parameter to the rule

Parameters:

parameter - The parameter to add to the rule

addParameters

public void addParameters(java.util.List parameters)

Add a list of new rule parameters to the rule

Parameters:

parameters - A list of RuleParameter instances to add to the rule

getParameter

public RuleParameter getParameter(java.lang.String name)

Return the rule variable data of a named variable or null if no value was found

Parameters:

name - The name of the variable

Returns:

the rule variable data of the named variable or null if no value was found

getParameterCount

public int getParameterCount()

Returns:

the number of variables in the rule

getVisibleVariableCount

public int getVisibleVariableCount()

Return the number of variables in the rule that are visible in the user interface. Visible varaibles are those that have a label. Variables with an empty label are not displayed.

Returns:

the number of variables in the rule that are visible in the user interface.

getParameterList

public java.util.List getParameterList()

Returns:

The list of variables for this rule or null if there are no variables

getLabelWithVariables

public java.lang.String getLabelWithVariables()

Returns:

a label which includes variable substitutions

isCustom

public boolean isCustom()

Used Internally

Returns:

true if this is a user-defined custom rule

setCustom

public void setCustom(boolean isCustom)

Used Internally

Parameters:

isCustom -

analyze

public void analyze(AnalysisHistory history)

Run the analysis portion of the rule to generate results for any matching data

Parameters:

history - A reference to the history record for this analysis

getViewer

public IAnalysisViewer getViewer()

Returns:

the viewer for this result.

getProvider

public IAnalysisProvider getProvider()

Return the provider, which is top-most owner in the category/rule tree

addHistoryResultSet

public void addHistoryResultSet(java.lang.String historyId,
                                IAnalysisResult result)

Add a new result to the history.

Parameters:

historyId - The id of the history analysis run

result - The result to add