com.marklogic.client.io

Class SourceHandle

java.lang.Object

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

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

com.marklogic.client.io.SourceHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, ContentHandle<Source>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender, Closeable, AutoCloseable

public class SourceHandle
extends BaseHandle<InputStream,OutputStreamSender>
implements OutputStreamSender, BufferableHandle, ContentHandle<Source>, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, Closeable

A Source Handle represents XML content as a transform source for reading or transforms a source into a result for writing.

Always call 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
SourceHandle() Zero-argument constructor.
SourceHandle(Source content) Initializes the handle with a transform source for the content.

Method Summary

Modifier and Type	Method and Description
void	close() Always call close() when finished with this handle – it closes the underlying InputStream.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
Source	get() Returns the transform source that produces the content.
Transformer	getTransformer() Returns a transformer for modifying the content.
static ContentHandleFactory	newFactory() Creates a factory to create a SourceHandle instance for a Transformer Source.
void	set(Source content) Assigns a transform source that produces the content.
void	setFormat(Format format) Restricts the format to XML.
void	setTransformer(Transformer transformer) Specifies a transformer for modifying the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
String	toString() Buffers the transform source and returns the buffer as a string.
void	transform(Result result) Transforms the source for the content output to the result.
SourceHandle	with(Source content) Assigns a transform source that produces the content and returns the handle as a fluent convenience.
SourceHandle	withMimetype(String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.
SourceHandle	withTransformer(Transformer transformer) Specifies a transformer for modifying the content and returns the handle as a fluent convenience.
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, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

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

getPointInTimeQueryTimestamp, setPointInTimeQueryTimestamp, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceHandle

public SourceHandle()

Zero-argument constructor.

SourceHandle

public SourceHandle(Source content)

Initializes the handle with a transform source for the content.

Parameters:

content - a transform source

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a SourceHandle instance for a Transformer Source.

Returns:

the factory

getTransformer

public Transformer getTransformer()

Returns a transformer for modifying the content.

Returns:

the transformer

setTransformer

public void setTransformer(Transformer transformer)

Specifies a transformer for modifying the content.

Parameters:

transformer - the transformer

withTransformer

public SourceHandle withTransformer(Transformer transformer)

Specifies a transformer for modifying the content and returns the handle as a fluent convenience.

Parameters:

transformer - the transformer

Returns:

this handle

get

public Source get()

Returns the transform source that produces the content.

Specified by:

get in interface ContentHandle<Source>

Returns:

the transform source

set

public void set(Source content)

Assigns a transform source that produces the content.

Specified by:

set in interface ContentHandle<Source>

Parameters:

content - the transform source

with

public SourceHandle with(Source content)

Assigns a transform source that produces the content and returns the handle as a fluent convenience.

Parameters:

content - the transform source

Returns:

this handle

transform

public void transform(Result result)

Transforms the source for the content output to the result. If the transformer is not specified, an identity transform sends the source to the result. When writing, the result is stored in the database

Parameters:

result - the receiver of the transform output

setFormat

public void setFormat(Format format)

Restricts the format to XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<InputStream,OutputStreamSender>

Parameters:

format - the format of the content

withMimetype

public SourceHandle withMimetype(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

toString

public String toString()

Buffers the transform source and returns the buffer 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 - if io problems arise

close

public void close()

Always call close() when finished with this handle – it closes the underlying InputStream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable