org.eclipse.tptp.platform.analysis.core.history
Class AnalysisHistory

java.lang.Object
  org.eclipse.tptp.platform.analysis.core.history.AnalysisHistory

public final class AnalysisHistory
extends java.lang.Object

This class is not intended to be extended Creates an analysis element suitable for rendering in the result view.

Nested Class Summary

class

AnalysisHistory.AnalysisHistoryResultTracker A class used to track the time and result count for an analysis history or element

Constructor Summary

AnalysisHistory(AnalysisHistoryFactory factoryValue, java.lang.String configValue)
Construct a new analysis history for the specified configuration

AnalysisHistory(AnalysisHistoryFactory factoryValue, java.lang.String configValue, java.lang.String historyIdValue)
Construct a new analysis history for the specified configuration

Method Summary

boolean	containsAnalysisElement(AbstractAnalysisElement element)
AnalysisHistory.AnalysisHistoryResultTracker	countHistoryResults()
AnalysisHistory.AnalysisHistoryResultTracker	countHistoryResults(AnalysisHistoryElement ahe)
void	dispose()
java.util.List	getAnalyzedResources()
AnalysisHistoryElement	getHistoryElement(AbstractAnalysisElement element) This method find the history element for the specified analysis element in the history.
java.lang.String	getHistoryId()
java.lang.String	getLabel()
java.util.Map	getProviderPropertyHash()
java.util.List	getSelectAnalysisElements() Return the list of analysis elements selected by the user in the runtime configuration.
java.util.List	getSelectedElements() Return the list of selected history elements.
boolean	isBusy() Determines if this history element is currently active with analysis processing
void	setAnalyzedResources(java.util.List analyzedResources)
void	setBusy(boolean value)
java.lang.String	toString() Return a string representation of the history element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalysisHistory

public AnalysisHistory(AnalysisHistoryFactory factoryValue,
                       java.lang.String configValue)

Construct a new analysis history for the specified configuration

Parameters:

factoryValue - The history factory instance that owns this history

configValue - The name of the Eclipse runtime configuration being executed

AnalysisHistory

public AnalysisHistory(AnalysisHistoryFactory factoryValue,
                       java.lang.String configValue,
                       java.lang.String historyIdValue)

Construct a new analysis history for the specified configuration

Parameters:

factoryValue - The history factory instance that owns this history

configValue - The name of the Eclipse runtime configuration being executed

historyIdValue - The unique id for this history

Method Detail

getHistoryId

public final java.lang.String getHistoryId()

Returns:

The unique id for this history

getSelectedElements

public final java.util.List getSelectedElements()

Return the list of selected history elements. After the analysis is executed, there will be a history element for each selected analysis element.

Returns:

The list of selected history elements

getSelectAnalysisElements

public final java.util.List getSelectAnalysisElements()

Return the list of analysis elements selected by the user in the runtime configuration.

Returns:

The list of selected analysis elements

containsAnalysisElement

public final boolean containsAnalysisElement(AbstractAnalysisElement element)

Parameters:

element - The analysis element to search for

Returns:

true is the specified analysis element was selected by the user

getLabel

public final java.lang.String getLabel()

Returns:

The display name to use for this history instance

getHistoryElement

public final AnalysisHistoryElement getHistoryElement(AbstractAnalysisElement element)

This method find the history element for the specified analysis element in the history. The history element is used to keep stateful historical information for a given analysis element when it is executed.

Parameters:

element - The analysis element whose history element is being sought

Returns:

The history element matching the specified analysis element

countHistoryResults

public AnalysisHistory.AnalysisHistoryResultTracker countHistoryResults()

countHistoryResults

public AnalysisHistory.AnalysisHistoryResultTracker countHistoryResults(AnalysisHistoryElement ahe)

getProviderPropertyHash

public java.util.Map getProviderPropertyHash()

toString

public java.lang.String toString()

Return a string representation of the history element

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the history element

isBusy

public boolean isBusy()

Determines if this history element is currently active with analysis processing

Returns:

true if active, false otherwise

setBusy

public void setBusy(boolean value)

getAnalyzedResources

public java.util.List getAnalyzedResources()

setAnalyzedResources

public void setAnalyzedResources(java.util.List analyzedResources)

dispose

public void dispose()