com.marklogic.client.extra.dom4j

Class DOM4JHandle

java.lang.Object

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

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

com.marklogic.client.extra.dom4j.DOM4JHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<org.dom4j.Document,java.io.InputStream>, BufferableHandle, ContentHandle<org.dom4j.Document>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<org.dom4j.Document,java.io.InputStream>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class DOM4JHandle
extends BaseHandle<java.io.InputStream,OutputStreamSender>
implements ResendableContentHandle<org.dom4j.Document,java.io.InputStream>, OutputStreamSender, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle

A DOM4JHandle represents XML content as a dom4j document for reading or writing. You must install the dom4j library to use this class.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
DOM4JHandle() Zero-argument constructor.
DOM4JHandle(org.dom4j.Document content) Provides a handle on XML content as a dom4j document structure.

Method Summary

Modifier and Type	Method and Description
org.dom4j.Document	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
byte[]	contentToBytes(org.dom4j.Document 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.
org.dom4j.Document	get() Returns the XML document structure.
java.lang.Class<org.dom4j.Document>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
org.dom4j.io.OutputFormat	getOutputFormat() Returns the dom4j output format for serializing XML content.
org.dom4j.io.SAXReader	getReader() Returns the dom4j reader for XML content.
protected org.dom4j.io.SAXReader	makeReader()
static ContentHandleFactory	newFactory() Creates a factory to create a DOM4JHandle instance for a dom4j document.
DOM4JHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
DOM4JHandle[]	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 serialization)
protected OutputStreamSender	sendContent()
void	set(org.dom4j.Document content) Assigns an XML document structure as the content.
void	setFormat(Format format) Restricts the format to XML.
void	setOutputFormat(org.dom4j.io.OutputFormat outputFormat) Specifies the dom4j output format for serializing XML content.
void	setReader(org.dom4j.io.SAXReader reader) Specifies a dom4j reader for XML content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
org.dom4j.Document	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
java.lang.String	toString() Returns the XML document as a string.
DOM4JHandle	with(org.dom4j.Document content) Assigns an XML document structure as the content and returns the handle.
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.ResendableContentHandle

newHandle, resendableHandleFor

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

resendableHandleFor

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

newArray

Constructor Detail

DOM4JHandle

public DOM4JHandle()

Zero-argument constructor.

DOM4JHandle

public DOM4JHandle(org.dom4j.Document content)

Provides a handle on XML content as a dom4j document structure.

Parameters:

content - the XML document.

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a DOM4JHandle instance for a dom4j document.

Returns:

the factory

newHandle

public DOM4JHandle 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<org.dom4j.Document,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<org.dom4j.Document>

Specified by:

newHandle in interface ResendableContentHandle<org.dom4j.Document,java.io.InputStream>

Returns:

the new handle

newHandleArray

public DOM4JHandle[] 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<org.dom4j.Document,java.io.InputStream>

Specified by:

newHandleArray in interface ResendableContentHandle<org.dom4j.Document,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

getReader

public org.dom4j.io.SAXReader getReader()

Returns the dom4j reader for XML content.

Returns:

the dom4j reader.

setReader

public void setReader(org.dom4j.io.SAXReader reader)

Specifies a dom4j reader for XML content.

Parameters:

reader - the dom4j reader.

makeReader

protected org.dom4j.io.SAXReader makeReader()

getOutputFormat

public org.dom4j.io.OutputFormat getOutputFormat()

Returns the dom4j output format for serializing XML content.

Returns:

the output format.

setOutputFormat

public void setOutputFormat(org.dom4j.io.OutputFormat outputFormat)

Specifies the dom4j output format for serializing XML content.

Parameters:

outputFormat - the output format.

get

public org.dom4j.Document get()

Returns the XML document structure.

Specified by:

get in interface ContentHandle<org.dom4j.Document>

Returns:

the XML document.

set

public void set(org.dom4j.Document content)

Assigns an XML document structure as the content.

Specified by:

set in interface ContentHandle<org.dom4j.Document>

Parameters:

content - the XML document.

with

public DOM4JHandle with(org.dom4j.Document content)

Assigns an XML document structure as the content and returns the handle.

Parameters:

content - the XML document.

Returns:

the handle on the XML document.

getContentClass

public java.lang.Class<org.dom4j.Document> 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<org.dom4j.Document>

Returns:

the class for the handled content

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

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

bytesToContent

public org.dom4j.Document bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<org.dom4j.Document,java.io.InputStream>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(org.dom4j.Document content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<org.dom4j.Document,java.io.InputStream>

Parameters:

content - the content

Returns:

the byte serialization of the content

toString

public java.lang.String toString()

Returns the XML document as a string.

Overrides:

toString in class java.lang.Object

toContent

public org.dom4j.Document toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<org.dom4j.Document,java.io.InputStream>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

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 serialization)

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