com.marklogic.client.io

Class JacksonHandle

java.lang.Object

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

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

com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

com.marklogic.client.io.JacksonHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableHandle, ContentHandle<com.fasterxml.jackson.databind.JsonNode>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class JacksonHandle
extends com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>
implements ContentHandle<com.fasterxml.jackson.databind.JsonNode>, OutputStreamSender, BufferableHandle, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, SPARQLResultsReadHandle

An adapter for using the Jackson Open Source library for JSON; represents JSON content as a Jackson JsonNode for reading or writing. Enables reading and writing JSON documents, JSON structured search, and other JSON input and output.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
JacksonHandle() Zero-argument constructor.
JacksonHandle(com.fasterxml.jackson.databind.JsonNode content) Provides a handle on JSON content as a Jackson tree.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	get() Returns the root node of the JSON tree.
static ContentHandleFactory	newFactory() Creates a factory to create a JacksonHandle instance for a JSON node.
void	set(com.fasterxml.jackson.databind.JsonNode content) Assigns a JSON tree as the content.
JacksonHandle	with(com.fasterxml.jackson.databind.JsonNode content) Assigns a JSON tree as the content and returns the handle.
JacksonHandle	withFormat(Format format) Specifies the format of 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.impl.JacksonBaseHandle

fromBuffer, getMapper, setMapper, toBuffer, toString

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

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setFormat, 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

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

fromBuffer, toBuffer

Constructor Detail

JacksonHandle

public JacksonHandle()

Zero-argument constructor.

JacksonHandle

public JacksonHandle(com.fasterxml.jackson.databind.JsonNode content)

Provides a handle on JSON content as a Jackson tree.

Parameters:

content - the JSON root node of the tree.

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a JacksonHandle instance for a JSON node.

Returns:

the factory

withFormat

public JacksonHandle withFormat(Format format)

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

Parameters:

format - the format of the content

Returns:

this handle

get

public com.fasterxml.jackson.databind.JsonNode get()

Returns the root node of the JSON tree.

Specified by:

get in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

Returns:

the JSON root node.

set

public void set(com.fasterxml.jackson.databind.JsonNode content)

Assigns a JSON tree as the content.

Specified by:

set in interface ContentHandle<com.fasterxml.jackson.databind.JsonNode>

Specified by:

set in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

Parameters:

content - the JSON root node.

with

public JacksonHandle with(com.fasterxml.jackson.databind.JsonNode content)

Assigns a JSON tree as the content and returns the handle.

Parameters:

content - the JSON root node.

Returns:

the handle on the JSON tree.

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

Specified by:

write in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.databind.JsonNode>

Parameters:

out - the output stream receiving the content

Throws:

IOException - if io problems arise