org.daisy.common.transform

Class XMLInputValue<V>

java.lang.Object

org.daisy.common.transform.InputValue<V>

org.daisy.common.transform.XMLInputValue<V>

public class XMLInputValue<V>
extends InputValue<V>

A supplier of a XDM value that is a sequence of nodes, or an "external" item that can be marshaled to a sequence of nodes.

This interface has several sub-interfaces. Instances may implement one or more of them:

• XMLEventReader
• XMLStreamReader
• Iterator<Node>

InputValue.asObject() will throw a UnsupportedOperationException unless the value is an external item.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	sequence
protected BaseURIAwareXMLStreamReader	streamReader

Constructor Summary

Constructors

Modifier	Constructor and Description
	XMLInputValue(BaseURIAwareXMLStreamReader value)
	XMLInputValue(Iterator<? extends Node> value)
protected	XMLInputValue(Iterator<? extends Node> value, boolean sequence)
protected	XMLInputValue(XMLInputValue<V> value, boolean sequence)

Method Summary

Modifier and Type	Method and Description
Iterator<Node>	asNodeIterator() A sequence of nodes as a Iterator<Node>.
XMLEventReader	asXMLEventReader() A stream of XML events as a XMLEventReader.
BaseURIAwareXMLStreamReader	asXMLStreamReader() A stream of XML events as a XMLStreamReader.
XMLInputValue<V>	ensureSingleItem() Ensure that the number of items in the sequence is exactly one.
protected static <V> Iterator<V>	ensureSingleItem(Iterator<V> iterator)
Mult<? extends XMLInputValue<V>>	mult(int limit) Make multiples of this input.
protected boolean	valueSupplied()

Methods inherited from class org.daisy.common.transform.InputValue

asObject, asObject, cache, iteratorOf, toString

Methods inherited from class java.lang.Object

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

Field Detail

streamReader

protected BaseURIAwareXMLStreamReader streamReader

sequence

protected final boolean sequence

Constructor Detail

XMLInputValue

public XMLInputValue(BaseURIAwareXMLStreamReader value)

XMLInputValue

public XMLInputValue(Iterator<? extends Node> value)

XMLInputValue

protected XMLInputValue(Iterator<? extends Node> value,
                        boolean sequence)

XMLInputValue

protected XMLInputValue(XMLInputValue<V> value,
                        boolean sequence)

Method Detail

asXMLStreamReader

public BaseURIAwareXMLStreamReader asXMLStreamReader()
                                              throws UnsupportedOperationException,
                                                     NoSuchElementException

A stream of XML events as a XMLStreamReader.

Throws:

UnsupportedOperationException

NoSuchElementException

asXMLEventReader

public XMLEventReader asXMLEventReader()
                                throws UnsupportedOperationException,
                                       NoSuchElementException

A stream of XML events as a XMLEventReader.

Throws:

UnsupportedOperationException

NoSuchElementException

asNodeIterator

public Iterator<Node> asNodeIterator()
                              throws UnsupportedOperationException,
                                     NoSuchElementException

A sequence of nodes as a Iterator<Node>.

Throws:

UnsupportedOperationException

NoSuchElementException

mult

public Mult<? extends XMLInputValue<V>> mult(int limit)

Description copied from class: InputValue

Make multiples of this input.

Overrides:

mult in class InputValue<V>

Parameters:

limit - The maximum number of multiples that will be made. -1 means unlimited.

ensureSingleItem

public XMLInputValue<V> ensureSingleItem()

Ensure that the number of items in the sequence is exactly one.

valueSupplied

protected boolean valueSupplied()

Overrides:

valueSupplied in class InputValue<V>

ensureSingleItem

protected static <V> Iterator<V> ensureSingleItem(Iterator<V> iterator)