com.marklogic.client.io

Class XQueryTypeHandle<T>

java.lang.Object

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

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

com.marklogic.client.io.XQueryTypeHandle<T>

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, ContentHandle<T>, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class XQueryTypeHandle<T>
extends BaseHandle<InputStream,OutputStreamSender>
implements OutputStreamSender, BufferableHandle, ContentHandle<T>, XMLReadHandle, XMLWriteHandle

Supports get/set of any type necessary for ServerEval but not handled by JAXBDatatypeHandle or DomNodeHandle. For now the only two types are java.net.URI and javax.xml.namespace.QName.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
XQueryTypeHandle(Class<T> clazz)
XQueryTypeHandle(QName xsType, T content) Initializes the handle with the content.

Method Summary

Methods

Modifier and Type	Method and Description
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
T	get() Returns the DOM Node for the content.
static ContentHandleFactory	newFactory() Creates a factory to create a DOMHandle instance for a DOM document.
void	set(T content) Assigns a DOM Node document as the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
String	toString() Returns the DOM Node as a string.
void	write(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, setByteLength, setFormat, setMimetype

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XQueryTypeHandle

public XQueryTypeHandle(Class<T> clazz)

XQueryTypeHandle

public XQueryTypeHandle(QName xsType,
                T content)

Initializes the handle with the content.

Parameters:

xsType - the localname part of the XML Schema type. The type must be one of:

   Sequence
   xs:anyURI
   

content - the java object. The type must be one of:

   java.util.List
   java.net.URI
   

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a DOMHandle instance for a DOM document.

Returns:

the factory

get

public T get()

Returns the DOM Node for the content.

Specified by:

get in interface ContentHandle<T>

Returns:

the DOM Node

set

public void set(T content)

Assigns a DOM Node document as the content.

Specified by:

set in interface ContentHandle<T>

Parameters:

content - a DOM Node

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

toString

public String toString()

Returns the DOM Node as a string.

Overrides:

toString in class Object

write

public void write(OutputStream out)
           throws 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:

IOException