|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StorageRead
This interface specifies the methods to browse test runs and access to tests measurements/results
Field Summary | |
---|---|
static java.lang.String |
STORAGE_READ
|
Method Summary | |
---|---|
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 |
---|
static final java.lang.String STORAGE_READ
Method Detail |
---|
TestDescriptor[] getTests(TestFilter filter) throws ClifException
filter
- the test run filter. If null, all available test runs are returned.
ClifException
BladeDescriptor[] getTestPlan(java.lang.String testName, BladeFilter filter) throws ClifException
filter
- retains only blades (injectors, probes) accepted by this filter. If null,
all blades are retained.testName
- the test run name
ClifException
java.util.Properties getBladeProperties(java.lang.String testName, java.lang.String bladeId) throws ClifException
testName
- the test run namebladeId
- the blade identifier
ClifException
TestDescriptor.getName()
,
BladeDescriptor.getId()
java.lang.String[] getEventFieldLabels(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel)
testName
- the test run namebladeId
- the blade identifier from the given test runeventTypeLabel
- the label of the event type
java.io.Serializable getEventIterator(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
testName
- the test name to retrieve events frombladeId
- the blade identifier in this test to retrieve events fromeventTypeLabel
- the type label of the retrieved eventsfilter
- 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.
ClifException
- the given test, blade, or event type could not be foundgetNextEvents(Serializable, int)
,
closeEventIterator(Serializable)
BladeEvent[] getNextEvents(java.io.Serializable iteratorKey, int count) throws ClifException
iteratorKey
- the key for the target event iteratorcount
- the number of event to get (at most)
ClifException
getEventIterator(String, String, String, EventFilter)
,
closeEventIterator(Serializable)
void closeEventIterator(java.io.Serializable iteratorKey)
iteratorKey
- the key for the target event iteratorBladeEvent[] getEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter, long fromIndex, int count) throws ClifException
testName
- the test name to retrieve events frombladeId
- the blade identifier in this test to retrieve events fromeventTypeLabel
- the type label of the retrieved eventsfilter
- 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.
ClifException
long countEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
testName
- the test name to retrieve events frombladeId
- the blade identifier in this test to retrieve events fromeventTypeLabel
- the type label of the retrieved eventsfilter
- 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.
ClifException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |