org.mongodb.morphia.mapping

Class EphemeralMappedField

java.lang.Object

org.mongodb.morphia.mapping.MappedField

org.mongodb.morphia.mapping.EphemeralMappedField

public class EphemeralMappedField
extends MappedField

This is a MappedField facade that allows us to convert and collect values to be gathered back in to a Map or Collection, e.g., rather than directly on a mapped entity. This are not mapped directly to a field on a class like MappedFields are.

Constructor Summary

Constructors

Constructor and Description
EphemeralMappedField(ParameterizedType t, MappedField mf, Mapper mapper)
EphemeralMappedField(Type t, MappedField mf, Mapper mapper)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnnotation(Class<? extends Annotation> clazz) Adds the annotation, if it exists on the field.
void	addAnnotation(Class<? extends Annotation> clazz, Annotation ann) Adds the annotation, if it exists on the field.
Object	getDbObjectValue(DBObject dbObj)
Object	getFieldValue(Object classInst) Returns the value stored in the java field
Class	getMapKeyClass() If the underlying java type is a map then it returns T from Map
protected String	getMappedFieldName() Returns the name of the field's key-name for mongodb
String	getNameToStore() Returns the name of the field's (key)name for mongodb
MappedField	getParent()
Class	getSubClass() If the java field is a list/array/map then the sub-type T is returned (ex.
Type	getSubType()
Class	getType() returns the type of the underlying java field
Object	getValue()
boolean	hasAnnotation(Class ann) Indicates whether the annotation is present in the mapping (does not check the java field annotations, just the ones discovered)
boolean	isSingleValue()
void	setFieldValue(Object classInst, Object val) Sets the value for the java field
String	toString()

Methods inherited from class org.mongodb.morphia.mapping.MappedField

addInterestingAnnotation, discover, discoverType, getAnnotation, getAnnotations, getConcreteType, getCTor, getDeclaringClass, getField, getFirstFieldName, getFullName, getJavaFieldName, getLoadNames, getMapper, getTypeParameters, isArray, isMap, isMultipleValues, isReference, isSet, isTypeMongoCompatible, putAnnotation, toClass

Methods inherited from class java.lang.Object

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

Constructor Detail

EphemeralMappedField

public EphemeralMappedField(ParameterizedType t,
                    MappedField mf,
                    Mapper mapper)

EphemeralMappedField

public EphemeralMappedField(Type t,
                    MappedField mf,
                    Mapper mapper)

Method Detail

getParent

public MappedField getParent()

addAnnotation

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

Description copied from class: MappedField

Adds the annotation, if it exists on the field.

Overrides:

addAnnotation in class MappedField

addAnnotation

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

Description copied from class: MappedField

Adds the annotation, if it exists on the field.

Overrides:

addAnnotation in class MappedField

getValue

public Object getValue()

getNameToStore

public String getNameToStore()

Description copied from class: MappedField

Returns the name of the field's (key)name for mongodb

Overrides:

getNameToStore in class MappedField

getDbObjectValue

public Object getDbObjectValue(DBObject dbObj)

Overrides:

getDbObjectValue in class MappedField

Returns:

the value from best mapping of this field

hasAnnotation

public boolean hasAnnotation(Class ann)

Description copied from class: MappedField

Indicates whether the annotation is present in the mapping (does not check the java field annotations, just the ones discovered)

Overrides:

hasAnnotation in class MappedField

toString

public String toString()

Overrides:

toString in class MappedField

getType

public Class getType()

Description copied from class: MappedField

returns the type of the underlying java field

Overrides:

getType in class MappedField

getMapKeyClass

public Class getMapKeyClass()

Description copied from class: MappedField

If the underlying java type is a map then it returns T from Map

Overrides:

getMapKeyClass in class MappedField

getSubType

public Type getSubType()

Overrides:

getSubType in class MappedField

getSubClass

public Class getSubClass()

Description copied from class: MappedField

If the java field is a list/array/map then the sub-type T is returned (ex. List, T[], Map

Overrides:

getSubClass in class MappedField

isSingleValue

public boolean isSingleValue()

Overrides:

isSingleValue in class MappedField

getFieldValue

public Object getFieldValue(Object classInst)

Description copied from class: MappedField

Returns the value stored in the java field

Overrides:

getFieldValue in class MappedField

setFieldValue

public void setFieldValue(Object classInst,
                 Object val)

Description copied from class: MappedField

Sets the value for the java field

Overrides:

setFieldValue in class MappedField

getMappedFieldName

protected String getMappedFieldName()

Description copied from class: MappedField

Returns the name of the field's key-name for mongodb

Overrides:

getMappedFieldName in class MappedField