org.mongodb.morphia.mapping

Class MappedClass

java.lang.Object

org.mongodb.morphia.mapping.MappedClass

public class MappedClass
extends Object

Represents a mapped class between the MongoDB DBObject and the java POJO.

This class will validate classes to make sure they meet the requirement for persistence.

Author:

Scott Hernandez

Constructor Summary

Constructors

Constructor and Description
MappedClass(Class<?> clazz, Mapper mapper) Creates a MappedClass instance

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Class<? extends Annotation> clazz, Annotation ann) Adds the given Annotation to the internal list for the given Class.
static void	addInterestingAnnotation(Class<? extends Annotation> annotation) Adds an annotation for Morphia to retain when mapping.
protected void	basicValidate()
DBObject	callLifecycleMethods(Class<? extends Annotation> event, Object entity, DBObject dbObj, Mapper mapper) Call the lifecycle methods
boolean	containsJavaFieldName(String name) Check java field name that will be stored in mongodb
protected void	discover(Mapper mapper) Discovers interesting (that we care about) things about the class.
boolean	equals(Object o)
Annotation	getAnnotation(Class<? extends Annotation> clazz) Looks for an annotation of the type given
<T> List<T>	getAnnotations(Class<? extends Annotation> clazz) Looks for an annotation in the annotations found on a class while mapping
Class<?>	getClazz()
String	getCollectionName()
Embedded	getEmbeddedAnnotation()
Entity	getEntityAnnotation()
List<MappedField>	getFieldsAnnotatedWith(Class<? extends Annotation> clazz) Returns fields annotated with the clazz
Annotation	getFirstAnnotation(Class<? extends Annotation> clazz) Returns the first found Annotation, or null.
Field	getIdField()
List<org.mongodb.morphia.mapping.MappedClass.ClassMethodPair>	getLifecycleMethods(Class<Annotation> clazz) Gets the lifecycle methods for particular annotation.
MappedField	getMappedField(String storedName) Returns the MappedField by the name that it will stored in mongodb as
MappedField	getMappedFieldByJavaField(String name) Returns MappedField for a given java field name on the this MappedClass
MappedField	getMappedIdField()
MappedField	getMappedVersionField()
List<MappedField>	getPersistenceFields()
Map<Class<? extends Annotation>,List<Annotation>>	getRelevantAnnotations()
int	hashCode()
boolean	isInterface()
static boolean	isSupportedType(Class<?> clazz) Checks to see if it a Map/Set/List or a property supported by the MongoDB java driver
String	toString()
void	update() Update mappings based on fields/annotations.
void	validate(Mapper mapper) Validates this MappedClass

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MappedClass

public MappedClass(Class<?> clazz,
                   Mapper mapper)

Creates a MappedClass instance

Parameters:

clazz - the class to be mapped

mapper - the Mapper to use

Method Detail

isInterface

public boolean isInterface()

Returns:

true if the MappedClass is an interface

isSupportedType

public static boolean isSupportedType(Class<?> clazz)

Checks to see if it a Map/Set/List or a property supported by the MongoDB java driver

Parameters:

clazz - the type to check

Returns:

true if the type is supported

addInterestingAnnotation

public static void addInterestingAnnotation(Class<? extends Annotation> annotation)

Adds an annotation for Morphia to retain when mapping.

Parameters:

annotation - the type to retain

addAnnotation

public void addAnnotation(Class<? extends Annotation> clazz,
                          Annotation ann)

Adds the given Annotation to the internal list for the given Class.

Parameters:

clazz - the type to add

ann - the annotation to add

callLifecycleMethods

public DBObject callLifecycleMethods(Class<? extends Annotation> event,
                                     Object entity,
                                     DBObject dbObj,
                                     Mapper mapper)

Call the lifecycle methods

Parameters:

event - the lifecycle annotation

entity - the entity to process

dbObj - the dbObject to use

mapper - the Mapper to use

Returns:

dbObj

containsJavaFieldName

public boolean containsJavaFieldName(String name)

Check java field name that will be stored in mongodb

Parameters:

name - the name to search for

Returns:

true if a Java field with that name is found

getAnnotation

public Annotation getAnnotation(Class<? extends Annotation> clazz)

Looks for an annotation of the type given

Parameters:

clazz - the type to search for

Returns:

the instance if it was found, if more than one was found, the last one added

getAnnotations

public <T> List<T> getAnnotations(Class<? extends Annotation> clazz)

Looks for an annotation in the annotations found on a class while mapping

Type Parameters:

T - the type of annotation to find

Parameters:

clazz - the class to search for

Returns:

the instance if it was found, if more than one was found, the last one added

getClazz

public Class<?> getClazz()

Returns:

the clazz

getCollectionName

public String getCollectionName()

Returns:

the collName

getEmbeddedAnnotation

public Embedded getEmbeddedAnnotation()

Returns:

the embeddedAn

getEntityAnnotation

public Entity getEntityAnnotation()

Returns:

the entityAn

getFieldsAnnotatedWith

public List<MappedField> getFieldsAnnotatedWith(Class<? extends Annotation> clazz)

Returns fields annotated with the clazz

Parameters:

clazz - The Annotation to find.

Returns:

the list of fields

getFirstAnnotation

public Annotation getFirstAnnotation(Class<? extends Annotation> clazz)

Returns the first found Annotation, or null.

Parameters:

clazz - The Annotation to find.

Returns:

First found Annotation or null of none found.

getIdField

public Field getIdField()

Returns:

the idField

getLifecycleMethods

public List<org.mongodb.morphia.mapping.MappedClass.ClassMethodPair> getLifecycleMethods(Class<Annotation> clazz)

Gets the lifecycle methods for particular annotation.

Parameters:

clazz - the annotation to search with

Returns:

the list of methods

getMappedField

public MappedField getMappedField(String storedName)

Returns the MappedField by the name that it will stored in mongodb as

Parameters:

storedName - the name to search for

Returns:

true if that mapped field name is found

getMappedFieldByJavaField

public MappedField getMappedFieldByJavaField(String name)

Returns MappedField for a given java field name on the this MappedClass

Parameters:

name - the Java field name to search for

Returns:

the MappedField for the named Java field

getMappedIdField

public MappedField getMappedIdField()

Returns:

the ID field for the class

getMappedVersionField

public MappedField getMappedVersionField()

Returns:

the ID field for the class

getPersistenceFields

public List<MappedField> getPersistenceFields()

Returns:

the persistenceFields

getRelevantAnnotations

public Map<Class<? extends Annotation>,List<Annotation>> getRelevantAnnotations()

Returns:

the relevantAnnotations

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

update

public void update()

Update mappings based on fields/annotations.

validate

public void validate(Mapper mapper)

Validates this MappedClass

Parameters:

mapper - the Mapper to use for validation

basicValidate

protected void basicValidate()

discover

protected void discover(Mapper mapper)

Discovers interesting (that we care about) things about the class.