org.dizitart.no2.mapper

Class GenericMapper

java.lang.Object

org.dizitart.no2.mapper.AbstractMapper

org.dizitart.no2.mapper.GenericMapper

All Implemented Interfaces:

NitriteMapper

Direct Known Subclasses:

JacksonMapper

public class GenericMapper
extends AbstractMapper

A generic NitriteMapper implementation. It uses a MapperFacade implementation to convert an object into a Nitrite Document.

Since:

3.0.1

Constructor Summary

Constructors

Constructor and Description
GenericMapper(MapperFacade facade) Instantiate a new GenericMapper with a MapperFacade instance.

Method Summary

Modifier and Type	Method and Description
<T> Document	asDocumentInternal(T object) A child class must override this method for vendor specific serialization.
<T> T	asObjectInternal(Document document, java.lang.Class<T> type) A child class must override this method for vendor specific de-serialization.
java.lang.Object	asValue(java.lang.Object object) Tries to convert an object to a value type, which will be stored in the document.
MapperFacade	getMapperFacade() Gets the underlying MapperFacade instance to configure.
boolean	isValueType(java.lang.Object object) Determines if an object would be stored as a value type.

Methods inherited from class org.dizitart.no2.mapper.AbstractMapper

asDocument, asObject

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericMapper

public GenericMapper(MapperFacade facade)

Instantiate a new GenericMapper with a MapperFacade instance.

Parameters:

facade - a MapperFacade implementation

Method Detail

asDocumentInternal

public <T> Document asDocumentInternal(T object)

Description copied from class: AbstractMapper

A child class must override this method for vendor specific serialization.

Specified by:

asDocumentInternal in class AbstractMapper

Type Parameters:

T - the type parameter

Parameters:

object - the object

Returns:

the document

asObjectInternal

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

Description copied from class: AbstractMapper

A child class must override this method for vendor specific de-serialization.

Specified by:

asObjectInternal in class AbstractMapper

Type Parameters:

T - the type parameter

Parameters:

document - the document

type - the type

Returns:

the de-serialized object

isValueType

public boolean isValueType(java.lang.Object object)

Description copied from interface: NitriteMapper

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

Parameters:

object - the object to check

Returns:

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

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.

Parameters:

object - the object to convert

Returns:

the object as a value type.

getMapperFacade

public MapperFacade getMapperFacade()

Gets the underlying MapperFacade instance to configure.

Returns:

the facade instance.