com.marklogic.client.io

Class JacksonParserHandle

java.lang.Object

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

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

com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

com.marklogic.client.io.JacksonParserHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>, BufferableHandle, ContentHandle<com.fasterxml.jackson.core.JsonParser>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StreamingContentHandle<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>, StructureReadHandle, StructureWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, OutputStreamSender, java.io.Closeable, java.lang.AutoCloseable

public class JacksonParserHandle
extends com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>
implements OutputStreamSender, StreamingContentHandle<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>, JSONReadHandle, JSONWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, java.io.Closeable

An adapter for using the streaming capabilities of the Jackson Open Source library. Enables low-level efficient reading and writing of JSON documents.

Always call close() when finished with this handle to release the resources.

See Also:

Jackson Streaming API

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
JacksonParserHandle()

Method Summary

Modifier and Type	Method and Description
void	close() Always call close() when finished with this handle -- it closes the underlying InputStream.
com.fasterxml.jackson.core.JsonParser	get() JsonParser allows streaming access to content as it arrives.
java.lang.Class<com.fasterxml.jackson.core.JsonParser>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
com.fasterxml.jackson.databind.ObjectMapper	getMapper() Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.
protected boolean	hasContent()
com.fasterxml.jackson.core.JsonParser[]	newArray(int length) Constructs an array for the handled content representation
static ContentHandleFactory	newFactory() Creates a factory to create a JacksonParserHandle instance for a JsonParser.
JacksonParserHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
JacksonParserHandle[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected void	receiveContent(java.io.InputStream content)
protected OutputStreamSender	sendContent()
protected OutputStreamSender	sendContent(com.fasterxml.jackson.core.JsonParser parser)
void	set(com.fasterxml.jackson.core.JsonParser parser) Available for the edge case that content from a JsonParser must be written.
void	setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON.
com.fasterxml.jackson.core.JsonParser	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
JacksonParserHandle	with(com.fasterxml.jackson.core.JsonParser parser) Assigns the JsonParser and returns the handle.
JacksonParserHandle	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
JacksonParserHandle	withMimetype(java.lang.String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.
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.impl.JacksonBaseHandle

bytesToContent, contentToBytes, fromBuffer, receiveAs, 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, 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.StreamingContentHandle

resendableHandleFor

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

bytesToContent, contentToBytes, newHandle, resendableHandleFor

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

fromBuffer, toBuffer

Constructor Detail

JacksonParserHandle

public JacksonParserHandle()

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a JacksonParserHandle instance for a JsonParser.

Returns:

the factory

withFormat

public JacksonParserHandle 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

withMimetype

public JacksonParserHandle withMimetype(java.lang.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

get

public com.fasterxml.jackson.core.JsonParser get()

JsonParser allows streaming access to content as it arrives.

Specified by:

get in interface ContentHandle<com.fasterxml.jackson.core.JsonParser>

Specified by:

get in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

Returns:

the JsonParser over the content (usually received from the server)

set

public void set(com.fasterxml.jackson.core.JsonParser parser)

Available for the edge case that content from a JsonParser must be written.

Specified by:

set in interface ContentHandle<com.fasterxml.jackson.core.JsonParser>

Specified by:

set in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

Parameters:

parser - the JsonParser over the content to be written

with

public JacksonParserHandle with(com.fasterxml.jackson.core.JsonParser parser)

Assigns the JsonParser and returns the handle.

Parameters:

parser - the JsonParser over the content to be written

Returns:

this handle

getContentClass

public java.lang.Class<com.fasterxml.jackson.core.JsonParser> 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<com.fasterxml.jackson.core.JsonParser>

Returns:

the class for the handled content

newHandle

public JacksonParserHandle 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<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<com.fasterxml.jackson.core.JsonParser>

Returns:

the new handle

newHandleArray

public JacksonParserHandle[] 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<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

newArray

public com.fasterxml.jackson.core.JsonParser[] newArray(int length)

Description copied from interface: ContentHandle

Constructs an array for the handled content representation

Specified by:

newArray in interface ContentHandle<com.fasterxml.jackson.core.JsonParser>

Parameters:

length - the size of the array (zero or more)

Returns:

the constructed array

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.

Overrides:

getMapper in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

Returns:

the ObjectMapper instance

setMapper

public void setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON. For example:

ObjectMapper mapper = new CsvMapper();
mapper.configure(JsonGenerator.Feature.AUTO_CLOSE_TARGET, false);
mapper.configure(JsonParser.Feature.AUTO_CLOSE_SOURCE, false);
handle.setMapper(mapper);
 

Use at your own risk! Note that you most likely want to set to false the two options we demonstrate above (JsonGenerator.Feature.AUTO_CLOSE_TARGET and JsonParser.Feature.AUTO_CLOSE_SOURCE) as we do so your mapper will not close streams which we may need to reuse if we have to resend a network request.

Overrides:

setMapper in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

sendContent

protected OutputStreamSender sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

sendContent

protected OutputStreamSender sendContent(com.fasterxml.jackson.core.JsonParser parser)

Specified by:

sendContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

hasContent

protected boolean hasContent()

Specified by:

hasContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

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

toContent

public com.fasterxml.jackson.core.JsonParser toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<com.fasterxml.jackson.core.JsonParser,java.io.InputStream>

Specified by:

toContent in class com.marklogic.client.impl.JacksonBaseHandle<com.fasterxml.jackson.core.JsonParser>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

close

public void close()

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable