org.ow2.clif.storage.api

Interface StorageRead

All Known Implementing Classes:

AnalyzerImpl, ConsoleFileStorageImpl, FileStorageReader, StorageReadHelper

public interface StorageRead

This interface specifies the methods to browse test runs and access to tests measurements/results

Author:

Bruno Dillenseger

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STORAGE_READ

Method Summary

Modifier and Type	Method and Description
void	closeEventIterator(java.io.Serializable iteratorKey) Discards the iterator associated to the given key, possibly releasing resources.
long	countEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) Counts the number of available events matching a given filter.
java.util.Properties	getBladeProperties(java.lang.String testName, java.lang.String bladeId) Gets the java system properties for the given blade from the given test run
java.lang.String[]	getEventFieldLabels(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel) Gets the labels of fields hold by a given event type.
java.io.Serializable	getEventIterator(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) Creates an event iterator.
BladeEvent[]	getEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter, long fromIndex, int count) Retrieves a given number of events matching a given filter, from a given index.
BladeEvent[]	getNextEvents(java.io.Serializable iteratorKey, int count) Gets next events from the given event iterator.
BladeDescriptor[]	getTestPlan(java.lang.String testName, BladeFilter filter) Gets the test plan definition for a given test run name.
TestDescriptor[]	getTests(TestFilter filter) Gets a list of test runs matching a given filter.

Field Detail

STORAGE_READ

static final java.lang.String STORAGE_READ

See Also:

Constant Field Values

Method Detail

getTests

TestDescriptor[] getTests(TestFilter filter)
                   throws ClifException

Gets a list of test runs matching a given filter.

Parameters:

filter - the test run filter. If null, all available test runs are returned.

Returns:

an array of test run descriptors

Throws:

ClifException

getTestPlan

BladeDescriptor[] getTestPlan(java.lang.String testName,
                              BladeFilter filter)
                       throws ClifException

Gets the test plan definition for a given test run name.

Parameters:

filter - retains only blades (injectors, probes) accepted by this filter. If null, all blades are retained.

testName - the test run name

Returns:

an array of descriptors for blades composing the test run and accepted by the optional filter.

Throws:

ClifException

getBladeProperties

java.util.Properties getBladeProperties(java.lang.String testName,
                                        java.lang.String bladeId)
                                 throws ClifException

Gets the java system properties for the given blade from the given test run

Parameters:

testName - the test run name

bladeId - the blade identifier

Returns:

the Java system properties for the given blade

Throws:

ClifException

See Also:

TestDescriptor.getName(), BladeDescriptor.getId()

getEventFieldLabels

java.lang.String[] getEventFieldLabels(java.lang.String testName,
                                       java.lang.String bladeId,
                                       java.lang.String eventTypeLabel)

Gets the labels of fields hold by a given event type.

Parameters:

testName - the test run name

bladeId - the blade identifier from the given test run

eventTypeLabel - the label of the event type

Returns:

an array of event field labels provided by the given event type

getEventIterator

java.io.Serializable getEventIterator(java.lang.String testName,
                                      java.lang.String bladeId,
                                      java.lang.String eventTypeLabel,
                                      EventFilter filter)
                               throws ClifException

Creates an event iterator.

Parameters:

testName - the test name to retrieve events from

bladeId - the blade identifier in this test to retrieve events from

eventTypeLabel - the type label of the retrieved events

filter - the filter object to be used for event selection. If null, the iterator will return all events. The filter object may throw a NoMoreEvent exception, in which case current iterator step stops and currently selected events are returned.

Returns:

the iterator key to be used to iterate on getting events, and then to discard the iterator when done

Throws:

ClifException - the given test, blade, or event type could not be found

See Also:

getNextEvents(Serializable, int), closeEventIterator(Serializable)

getNextEvents

BladeEvent[] getNextEvents(java.io.Serializable iteratorKey,
                           int count)
                    throws ClifException

Gets next events from the given event iterator.

Parameters:

iteratorKey - the key for the target event iterator

count - the number of event to get (at most)

Returns:

selected events

Throws:

ClifException

See Also:

getEventIterator(String, String, String, EventFilter), closeEventIterator(Serializable)

closeEventIterator

void closeEventIterator(java.io.Serializable iteratorKey)

Discards the iterator associated to the given key, possibly releasing resources.

Parameters:

iteratorKey - the key for the target event iterator

getEvents

BladeEvent[] getEvents(java.lang.String testName,
                       java.lang.String bladeId,
                       java.lang.String eventTypeLabel,
                       EventFilter filter,
                       long fromIndex,
                       int count)
                throws ClifException

Retrieves a given number of events matching a given filter, from a given index.

Parameters:

testName - the test name to retrieve events from

bladeId - the blade identifier in this test to retrieve events from

eventTypeLabel - the type label of the retrieved events

filter - the filter object to be used for event selection. If null, all events are selected. If the filter throws a NoMoreEvent exception, the selection process stops, and currently selected events are returned.

fromIndex - the index of the first event to be considered (in other words, events in range 0..fromIndex-1 are ignored). If negative and count parameter is greater than zero, then the latest events will be retrieved.

count - the maximum number of events to retrieve. If negative, the number of retrieved events is not limited.

Returns:

selected blade events

Throws:

ClifException

countEvents

long countEvents(java.lang.String testName,
                 java.lang.String bladeId,
                 java.lang.String eventTypeLabel,
                 EventFilter filter)
          throws ClifException

Counts the number of available events matching a given filter.

Parameters:

testName - the test name to retrieve events from

bladeId - the blade identifier in this test to retrieve events from

eventTypeLabel - the type label of the retrieved events

filter - the filter object to be used for event selection. If null, all events are counted. Counting stops before completion if the filter object throws a NoMoreEvent exception, in which case count value before exception is returned.

Returns:

the number of available blade events matching the provided filter.

Throws:

ClifException