com.marklogic.client.io

Class XMLStreamReaderHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<java.io.InputStream,OutputStreamSender>

com.marklogic.client.io.XMLStreamReaderHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>, BufferableHandle, ContentHandle<javax.xml.stream.XMLStreamReader>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StreamingContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender, java.io.Closeable, java.lang.AutoCloseable

public class XMLStreamReaderHandle
extends BaseHandle<java.io.InputStream,OutputStreamSender>
implements OutputStreamSender, StreamingContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, java.io.Closeable

An XML Stream Reader Handle represents XML content as an XML stream reader for reading as a StAX pull stream.

Either call close() or get().close() when finished with this handle to release the resources.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
XMLStreamReaderHandle() Zero-argument constructor.
XMLStreamReaderHandle(javax.xml.stream.XMLStreamReader content) Initializes the handle with a StAX stream reader for the content.

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.XMLStreamReader	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
void	close() Closes the XMLStreamReader and the InputStream, if any, used to populate the XMLStreamReader.
byte[]	contentToBytes(javax.xml.stream.XMLStreamReader content) Converts the content representation to bytes.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
javax.xml.stream.XMLStreamReader	get() Returns an XML Stream Reader for reading a resource from the database as a StAX pull stream.
java.lang.Class<javax.xml.stream.XMLStreamReader>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
javax.xml.stream.XMLInputFactory	getFactory() Returns the factory for parsing StAX streams.
javax.xml.stream.XMLResolver	getResolver() Returns the resolver for resolving references while parsing the event reader source.
protected javax.xml.stream.XMLInputFactory	makeXMLInputFactory()
javax.xml.stream.XMLStreamReader[]	newArray(int length) Constructs an array for the handled content representation
static ContentHandleFactory	newFactory() Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.
XMLStreamReaderHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
XMLStreamReaderHandle[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream content)
protected OutputStreamSender	sendContent()
void	set(javax.xml.stream.XMLStreamReader content) Assigns the stream reader for the content.
void	setFactory(javax.xml.stream.XMLInputFactory factory) Specifies the factory for parsing StAX streams.
void	setFormat(Format format) Restricts the format to XML.
void	setResolver(javax.xml.stream.XMLResolver resolver) Specifies the resolver for resolving references while parsing the event reader source.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
javax.xml.stream.XMLStreamReader	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
java.lang.String	toString() Buffers the StAX stream and returns the buffer as an XML string.
XMLStreamReaderHandle	with(javax.xml.stream.XMLStreamReader content) Assigns an stream reader for the content and returns the handle as a fluent convenience.
XMLStreamReaderHandle	withMimetype(java.lang.String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.
void	write(java.io.OutputStream out) Implements a callback to write content to the provided output stream for sending to the database server.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.client.io.marker.StreamingContentHandle

resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

newHandle, resendableHandleFor

Constructor Detail

XMLStreamReaderHandle

public XMLStreamReaderHandle()

Zero-argument constructor.

XMLStreamReaderHandle

public XMLStreamReaderHandle(javax.xml.stream.XMLStreamReader content)

Initializes the handle with a StAX stream reader for the content.

Parameters:

content - a StAX stream reader

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create an XMLStreamReaderHandle instance for a StAX stream reader.

Returns:

the factory

getResolver

public javax.xml.stream.XMLResolver getResolver()

Returns the resolver for resolving references while parsing the event reader source.

Returns:

the resolver

setResolver

public void setResolver(javax.xml.stream.XMLResolver resolver)

Specifies the resolver for resolving references while parsing the event reader source.

Parameters:

resolver - the reference resolver

get

public javax.xml.stream.XMLStreamReader get()

Returns an XML Stream Reader for reading a resource from the database as a StAX pull stream. When finished with the stream reader, call close() to release the response.

Specified by:

get in interface ContentHandle<javax.xml.stream.XMLStreamReader>

Returns:

the XML stream reader

set

public void set(javax.xml.stream.XMLStreamReader content)

Assigns the stream reader for the content.

Specified by:

set in interface ContentHandle<javax.xml.stream.XMLStreamReader>

Parameters:

content - a StAX stream reader

with

public XMLStreamReaderHandle with(javax.xml.stream.XMLStreamReader content)

Assigns an stream reader for the content and returns the handle as a fluent convenience.

Parameters:

content - a StAX stream reader

Returns:

this handle

getContentClass

public java.lang.Class<javax.xml.stream.XMLStreamReader> getContentClass()

Description copied from interface: ContentHandle

Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

Specified by:

getContentClass in interface ContentHandle<javax.xml.stream.XMLStreamReader>

Returns:

the class for the handled content

newHandle

public XMLStreamReaderHandle newHandle()

Description copied from interface: ContentHandle

Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

Specified by:

newHandle in interface BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<javax.xml.stream.XMLStreamReader>

Returns:

the new handle

newHandleArray

public XMLStreamReaderHandle[] newHandleArray(int length)

Description copied from interface: BufferableContentHandle

Constructs an uninitialized array with the specified length with items of the same content representation.

Specified by:

newHandleArray in interface BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

newArray

public javax.xml.stream.XMLStreamReader[] newArray(int length)

Description copied from interface: ContentHandle

Constructs an array for the handled content representation

Specified by:

newArray in interface ContentHandle<javax.xml.stream.XMLStreamReader>

Parameters:

length - the size of the array (zero or more)

Returns:

the constructed array

setFormat

public void setFormat(Format format)

Restricts the format to XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<java.io.InputStream,OutputStreamSender>

Parameters:

format - the format of the content

withMimetype

public XMLStreamReaderHandle withMimetype(java.lang.String mimetype)

Specifies the mime type of the content and returns the handle as a fluent convenience.

Parameters:

mimetype - the mime type of the content

Returns:

this handle

fromBuffer

public void fromBuffer(byte[] buffer)

Description copied from interface: BufferableHandle

Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

Specified by:

fromBuffer in interface BufferableHandle

Parameters:

buffer - the byte array

toBuffer

public byte[] toBuffer()

Description copied from interface: BufferableHandle

Copies the content of the handle to a byte array buffer encoded in UTF-8.

Specified by:

toBuffer in interface BufferableHandle

Returns:

the byte array

toContent

public javax.xml.stream.XMLStreamReader toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

bytesToContent

public javax.xml.stream.XMLStreamReader bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(javax.xml.stream.XMLStreamReader content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<javax.xml.stream.XMLStreamReader,java.io.InputStream>

Parameters:

content - the content

Returns:

the byte serialization of the content

close

public void close()

Closes the XMLStreamReader and the InputStream, if any, used to populate the XMLStreamReader. This method or get().close() should always be called when finished with the stream reader.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

toString

public java.lang.String toString()

Buffers the StAX stream and returns the buffer as an XML string.

Overrides:

toString in class java.lang.Object

getFactory

public javax.xml.stream.XMLInputFactory getFactory()

Returns the factory for parsing StAX streams.

Returns:

the StAX factory

setFactory

public void setFactory(javax.xml.stream.XMLInputFactory factory)

Specifies the factory for parsing StAX streams.

Parameters:

factory - the StAX factory

makeXMLInputFactory

protected javax.xml.stream.XMLInputFactory makeXMLInputFactory()

receiveAs

protected java.lang.Class<java.io.InputStream> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

sendContent

protected OutputStreamSender sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: OutputStreamSender

Implements a callback to write content to the provided output stream for sending to the database server.

Specified by:

write in interface OutputStreamSender

Parameters:

out - the output stream receiving the content

Throws:

java.io.IOException - if io problems arise