com.googlecode.objectify.impl.translate

Class EntityClassTranslator<T>

java.lang.Object

com.googlecode.objectify.impl.translate.AbstractTranslator<T>

com.googlecode.objectify.impl.translate.MapNodeTranslator<T>

com.googlecode.objectify.impl.translate.ClassTranslator<T>

com.googlecode.objectify.impl.translate.EntityClassTranslator<T>

All Implemented Interfaces:

KeyMetadata<T>, Translator<T>

public class EntityClassTranslator<T>
extends ClassTranslator<T>
implements KeyMetadata<T>

Translator which can maps the root of an entity. There is no factory associated with this; you just instantiate one as necessary.

Author:

Jeff Schnitzer

Field Summary

Fields inherited from class com.googlecode.objectify.impl.translate.ClassTranslator

clazz, fact, owners, props

Constructor Summary

Constructors

Constructor and Description
EntityClassTranslator(Type type, CreateContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	foundTranslatableProperty(TranslatableProperty<Object> tprop) Look for the id and parent properties
String	getIdFieldName()
Class<?>	getIdFieldType()
String	getKind()
String	getParentFieldName()
com.google.appengine.api.datastore.Key	getRawKey(T pojo) Gets a key composed of the relevant id and parent fields in the object.
boolean	hasParentField()
com.google.appengine.api.datastore.Entity	initEntity(T pojo) This hides all the messiness of trying to create an Entity from an object that:
boolean	isIdGeneratable()
void	setKey(T pojo, com.google.appengine.api.datastore.Key key, LoadContext ctx) Sets the key onto the POJO id/parent fields
void	setLongId(T pojo, Long id) Sets the numeric id field
boolean	shouldLoadParent(Set<Class<?>> enabledGroups)

Methods inherited from class com.googlecode.objectify.impl.translate.ClassTranslator

getTranslatedClass, loadMap, saveMap

Methods inherited from class com.googlecode.objectify.impl.translate.MapNodeTranslator

loadAbstract, saveAbstract

Methods inherited from class com.googlecode.objectify.impl.translate.AbstractTranslator

load, save

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityClassTranslator

public EntityClassTranslator(Type type,
                     CreateContext ctx)

Method Detail

foundTranslatableProperty

protected void foundTranslatableProperty(TranslatableProperty<Object> tprop)

Look for the id and parent properties

Overrides:

foundTranslatableProperty in class ClassTranslator<T>

getKind

public String getKind()

Specified by:

getKind in interface KeyMetadata<T>

Returns:

the datastore kind associated with this metadata

setKey

public void setKey(T pojo,
          com.google.appengine.api.datastore.Key key,
          LoadContext ctx)

Description copied from interface: KeyMetadata

Sets the key onto the POJO id/parent fields

Specified by:

setKey in interface KeyMetadata<T>

initEntity

public com.google.appengine.api.datastore.Entity initEntity(T pojo)

Description copied from interface: KeyMetadata

This hides all the messiness of trying to create an Entity from an object that:

• Might have a long id, might have a String name
• If it's a Long id, might be null and require autogeneration
• Might have a parent key

Specified by:

initEntity in interface KeyMetadata<T>

Returns:

an empty Entity object whose key has been set but no other properties.

getRawKey

public com.google.appengine.api.datastore.Key getRawKey(T pojo)

Description copied from interface: KeyMetadata

Gets a key composed of the relevant id and parent fields in the object.

Specified by:

getRawKey in interface KeyMetadata<T>

Parameters:

pojo - must be of the entityClass type for this metadata.

getParentFieldName

public String getParentFieldName()

Specified by:

getParentFieldName in interface KeyMetadata<T>

Returns:

the name of the parent field, or null if there wasn't one

getIdFieldName

public String getIdFieldName()

Specified by:

getIdFieldName in interface KeyMetadata<T>

Returns:

the name of the id field

getIdFieldType

public Class<?> getIdFieldType()

Specified by:

getIdFieldType in interface KeyMetadata<T>

Returns:

the java type of the id field; it will be either Long.class, Long.TYPE, or String.class

hasParentField

public boolean hasParentField()

Specified by:

hasParentField in interface KeyMetadata<T>

Returns:

true if the entity has a parent field

shouldLoadParent

public boolean shouldLoadParent(Set<Class<?>> enabledGroups)

Specified by:

shouldLoadParent in interface KeyMetadata<T>

Returns:

true if the parent should be loaded given the enabled fetch groups

isIdGeneratable

public boolean isIdGeneratable()

Specified by:

isIdGeneratable in interface KeyMetadata<T>

Returns:

true if the id field is uppercase-Long, which can be genearted.

setLongId

public void setLongId(T pojo,
             Long id)

Description copied from interface: KeyMetadata

Sets the numeric id field

Specified by:

setLongId in interface KeyMetadata<T>