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

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

public class AnalysisHistory

extends java.lang.Object

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(java.lang.String configName)
Construct a new analysis history for the specified configuration

AnalysisHistory(java.lang.String configName, java.lang.String historyId)
Construct a new analysis history for the specified configuration

Method Summary

boolean	containsAnalysisElement(IAnalysisElement element)
AnalysisHistory.AnalysisHistoryResultTracker	countHistoryResults() INTERNAL USE ONLY Return a AnalysisHistoryResultTracker instance containg the total execution time and result count for this history
AnalysisHistory.AnalysisHistoryResultTracker	countHistoryResults(AnalysisHistoryElement ahe) INTERNAL USE ONLY Return a AnalysisHistoryResultTracker instance containg the total execution time and result count for this history
AnalysisHistoryElement	getHistoryElement(IAnalysisElement element) This method find the history element for the specified anlysis element in the history.
java.lang.String	getHistoryId()
java.lang.String	getLabel()
java.util.HashMap	getProviderPropertyHash() This method returns the hashmap associated with persisitent data stored in the provider.
java.util.List	getSelectAnalysisElements() Return the list of anlysis elements selected by the user in the runtime configuration.
java.util.List	getSelectedElements() Return the list of selected history elements.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalysisHistory

public AnalysisHistory(java.lang.String configName)

Construct a new analysis history for the specified configuration

Parameters:

configName - The name of the Eclipse runtime configuration being executed

AnalysisHistory

public AnalysisHistory(java.lang.String configName,
                       java.lang.String historyId)

Construct a new analysis history for the specified configuration

Parameters:

configName - THe name of the Eclipse runtime configuration being executed

Method Detail

getHistoryId

public java.lang.String getHistoryId()

Returns:

THe uniques id for this history

getSelectedElements

public 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 java.util.List getSelectAnalysisElements()

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

Returns:

The list of selected anlysis elements

containsAnalysisElement

public boolean containsAnalysisElement(IAnalysisElement element)

Parameters:

element - The anlysis element to search for

Returns:

true is the specified analysis element was selected by the user

getLabel

public java.lang.String getLabel()

Returns:

The display name to use for this history instance

getHistoryElement

public AnalysisHistoryElement getHistoryElement(IAnalysisElement element)

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

Parameters:

element - The anlysis element whose history element is beign sought

Returns:

The history element matching the specified analysis element

countHistoryResults

public AnalysisHistory.AnalysisHistoryResultTracker countHistoryResults()

INTERNAL USE ONLY Return a AnalysisHistoryResultTracker instance containg the total execution time and result count for this history

Returns:

An instance of AnalysisHistoryResultTracker containing the number of results and execution time for this history

countHistoryResults

public AnalysisHistory.AnalysisHistoryResultTracker countHistoryResults(AnalysisHistoryElement ahe)

INTERNAL USE ONLY Return a AnalysisHistoryResultTracker instance containg the total execution time and result count for this history

Parameters:

ahe - The history element for which result tracking will be calculated

Returns:

An instance of AnalysisHistoryResultTracker containing the number of results and execution time for this history

getProviderPropertyHash

public java.util.HashMap getProviderPropertyHash()

This method returns the hashmap associated with persisitent data stored in the provider. This can be used are analysis run time to store data common to more than one analysis element.

Returns:

the provider property hash map

toString

public java.lang.String toString()