org.treetank.service.xml.serialize

Class StAXSerializer

java.lang.Object

org.treetank.service.xml.serialize.StAXSerializer

All Implemented Interfaces:

Iterator, XMLEventReader

public final class StAXSerializer
extends Object
implements XMLEventReader

StAXSerializer

Provides a StAX implementation (event API) for retrieving a Treetank database.

Author:

Johannes Lichtenberger, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
StAXSerializer(AbsAxis paramAxis, INodeReadTrx pRtx) Initialize XMLStreamReader implementation with transaction.
StAXSerializer(AbsAxis paramAxis, INodeReadTrx pRtx, boolean paramCloseRtx) Initialize XMLStreamReader implementation with transaction.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
String	getElementText()
Object	getProperty(String mName)
boolean	hasNext()
Object	next() Just calls nextEvent().
XMLEvent	nextEvent()
XMLEvent	nextTag()
XMLEvent	peek()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

StAXSerializer

public StAXSerializer(AbsAxis paramAxis,
              INodeReadTrx pRtx)

Initialize XMLStreamReader implementation with transaction. The cursor points to the node the XMLStreamReader starts to read. Do not serialize the tank ids.

Parameters:

paramAxis - AbsAxis which is used to iterate over and generate StAX events.

StAXSerializer

public StAXSerializer(AbsAxis paramAxis,
              INodeReadTrx pRtx,
              boolean paramCloseRtx)

Initialize XMLStreamReader implementation with transaction. The cursor points to the node the XMLStreamReader starts to read. Do not serialize the tank ids.

Parameters:

paramAxis - AbsAxis which is used to iterate over and generate StAX events.

paramCloseRtx - Determines if rtx should be closed afterwards.

Method Detail

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLEventReader

Throws:

XMLStreamException

getElementText

public String getElementText()
                      throws XMLStreamException

Specified by:

getElementText in interface XMLEventReader

Throws:

XMLStreamException

getProperty

public Object getProperty(String mName)

Specified by:

getProperty in interface XMLEventReader

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator

Specified by:

hasNext in interface XMLEventReader

nextEvent

public XMLEvent nextEvent()
                   throws XMLStreamException

Specified by:

nextEvent in interface XMLEventReader

Throws:

XMLStreamException

nextTag

public XMLEvent nextTag()
                 throws XMLStreamException

Specified by:

nextTag in interface XMLEventReader

Throws:

XMLStreamException

peek

public XMLEvent peek()
              throws XMLStreamException

Specified by:

peek in interface XMLEventReader

Throws:

XMLStreamException

next

public Object next()

Just calls nextEvent().

Specified by:

next in interface Iterator

Returns:

next event.

remove

public void remove()

Specified by:

remove in interface Iterator