net.sf.saxon.evpull

Class BracketedElementIterator

public class BracketedElementIterator extends Object implements EventIterator

The class is an EventIterator that handles the events arising from an element constructor: that is, the start/end event pair for the element node, bracketing a sequence of events for the content of the element.

This class does not normalize the content (for example by merging adjacent text nodes). That is the job of the ComplexContentProcessor.

The event stream consumed by a BracketedElementIterator may contain freestanding attribute and namespace nodes. The event stream delivered by a BracketedElementIterator, however, packages all attributes and namespaces as part of the startElement event.

Constructor Summary
BracketedElementIterator(StartElementEvent start, EventIterator content, EndElementEvent end)
Constructor
Method Summary
booleanisFlatSequence()
Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators
PullEventnext()
Get the next event in the sequence

Constructor Detail

BracketedElementIterator

public BracketedElementIterator(StartElementEvent start, EventIterator content, EndElementEvent end)
Constructor

Parameters: start the StartElementEvent object content iterator that delivers the content of the element end the EndElementEvent object

Method Detail

isFlatSequence

public boolean isFlatSequence()
Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators

Returns: true if the next() method is guaranteed never to return an EventIterator

next

public PullEvent next()
Get the next event in the sequence

Returns: the next event, or null when the sequence is exhausted

Throws: XPathException if a dynamic evaluation error occurs