com.googlecode.objectify.impl

Interface EntityMetadata<T>

All Known Implementing Classes:

ConcreteEntityMetadata, PolymorphicEntityMetadata

public interface EntityMetadata<T>

The interface by which POJOs and datastore Entity objects are translated back and forth. Subclasses implement specific mapping, including polymorphic mapping.

Author:

Jeff Schnitzer

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getCacheExpirySeconds() Get the expiry associated with this kind, defined by the @Cached annotation.
Class<T>	getEntityClass() Gets the class associated with this entity.
KeyMetadata<T>	getKeyMetadata() Get specific metadata about the key for this type.
T	load(com.google.appengine.api.datastore.Entity ent, LoadContext ctx) Converts an entity to an object of the appropriate type for this metadata structure.
com.google.appengine.api.datastore.Entity	save(T pojo, SaveContext ctx) Converts an object to a datastore Entity with the appropriate Key type.

Method Detail

getCacheExpirySeconds

Integer getCacheExpirySeconds()

Get the expiry associated with this kind, defined by the @Cached annotation. For polymorphic types, this is always the instruction on the root @Entity - you cannot provide per-type caching.

Returns:

null means DO NOT CACHE, 0 means "no limit", otherwise # of seconds

load

T load(com.google.appengine.api.datastore.Entity ent,
     LoadContext ctx)

Converts an entity to an object of the appropriate type for this metadata structure. Does not check that the entity is appropriate; that should be done when choosing which EntityMetadata to call.

save

com.google.appengine.api.datastore.Entity save(T pojo,
                                             SaveContext ctx)

Converts an object to a datastore Entity with the appropriate Key type.

getEntityClass

Class<T> getEntityClass()

Gets the class associated with this entity.

getKeyMetadata

KeyMetadata<T> getKeyMetadata()

Get specific metadata about the key for this type.