Package com.googlecode.objectify.impl.translate

Class EntityCreator<P>

java.lang.Object

com.googlecode.objectify.impl.translate.Creator<P>

com.googlecode.objectify.impl.translate.EntityCreator<P>

All Implemented Interfaces:

Translator<P,com.google.appengine.api.datastore.PropertyContainer>

public class EntityCreator<P>
extends Creator<P>

This version is for creating entity objects, which could be embedded or top-level.

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Constructor	Description
EntityCreator(Class<P> clazz, Forge forge, KeyMetadata<P> keyMetadata)

Method Summary

Modifier and Type	Method	Description
KeyMetadata<P>	getKeyMetadata()
P	load(com.google.appengine.api.datastore.PropertyContainer container, LoadContext ctx, Path path)	Loads the content of the specified datastore node, returning the pojo equivalent.
com.google.appengine.api.datastore.PropertyContainer	save(P pojo, boolean index, SaveContext ctx, Path path)	Translates a pojo (or some component thereof) into a format suitable for storage in the datastore.

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

construct

Methods inherited from class java.lang.Object

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

Constructor Details

EntityCreator

public EntityCreator(Class<P> clazz,
 Forge forge,
 KeyMetadata<P> keyMetadata)

Method Details

getKeyMetadata

public KeyMetadata<P> getKeyMetadata()

load

public P load(com.google.appengine.api.datastore.PropertyContainer container,
 LoadContext ctx,
 Path path)
       throws SkipException

Description copied from interface: Translator

Loads the content of the specified datastore node, returning the pojo equivalent.

There is one special return value: If a Result is returned, the content of the Result will be used instead, but delayed until ctx.done() is called. This happens at the end of a "round" of load operations and is the magic trick that makes populating entity references work efficiently.

Parameters:

container - is the part of the native datastore entity tree we are transforming.

ctx - holds state information during an entity load.

path - is the current path to this translator

Returns:

an assembled pojo corresponding to the node subtree; if null is returned, that is the real value!

Throws:

SkipException - if the return value should be abandoned.

See Also:

LoadEngine

save

public com.google.appengine.api.datastore.PropertyContainer save(P pojo,
 boolean index,
 SaveContext ctx,
 Path path)
                                                          throws SkipException

Description copied from interface: Translator

Translates a pojo (or some component thereof) into a format suitable for storage in the datastore.

Parameters:

pojo - is an object from the pojo entity graph; possibly the whole graph or possibly just a leaf field.

index - is whether the instruction so far is to index or not index property values

path - is the path that we have taken to get here, which could be long due to re-entrant translators (ie, an embedded pojo that also has a reference to the same class).

Returns:

something suitable for storage in the datastore.

Throws:

SkipException - if the return value should be abandoned