org.eclipse.sphinx.platform.stats

Interface IPerformanceStats<T extends IEventTypeEnumerator>

All Known Implementing Classes:

AbstractPerformanceStats, EcorePerformanceStats, ModelSavingPerformanceStats, ValidationPerformanceStats

public interface IPerformanceStats<T extends IEventTypeEnumerator>

Method Summary

Modifier and Type	Method and Description
void	closeAllParentContext() Close all the context in contextStackCall list and remove them from the list.
void	closeAndLogContext(java.lang.String context) Close a context using name provided in argument and remove it from contextStackCall list.
void	closeAndLogContext(java.lang.String context, java.lang.Object blame) Close a context using name provided in argument and remove it from contextStackCall list.
void	closeAndLogCurrentContext() Close the last context in contextStackCall list and remove it from the list.
void	closeContext(java.lang.String context) Close a context using name provided in argument and remove it from context stack call list.
boolean	contextRunningTimeExceedTimeOut(java.lang.String context, long timeOut) Check if the running time for the context provided in argument exceed the timeout value provide in argument.
void	endEvent(T enumerator, java.lang.Object blameObject) Stop the running time for the event referenced by the ID and the blame object under the current opened context .
void	endEvent(T enumerator, java.lang.Object blameObject, java.lang.String context) Stop the running time for the event referenced by the ID and the blame object under the provided context.
java.util.Collection<java.lang.String>	getContextNames() Return a list of all the context declared in the base.
long	getContextRunningTime(java.lang.String context) Return the context running time in millisecond.
StatsEvent	getEventStat(T enumerator, java.lang.Object blameObject, java.lang.String context) Return the StatsEvent referenced by the ID and the blame object under the provided context.
java.util.Map<java.lang.Integer,StatsEvent>	getEventStats(T enumerator, java.lang.String context) Return all the StatsEvent of this ID under the provided context.
java.util.List<StatsEvent>	getEventsTimeFailure() Return a list of all the events triggered under any of the contexts,that are in time failure state.
java.util.List<StatsEvent>	getTimeFailureEventsInContext(java.lang.String context) Return a list of all the events under that context that are in time failure state.
boolean	isContextEventsTimeFailure(java.lang.String context) Check if there are events triggered under the context,that are in time failure state.
boolean	isEnabled() Return activation status for performanceStats framework.
boolean	isEventsTimeFailure() Check if there are events triggered under any of the contexts,that are in time failure state.
boolean	isEventTimeFail(T enumerator, java.lang.Object blameObject) Test if an event triggered under default context has a running time exceeding timeout value defined in .option file.
boolean	isEventTimeFail(T enumerator, java.lang.Object blameObject, java.lang.String context) Test if an event triggered under context has a running time exceeding timeout value defined in .option file.
boolean	isEventTriggered()
boolean	isRegisteredContext(java.lang.String context) Check if the context provided in argument has been declared and used.
int	numberOfContextEventsTimeFailure(java.lang.String context) Return the number of events triggered under the context,that are in time failure state.
int	numberOfEventsTimeFailure(java.lang.String context) Return the number of events triggered under any of the contexts,that are in time failure state.
void	openContext(java.lang.String context) Open a context using name provided in argument, and add it to the top of contextStackCall list.
void	openContext(java.lang.String context, java.lang.Object blame) Open a context using name provided in argument, and add it to the top of contextStackCall list.
boolean	openContextIfFirstOne(java.lang.String context)
java.lang.String	printAllStats() Provided a string representing all data stored in the base.
java.lang.String	printContextStats(java.lang.String context) Provided a string representing all data stored in the base for one context.
java.lang.String	printContextsTree() Provided a string representing the tree architecture for all the contexts.
java.lang.String	printContextTree(java.lang.String context) Provided a string representing the tree architecture for one context.
java.lang.String	printEventStat(T enumerator, java.lang.Object blameObject, java.lang.String context) Provided a string representing data stored in the base for one event.
java.lang.String	printEventStats(T enumerator, java.lang.String context) Provided a string representing data stored in the base for one ID type of event under a given context.
void	removeAllStats() Remove all contexts and events stored in the data base.
void	removeContext(java.lang.String context) Remove a context from the data base and all the events stored under that context.
void	removeStat(T enumerator, java.lang.Object blameObject, java.lang.String context) Remove a StatsEvent object from the data base.
void	removeStatsForContext(java.lang.String context) Remove all the events stored under that context from the data base.
void	removeStatsForEvent(T enumerator, java.lang.String context) Remove all the events of one given ID stored under that context from the data base.
void	startEvent(T enumerator, java.lang.Object blameObject) Start an event under the current opened context (default context if no context is opened).If an event with the same ID and the same blame object has been previously triggered, the running time for this declaration will be added to the current running time value and runCount parameter will be incremented.
void	startEvent(T enumerator, java.lang.Object blameObject, java.lang.String context) Start an event under the provided context (default context if the context is not opened).If an event with the same ID and the same blame object has been previously triggered, the running time for this declaration will be added to the current running time value and runCount parameter will be incremented.
void	startNewEvent(T enumerator, java.lang.Object blameObject) Start a new event under the current opened context (default context if no context is opened).If an event with the same ID and the same blame object has been previously triggered it will be replaced.
void	startNewEvent(T enumerator, java.lang.Object blameObject, java.lang.String context) Start a new event under the provided context (default context if the context is not opened).If an event with the same ID and the same blame object has been previously triggered it will be replaced.

Method Detail

isEnabled

boolean isEnabled()

Return activation status for performanceStats framework.

Returns:

true if option "org.eclipse.sphinx.platform/perf/jUnitOptions/resetEventBase" = true in ".option" file and if -debug flag is set in configuration launch arguments.

isEventTriggered

boolean isEventTriggered()

openContextIfFirstOne

boolean openContextIfFirstOne(java.lang.String context)

openContext

void openContext(java.lang.String context,
                 java.lang.Object blame)

Open a context using name provided in argument, and add it to the top of contextStackCall list. If context is open for the first time a new one is created and added. All the events triggered after the call to openContext(String context) and before a call to closeContext(String context) or closeCurrentContext() will be included in this context.

Parameters:

context - the name of the context to open. This must not be null.

openContext

void openContext(java.lang.String context)

Open a context using name provided in argument, and add it to the top of contextStackCall list. If context is open for the first time a new one is created and added. All the events triggered after the call to openContext(String context) and before a call to closeContext(String context) or closeCurrentContext() will be included in this context.

Parameters:

context - the name of the context to open. This must not be null.

closeAndLogContext

void closeAndLogContext(java.lang.String context,
                        java.lang.Object blame)

Close a context using name provided in argument and remove it from contextStackCall list. In runTime mode context description is logged after context is closed. If the option org.eclipse.sphinx.platform/perf/jUnitOptions/resetEventBase in .option file is set true all the events included in this context are removed from the base after logging.

Parameters:

context - the name of the context to close. This must not be null.

closeAndLogContext

void closeAndLogContext(java.lang.String context)

Close a context using name provided in argument and remove it from contextStackCall list. In runTime mode context description is logged after context is closed. If the option org.eclipse.sphinx.platform/perf/jUnitOptions/resetEventBase in .option file is set true all the events included in this context are removed from the base after logging.

Parameters:

context - the name of the context to close. This must not be null.

closeAndLogCurrentContext

void closeAndLogCurrentContext()

Close the last context in contextStackCall list and remove it from the list. In runTime mode context description is logged after context is closed. If the option org.eclipse.sphinx.platform/perf/jUnitOptions/resetEventBase in .option file is set true all the events included in this context are removed from the base after logging.

closeAllParentContext

void closeAllParentContext()

Close all the context in contextStackCall list and remove them from the list. In runTime mode context description of the first context in the list (the parent context)is logged. If the option org.eclipse.sphinx.platform/perf/jUnitOptions/resetEventBase in .option file is set true all the events included in this context are removed from the base after logging.

closeContext

void closeContext(java.lang.String context)

Close a context using name provided in argument and remove it from context stack call list. All the events triggered after this call to the close method will be included in the previous opened context. If there is no more opened context events are added to default context Global.

Parameters:

context - the name of the context to close. This must not be null.

removeStat

void removeStat(T enumerator,
                java.lang.Object blameObject,
                java.lang.String context)

Remove a StatsEvent object from the data base.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

context - the context where the event has been triggered.

removeContext

void removeContext(java.lang.String context)

Remove a context from the data base and all the events stored under that context.

Parameters:

context - the name of the context to remove.

removeStatsForContext

void removeStatsForContext(java.lang.String context)

Remove all the events stored under that context from the data base.

Parameters:

context - the name of the context.

removeStatsForEvent

void removeStatsForEvent(T enumerator,
                         java.lang.String context)

Remove all the events of one given ID stored under that context from the data base.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

context - the name of the context.

removeAllStats

void removeAllStats()

Remove all contexts and events stored in the data base.

isEventTimeFail

boolean isEventTimeFail(T enumerator,
                        java.lang.Object blameObject)

Test if an event triggered under default context has a running time exceeding timeout value defined in .option file.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

Returns:

true if running time for the event exceed the timeout value defined in .option file. return false if the event does not exist ,if timeout value has not been set or if running time is under timeout value.

isEventTimeFail

boolean isEventTimeFail(T enumerator,
                        java.lang.Object blameObject,
                        java.lang.String context)

Test if an event triggered under context has a running time exceeding timeout value defined in .option file.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

context - the name of the context.

Returns:

true if running time for the event exceed the timeout value defined in .option file. return false if the event does not exist ,if timeout value has not been set or if running time is under timeout value.

startNewEvent

void startNewEvent(T enumerator,
                   java.lang.Object blameObject)

Start a new event under the current opened context (default context if no context is opened).If an event with the same ID and the same blame object has been previously triggered it will be replaced.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

startEvent

void startEvent(T enumerator,
                java.lang.Object blameObject)

Start an event under the current opened context (default context if no context is opened).If an event with the same ID and the same blame object has been previously triggered, the running time for this declaration will be added to the current running time value and runCount parameter will be incremented.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

startNewEvent

void startNewEvent(T enumerator,
                   java.lang.Object blameObject,
                   java.lang.String context)

Start a new event under the provided context (default context if the context is not opened).If an event with the same ID and the same blame object has been previously triggered it will be replaced.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

startEvent

void startEvent(T enumerator,
                java.lang.Object blameObject,
                java.lang.String context)

Start an event under the provided context (default context if the context is not opened).If an event with the same ID and the same blame object has been previously triggered, the running time for this declaration will be added to the current running time value and runCount parameter will be incremented.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

endEvent

void endEvent(T enumerator,
              java.lang.Object blameObject)

Stop the running time for the event referenced by the ID and the blame object under the current opened context .

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

endEvent

void endEvent(T enumerator,
              java.lang.Object blameObject,
              java.lang.String context)

Stop the running time for the event referenced by the ID and the blame object under the provided context.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

context - the name of the context containing the event.

getEventStat

StatsEvent getEventStat(T enumerator,
                        java.lang.Object blameObject,
                        java.lang.String context)

Return the StatsEvent referenced by the ID and the blame object under the provided context.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

context - the name of the context containing the event.

Returns:

StatsEvent

getEventStats

java.util.Map<java.lang.Integer,StatsEvent> getEventStats(T enumerator,
                                                          java.lang.String context)

Return all the StatsEvent of this ID under the provided context.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

context - the name of the context containing the event.

Returns:

Map

getContextNames

java.util.Collection<java.lang.String> getContextNames()

Return a list of all the context declared in the base.

Returns:

Collection

contextRunningTimeExceedTimeOut

boolean contextRunningTimeExceedTimeOut(java.lang.String context,
                                        long timeOut)

Check if the running time for the context provided in argument exceed the timeout value provide in argument.

Parameters:

context - the name of the context.

timeOut - timeout value in millisecond.

Returns:

true if context has been declared false otherwise.

isRegisteredContext

boolean isRegisteredContext(java.lang.String context)

Check if the context provided in argument has been declared and used.

Parameters:

context - the name of the context.

Returns:

true if context has been declared false otherwise.

getContextRunningTime

long getContextRunningTime(java.lang.String context)

Return the context running time in millisecond.

Parameters:

context - the name of the context.

Returns:

long the running time in millisecond.return -1 if the context do not exist.

getTimeFailureEventsInContext

java.util.List<StatsEvent> getTimeFailureEventsInContext(java.lang.String context)

Return a list of all the events under that context that are in time failure state.

Parameters:

context - the name of the context.

Returns:

LinkedList .

isEventsTimeFailure

boolean isEventsTimeFailure()

Check if there are events triggered under any of the contexts,that are in time failure state.

Returns:

true if at least one of all the events triggered is in time failure state.

numberOfEventsTimeFailure

int numberOfEventsTimeFailure(java.lang.String context)

Return the number of events triggered under any of the contexts,that are in time failure state.

Returns:

int

getEventsTimeFailure

java.util.List<StatsEvent> getEventsTimeFailure()

Return a list of all the events triggered under any of the contexts,that are in time failure state.

Returns:

LinkedList

isContextEventsTimeFailure

boolean isContextEventsTimeFailure(java.lang.String context)

Check if there are events triggered under the context,that are in time failure state.

Parameters:

context - the name of the context.

Returns:

true if at least one of all the events triggered under this context is in time failure state.

numberOfContextEventsTimeFailure

int numberOfContextEventsTimeFailure(java.lang.String context)

Return the number of events triggered under the context,that are in time failure state.

Parameters:

context - the name of the context.

Returns:

int

printContextTree

java.lang.String printContextTree(java.lang.String context)

Provided a string representing the tree architecture for one context. All its child contexts are listed.

Parameters:

context - the name of the context.

Returns:

String

printContextsTree

java.lang.String printContextsTree()

Provided a string representing the tree architecture for all the contexts. All contexts stored in the base and there child contexts are listed.

Returns:

String

printAllStats

java.lang.String printAllStats()

Provided a string representing all data stored in the base. All contexts stored in the base and their events are listed.

Returns:

String

printContextStats

java.lang.String printContextStats(java.lang.String context)

Provided a string representing all data stored in the base for one context. All events and child contexts stored in the base for this context are listed.

Parameters:

context - the name of the context.

Returns:

String

printEventStat

java.lang.String printEventStat(T enumerator,
                                java.lang.Object blameObject,
                                java.lang.String context)

Provided a string representing data stored in the base for one event.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

blameObject - An object responsible for the event.Can be a simple string. Must not be null.

context - the name of the context containing the event.

Returns:

String

printEventStats

java.lang.String printEventStats(T enumerator,
                                 java.lang.String context)

Provided a string representing data stored in the base for one ID type of event under a given context.

Parameters:

enumerator - The ID of the event.Must be an enumerator provided by the enum declared in the concrete class of AbstractPerformanceStats.

context - the name of the context containing the event.

Returns:

String