com.googlecode.objectify.impl

Interface KeyMetadata<T>

All Known Implementing Classes:

EntityClassTranslator

public interface KeyMetadata<T>

Interface for mapping key/parent fields on pojo entities.

Author:

Jeff Schnitzer

Method Summary

Methods

Modifier and Type	Method and Description
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)

Method Detail

setKey

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

Sets the key onto the POJO id/parent fields

getKind

String getKind()

Returns:

the datastore kind associated with this metadata

initEntity

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

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

Returns:

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

getRawKey

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

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

Parameters:

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

Throws:

IllegalArgumentException - if pojo has a null id

getParentFieldName

String getParentFieldName()

Returns:

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

getIdFieldName

String getIdFieldName()

Returns:

the name of the id field

getIdFieldType

Class<?> getIdFieldType()

Returns:

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

hasParentField

boolean hasParentField()

Returns:

true if the entity has a parent field

shouldLoadParent

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

Returns:

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

isIdGeneratable

boolean isIdGeneratable()

Returns:

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

setLongId

void setLongId(T pojo,
             Long id)

Sets the numeric id field