Package 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, BufferableHandle, ContentHandle<org.dom4j.Document>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, 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 OutputStreamSender, BufferableHandle, ContentHandle<org.dom4j.Document>, 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	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	Description
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.
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.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream content)
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.
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 interface com.marklogic.client.io.marker.ContentHandle

getContentClass

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

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

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.

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

toString

public java.lang.String toString()

Returns the XML document as a string.

Overrides:

toString in class java.lang.Object

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