org.apache.gora.mongodb.store

Class MongoMapping

java.lang.Object

org.apache.gora.mongodb.store.MongoMapping

public class MongoMapping
extends Object

Author:

Fabien Poulard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoMapping.DocumentFieldType Accepted types of data to be mapped in mongo based on BSON types

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG Helper to write useful information into the logs

Constructor Summary

Constructors

Constructor and Description
MongoMapping()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClassField(String docNameFromMapping, String classFieldName, String docFieldName, String fieldType) Register a new mapping between a field from the persisted class to a MongoDocument field.
String	getCollectionName() Getter for the name of the collection
String	getDocumentField(String field) Given a field from the persistence class, return the corresponding field in the document.
protected MongoMapping.DocumentFieldType	getDocumentFieldType(String field) Package private method to retrieve the type of a document field.
void	renameCollection(String oldName, String newName) Change the name of the collection.
void	setCollectionName(String collName) Setter for the name of the collection

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Helper to write useful information into the logs

Constructor Detail

MongoMapping

public MongoMapping()

Method Detail

renameCollection

public void renameCollection(String oldName,
                    String newName)

Change the name of the collection.

Parameters:

oldName - previous name

newName - new name to be used

getCollectionName

public String getCollectionName()

Getter for the name of the collection

setCollectionName

public void setCollectionName(String collName)

Setter for the name of the collection

addClassField

public void addClassField(String docNameFromMapping,
                 String classFieldName,
                 String docFieldName,
                 String fieldType)

Register a new mapping between a field from the persisted class to a MongoDocument field.

Parameters:

docNameFromMapping - name of the document as defined in the mapping

classFieldName - name of the field in the persisted class

docFieldName - name of the field in the mondo document

fieldType - type of the field

getDocumentField

public String getDocumentField(String field)

Given a field from the persistence class, return the corresponding field in the document.

Parameters:

field -

Returns:

getDocumentFieldType

protected MongoMapping.DocumentFieldType getDocumentFieldType(String field)

Package private method to retrieve the type of a document field.