org.dizitart.no2.mapper

Class JacksonFacade

java.lang.Object

org.dizitart.no2.mapper.JacksonFacade

All Implemented Interfaces:

MapperFacade, NitriteMapper

public class JacksonFacade
extends java.lang.Object
implements MapperFacade

A jackson based MapperFacade implementation. It uses jackson’s ObjectMapper to convert an object into a Nitrite Document.

Since:

3.0.1

Constructor Summary

Constructors

Constructor and Description
JacksonFacade() Instantiates a new JacksonFacade.
JacksonFacade(java.util.Set<com.fasterxml.jackson.databind.Module> modules) Instantiates a new JacksonFacade.

Method Summary

Modifier and Type	Method and Description
Document	asDocument(java.lang.Object object) Converts and object to a Document.
<T> T	asObject(Document document, java.lang.Class<T> type) Tries to convert a document to an object of type T.
java.lang.Object	asValue(java.lang.Object object) Tries to convert an object to a value type, which will be stored in the document.
protected com.fasterxml.jackson.databind.ObjectMapper	createObjectMapper() Creates a new jackson ObjectMapper.
protected com.fasterxml.jackson.databind.ObjectMapper	createObjectMapper(java.util.Set<com.fasterxml.jackson.databind.Module> modules) Creates a new jackson ObjectMapper and registers Module specified by modules.
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Gets the ObjectMapper.
boolean	isValueType(java.lang.Object object) Determines if an object would be stored as a value type.
Document	parse(java.lang.String json) Parses a json string into a nitrite Document.
java.lang.String	toJson(java.lang.Object object) Serializes an object to a json string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JacksonFacade

public JacksonFacade()

Instantiates a new JacksonFacade.

JacksonFacade

public JacksonFacade(java.util.Set<com.fasterxml.jackson.databind.Module> modules)

Instantiates a new JacksonFacade.

Parameters:

modules - jackson Module to register

Method Detail

createObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper createObjectMapper()

Creates a new jackson ObjectMapper.

Returns:

the object mapper

createObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper createObjectMapper(java.util.Set<com.fasterxml.jackson.databind.Module> modules)

Creates a new jackson ObjectMapper and registers Module specified by modules.

Parameters:

modules - jackson Module to register

Returns:

the object mapper

getObjectMapper

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

Gets the ObjectMapper.

Returns:

the object mapper

asDocument

public Document asDocument(java.lang.Object object)

Description copied from interface: NitriteMapper

Converts and object to a Document.

Specified by:

asDocument in interface NitriteMapper

Parameters:

object - the object

Returns:

the document

asObject

public <T> T asObject(Document document,
                      java.lang.Class<T> type)

Description copied from interface: NitriteMapper

Tries to convert a document to an object of type T.

Specified by:

asObject in interface NitriteMapper

Type Parameters:

T - the type parameter

Parameters:

document - the document

type - the type of the object

Returns:

the object

asValue

public java.lang.Object asValue(java.lang.Object object)

Description copied from interface: NitriteMapper

Tries to convert an object to a value type, which will be stored in the document.

As an example, a Date object is stored as a Long value in the document. This operation will return the long value of a Date object.

Specified by:

asValue in interface NitriteMapper

Parameters:

object - the object to convert

Returns:

the object as a value type.

isValueType

public boolean isValueType(java.lang.Object object)

Description copied from interface: NitriteMapper

Determines if an object would be stored as a value type.

Specified by:

isValueType in interface NitriteMapper

Parameters:

object - the object to check

Returns:

true of object would be stored as a value type; false otherwise.

parse

public Document parse(java.lang.String json)

Description copied from interface: MapperFacade

Parses a json string into a nitrite Document.

Specified by:

parse in interface MapperFacade

Parameters:

json - the json string to parse

Returns:

the document

toJson

public java.lang.String toJson(java.lang.Object object)

Description copied from interface: MapperFacade

Serializes an object to a json string

Specified by:

toJson in interface MapperFacade

Parameters:

object - the object

Returns:

the json string