org.eclipse.tptp.platform.analysis.core.result
Class AbstractAnalysisResult

java.lang.Object
  org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
      org.eclipse.tptp.platform.analysis.core.result.AbstractAnalysisResult

Direct Known Subclasses:

CodeReviewResult, CodeReviewResult

public class AbstractAnalysisResult
extends AbstractAnalysisElement

This class provide a unbiquitous wrapper around a result from any analysis rule. The result instances contain provider-specific data, which can be viewed by a viewer in the rule's viewer chain. All classes that provide analysis result functionality should extend this class

Field Summary

static java.lang.String	MARKER_RECOMMENDATION The marker name for base recommendations
static java.lang.String	MARKER_RECOMMENDATION_BASE The marker name for base recommendations
static java.lang.String	MARKER_SEVERE The marker name for base severe problems
static java.lang.String	MARKER_SEVERE_BASE The marker name for base severe problems
static java.lang.String	MARKER_VALUE_HISTORY_ATTRIBUTE A value attached to markers to indicate analysis history used for the marker
static java.lang.String	MARKER_VALUE_IS_VISIBLE A value attached to markers to indicate if this marker will be visiible in the user interface
static java.lang.String	MARKER_VALUE_QUICKFIX_ATTRIBUTE A value attached to markers to indicate the presence of a quick fix
static java.lang.String	MARKER_VALUE_RULE_ATTRIBUTE A value attached to markers to indicate rule used to create the result
static java.lang.String	MARKER_VALUE_TYPE_ATTRIBUTE A value attached to markers to indicate AST node type held by the marker
static java.lang.String	MARKER_WARNING The marker name for base warnings
static java.lang.String	MARKER_WARNING_BASE The marker name for base warnings

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

AbstractAnalysisResult()
Constructor

Method Summary

java.lang.String	getHistoryId()
java.lang.String	getIconName()
java.lang.String	getLabelWithVariables()
java.lang.Object	getRuleSpecificResult()
boolean	isVisible()
void	setHistoryId(java.lang.String newHistoryId)
void	setRuleSpecificResult(java.lang.Object result)
void	setVisible(boolean visible) Controls the visibility on this result within the user interface.

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, 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

Field Detail

MARKER_RECOMMENDATION_BASE

public static final java.lang.String MARKER_RECOMMENDATION_BASE

The marker name for base recommendations

See Also:

Constant Field Values

MARKER_RECOMMENDATION

public static final java.lang.String MARKER_RECOMMENDATION

The marker name for base recommendations

See Also:

Constant Field Values

MARKER_WARNING_BASE

public static final java.lang.String MARKER_WARNING_BASE

The marker name for base warnings

See Also:

Constant Field Values

MARKER_WARNING

public static final java.lang.String MARKER_WARNING

The marker name for base warnings

See Also:

Constant Field Values

MARKER_SEVERE_BASE

public static final java.lang.String MARKER_SEVERE_BASE

The marker name for base severe problems

See Also:

Constant Field Values

MARKER_SEVERE

public static final java.lang.String MARKER_SEVERE

The marker name for base severe problems

See Also:

Constant Field Values

MARKER_VALUE_QUICKFIX_ATTRIBUTE

public static final java.lang.String MARKER_VALUE_QUICKFIX_ATTRIBUTE

A value attached to markers to indicate the presence of a quick fix

See Also:

Constant Field Values

MARKER_VALUE_TYPE_ATTRIBUTE

public static final java.lang.String MARKER_VALUE_TYPE_ATTRIBUTE

A value attached to markers to indicate AST node type held by the marker

See Also:

Constant Field Values

MARKER_VALUE_HISTORY_ATTRIBUTE

public static final java.lang.String MARKER_VALUE_HISTORY_ATTRIBUTE

A value attached to markers to indicate analysis history used for the marker

See Also:

Constant Field Values

MARKER_VALUE_RULE_ATTRIBUTE

public static final java.lang.String MARKER_VALUE_RULE_ATTRIBUTE

A value attached to markers to indicate rule used to create the result

See Also:

Constant Field Values

MARKER_VALUE_IS_VISIBLE

public static final java.lang.String MARKER_VALUE_IS_VISIBLE

A value attached to markers to indicate if this marker will be visiible in the user interface

See Also:

Constant Field Values

Constructor Detail

AbstractAnalysisResult

public AbstractAnalysisResult()

Constructor

Method Detail

setHistoryId

public final void setHistoryId(java.lang.String newHistoryId)

getHistoryId

public final java.lang.String getHistoryId()

getRuleSpecificResult

public final java.lang.Object getRuleSpecificResult()

getLabelWithVariables

public final java.lang.String getLabelWithVariables()

getIconName

public final java.lang.String getIconName()

Overrides:

getIconName in class AbstractAnalysisElement

See Also:

IAnalysisElement.getIconName()

setRuleSpecificResult

public final void setRuleSpecificResult(java.lang.Object result)

isVisible

public boolean isVisible()

Returns:

true is this user interface should display this result

setVisible

public void setVisible(boolean visible)

Controls the visibility on this result within the user interface.

Parameters:

visible - true if this result is visible in the user interface false otherwise