Package org.epics.archiverappliance.retrieval.channelarchiver

Class ArchiverValuesHandler

java.lang.Object

org.epics.archiverappliance.retrieval.channelarchiver.ArchiverValuesHandler

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Event>, Iterator<Event>, EventStream, XMLRPCStaxProcessor, RemotableOverRaw

public class ArchiverValuesHandler
extends Object
implements XMLRPCStaxProcessor, EventStream, Iterator<Event>, RemotableOverRaw

Quick handler to parse archiver.values returns. We use STAX to enable stream processing at least from this side of the socket...

Author:

mshankar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArchiverValuesHandler.ArchiverValuesType

Constructor Summary

Constructors

Constructor	Description
ArchiverValuesHandler(String pvName, InputStream is, String source, ArchDBRTypes expectedDBRType)	Create a archive.values handler given an event stream.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	endElement(String localName, String value)
RemotableEventStreamDesc	getDescription()
int	getElementCount()
HashMap<String,String>	getMetaInformation()
ArchiverValuesHandler.ArchiverValuesType	getValueType()
boolean	hasNext()	Do we have another event?
Iterator<Event>	iterator()
Event	next()	Get the next event
void	remove()
boolean	startElement(String localName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

ArchiverValuesHandler

public ArchiverValuesHandler(String pvName,
 InputStream is,
 String source,
 ArchDBRTypes expectedDBRType)
                      throws IOException

Create a archive.values handler given an event stream. If all goes well, processing should stop after each event (and hence should stop after the first event).

Parameters:

pvName - The name of PV

is - InputStream

source -  

expectedDBRType - This is the expected DBR type. This can be null in which case we do a best guess.

Throws:

IOException -  

Method Details

startElement

public boolean startElement(String localName)
                     throws IOException

Specified by:

startElement in interface XMLRPCStaxProcessor

Throws:

IOException

endElement

public boolean endElement(String localName,
 String value)
                   throws IOException

Specified by:

endElement in interface XMLRPCStaxProcessor

Throws:

IOException

hasNext

public boolean hasNext()

Do we have another event?

Specified by:

hasNext in interface Iterator<Event>

Returns:

boolean True or False

next

public Event next()

Get the next event

Specified by:

next in interface Iterator<Event>

Returns:

Event get the next event

getMetaInformation

public HashMap<String,String> getMetaInformation()

getValueType

public ArchiverValuesHandler.ArchiverValuesType getValueType()

getElementCount

public int getElementCount()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

iterator

public Iterator<Event> iterator()

Specified by:

iterator in interface Iterable<Event>

getDescription

public RemotableEventStreamDesc getDescription()

Specified by:

getDescription in interface EventStream

Specified by:

getDescription in interface RemotableOverRaw

remove

public void remove()

Specified by:

remove in interface Iterator<Event>