Package org.epics.archiverappliance.retrieval.client

Interface DataRetrievalForPVs

All Known Implementing Classes:

RawDataRetrievalAsEventStream

public interface DataRetrievalForPVs

Similar to the reader interface, this is the main retrieval interface. The main implementation is over a PB over HTTP .raw call to the server. This is a streaming interface in that data for multiple PVs are returned as part of the same EventStream. Out-of-band events (such as transitions into another PV's data) are passed as events on the RetrievalEventProcessor.

Author:

mshankar

See Also:

• DataRetrievalServlet
• Reader

Method Summary

Modifier and Type	Method	Description
EventStream	getDataForPVS(String[] pvNames, Instant startTime, Instant endTime, RetrievalEventProcessor retrievalEventProcessor)	Get data for multiple PVs from starttime to endtime.
EventStream	getDataForPVS(String[] pvNames, Instant startTime, Instant endTime, RetrievalEventProcessor retrievalEventProcessor, boolean useReducedDataSet)	Get data for multiple PVs from starttime to endtime.
EventStream	getDataForPVS(String[] pvNames, Instant startTime, Instant endTime, RetrievalEventProcessor retrievalEventProcessor, boolean useReducedDataSet, HashMap<String,String> otherParams)	Get data for multiple PVs from starttime to endtime.

Method Details

getDataForPVS

EventStream getDataForPVS(String[] pvNames,
 Instant startTime,
 Instant endTime,
 RetrievalEventProcessor retrievalEventProcessor)

Get data for multiple PVs from starttime to endtime. Pass out-of-band events into the supplied retrievalEventProcessor We default to getting raw data

Parameters:

pvNames - The name of PVs

startTime - Instant

endTime - Instant

retrievalEventProcessor - RetrievalEventProcessor

Returns:

EventStream Data for PVs  

getDataForPVS

EventStream getDataForPVS(String[] pvNames,
 Instant startTime,
 Instant endTime,
 RetrievalEventProcessor retrievalEventProcessor,
 boolean useReducedDataSet)

Get data for multiple PVs from starttime to endtime. Pass out-of-band events into the supplied retrievalEventProcessor

Parameters:

pvNames - The name of PVs

startTime - Instant

endTime - Instant

retrievalEventProcessor - RetrievalEventProcessor

useReducedDataSet - Is it ok to use a reduced data set?

Returns:

EventStream Data for PVs

getDataForPVS

EventStream getDataForPVS(String[] pvNames,
 Instant startTime,
 Instant endTime,
 RetrievalEventProcessor retrievalEventProcessor,
 boolean useReducedDataSet,
 HashMap<String,String> otherParams)

Get data for multiple PVs from starttime to endtime. Pass out-of-band events into the supplied retrievalEventProcessor

Parameters:

pvNames - The name of PVs

startTime - Instant

endTime - Instant

retrievalEventProcessor - RetrievalEventProcessor

useReducedDataSet - Is it ok to use a reduced data set?

otherParams - Any other name/value pairs that are passed onto the server.

Returns:

EventStream Data for PVs