EphemeralMappedField (Morphia 1.2.1-SNAPSHOT API)

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)` Creates an EphemeralMappedField.
`EphemeralMappedField(Type t, MappedField mf, Mapper mapper)` Creates an EphemeralMappedField.

Method Summary

All Methods Instance Methods Concrete 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 instance)` Gets the value of the field mapped on the instance given.
`Class`	`getMapKeyClass()` If the underlying java type is a map then it returns T from Map
`protected String`	`getMappedFieldName()`
`String`	`getNameToStore()`
`MappedField`	`getParent()`
`Class`	`getSubClass()` If the java field is a list/array/map then the sub-type T is returned (ex.
`Type`	`getSubType()` If the java field is a list/array/map then the sub-type T is returned (ex.
`Class`	`getType()`
`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 instance, 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, getTypeParameters, isArray, isMap, isMultipleValues, isReference, isSet, isTransient, 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)
```
    Creates an EphemeralMappedField.
    
    Parameters:
    
    t - the parameterized type of the field
    
    mf - the parent MappedField
    
    mapper - the Mapper to use
  - EphemeralMappedField
```
public EphemeralMappedField(Type t,
                            MappedField mf,
                            Mapper mapper)
```
    Creates an EphemeralMappedField.
    
    Parameters:
    
    t - the type of the field
    
    mf - the parent MappedField
    
    mapper - the Mapper to use
- Method Detail
  - 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
    
    Parameters:
    
    clazz - the annotation to add
  - 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
    
    Parameters:
    
    clazz - type of the annotation
    
    ann - the annotation
  - getDbObjectValue
```
public Object getDbObjectValue(DBObject dbObj)
```
    Overrides:
    
    getDbObjectValue in class MappedField
    
    Parameters:
    
    dbObj - the DBObject get the value from
    
    Returns:
    
    the value from best mapping of this field
  - getFieldValue
```
public Object getFieldValue(Object instance)
```
    Description copied from class: MappedField
    
    Gets the value of the field mapped on the instance given.
    
    Overrides:
    
    getFieldValue in class MappedField
    
    Parameters:
    
    instance - the instance to use
    
    Returns:
    
    the value stored in the java field
  - 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
    
    Returns:
    
    the type of the map key
  - getNameToStore
```
public String getNameToStore()
```
    Overrides:
    
    getNameToStore in class MappedField
    
    Returns:
    
    the name of the field's (key)name for mongodb
  - 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
    
    Returns:
    
    the parameterized type of the field
  - getSubType
```
public Type getSubType()
```
    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:
    
    getSubType in class MappedField
    
    Returns:
    
    the parameterized type of the field
  - getType
```
public Class getType()
```
    Overrides:
    
    getType in class MappedField
    
    Returns:
    
    the type of the underlying java 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
    
    Parameters:
    
    ann - the annotation to search for
    
    Returns:
    
    true if the annotation was found
  - isSingleValue
```
public boolean isSingleValue()
```
    Overrides:
    
    isSingleValue in class MappedField
    
    Returns:
    
    true if this field is not a container type such as a List, Map, Set, or array
  - setFieldValue
```
public void setFieldValue(Object instance,
                          Object val)
```
    Description copied from class: MappedField
    
    Sets the value for the java field
    
    Overrides:
    
    setFieldValue in class MappedField
    
    Parameters:
    
    instance - the instance to update
    
    val - the value to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class MappedField
  - getMappedFieldName
```
protected String getMappedFieldName()
```
    Overrides:
    
    getMappedFieldName in class MappedField
    
    Returns:
    
    the name of the field's key-name for mongodb
  - getParent
```
public MappedField getParent()
```
    Returns:
    
    the parent MappedField
  - getValue
```
public Object getValue()
```
    Returns:
    
    the value of the field

Class EphemeralMappedField

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

EphemeralMappedField

EphemeralMappedField

Method Detail

addAnnotation

addAnnotation

getDbObjectValue

getFieldValue

getMapKeyClass

getNameToStore

getSubClass

getSubType

getType

hasAnnotation

isSingleValue

setFieldValue

toString

getMappedFieldName

getParent

getValue