public class StorageReadHelper extends java.lang.Object implements StorageRead
STORAGE_READ
Constructor and Description |
---|
StorageReadHelper(StorageRead backend)
Creates a new front-end on top of the provided StorageRead
back-end implementation, providing extra utility methods.
|
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.lang.Object[][] |
getAllFieldsValues(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel,
java.lang.String xFieldLabel,
java.lang.String yFieldLabel,
int start,
int end,
int count) |
BladeEvent[] |
getBladeEvents(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel,
java.lang.Object object) |
java.lang.Object[][] |
getBladeEventsValues(BladeEvent[] bladeEventList,
java.lang.String xFieldLabel,
java.lang.String yFieldLabel) |
java.util.List<BladeEvent> |
getBladeOneEventValues(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel) |
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.util.SortedSet<java.lang.String> |
getBladesIds(java.lang.String testName) |
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.
|
java.util.SortedSet<java.lang.String> |
getEventsTypeLabels(java.lang.String testName,
java.lang.String bladeId) |
long |
getLifecycleCompleted(java.lang.String testName,
java.lang.String bladeId) |
long |
getLifecycleRunning(java.lang.String testName,
java.lang.String bladeId) |
long |
getMaxTimeFor(java.lang.String testName,
java.lang.String bladeId) |
long |
getMinTimeFor(java.lang.String testName,
java.lang.String bladeId) |
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.
|
java.util.SortedSet<java.lang.String> |
getTestsNames()
Get the tests' names.
|
public StorageReadHelper(StorageRead backend)
backend
- public TestDescriptor[] getTests(TestFilter filter) throws ClifException
StorageRead
getTests
in interface StorageRead
filter
- the test run filter. If null, all available test runs are returned.ClifException
public BladeDescriptor[] getTestPlan(java.lang.String testName, BladeFilter filter) throws ClifException
StorageRead
getTestPlan
in interface StorageRead
testName
- the test run namefilter
- retains only blades (injectors, probes) accepted by this filter. If null,
all blades are retained.ClifException
public java.util.Properties getBladeProperties(java.lang.String testName, java.lang.String bladeId) throws ClifException
StorageRead
getBladeProperties
in interface StorageRead
testName
- the test run namebladeId
- the blade identifierClifException
TestDescriptor.getName()
,
BladeDescriptor.getId()
public java.lang.String[] getEventFieldLabels(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel)
StorageRead
getEventFieldLabels
in interface StorageRead
testName
- the test run namebladeId
- the blade identifier from the given test runeventTypeLabel
- the label of the event typepublic java.io.Serializable getEventIterator(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
StorageRead
getEventIterator
in interface StorageRead
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 foundStorageRead.getNextEvents(Serializable, int)
,
StorageRead.closeEventIterator(Serializable)
public BladeEvent[] getNextEvents(java.io.Serializable iteratorKey, int count) throws ClifException
StorageRead
getNextEvents
in interface StorageRead
iteratorKey
- the key for the target event iteratorcount
- the number of event to get (at most)ClifException
StorageRead.getEventIterator(String, String, String, EventFilter)
,
StorageRead.closeEventIterator(Serializable)
public void closeEventIterator(java.io.Serializable iteratorKey)
StorageRead
closeEventIterator
in interface StorageRead
iteratorKey
- the key for the target event iteratorpublic BladeEvent[] getEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter, long fromIndex, int count) throws ClifException
StorageRead
getEvents
in interface StorageRead
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
public long countEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
StorageRead
countEvents
in interface StorageRead
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
public java.util.SortedSet<java.lang.String> getTestsNames()
public java.util.SortedSet<java.lang.String> getBladesIds(java.lang.String testName)
public java.lang.Object[][] getBladeEventsValues(BladeEvent[] bladeEventList, java.lang.String xFieldLabel, java.lang.String yFieldLabel)
public BladeEvent[] getBladeEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.Object object)
public long getLifecycleCompleted(java.lang.String testName, java.lang.String bladeId)
public long getLifecycleRunning(java.lang.String testName, java.lang.String bladeId)
public java.lang.Object[][] getAllFieldsValues(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String xFieldLabel, java.lang.String yFieldLabel, int start, int end, int count)
public java.util.SortedSet<java.lang.String> getEventsTypeLabels(java.lang.String testName, java.lang.String bladeId)
public long getMinTimeFor(java.lang.String testName, java.lang.String bladeId)
public long getMaxTimeFor(java.lang.String testName, java.lang.String bladeId)
public java.util.List<BladeEvent> getBladeOneEventValues(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel)