com.googlecode.objectify.impl.translate

Class AbstractTranslator<T>

java.lang.Object

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

All Implemented Interfaces:

Translator<T>

Direct Known Subclasses:

ListNodeTranslator, MapNodeTranslator, PropertyValueNodeTranslator

public abstract class AbstractTranslator<T>
extends Object
implements Translator<T>

Very simple helper for all kinds of translators.

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Constructor and Description
AbstractTranslator()

Method Summary

Methods

Modifier and Type	Method and Description
T	load(Node node, LoadContext ctx) Loads the content of the specified node, returning the pojo equivalent.
protected abstract T	loadAbstract(Node node, LoadContext ctx) Implement loading
Node	save(T pojo, Path path, boolean index, SaveContext ctx) Translates the pojo into an EntityNode format.
protected abstract Node	saveAbstract(T pojo, Path path, boolean index, SaveContext ctx) Implement saving

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTranslator

public AbstractTranslator()

Method Detail

load

public final T load(Node node,
     LoadContext ctx)

Description copied from interface: Translator

Loads the content of the specified 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.

Specified by:

load in interface Translator<T>

Parameters:

node - is the part of the entity tree we are transforming.

ctx - holds state information during an entity load.

Returns:

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

See Also:

LoadEngine

save

public final Node save(T pojo,
        Path path,
        boolean index,
        SaveContext ctx)

Description copied from interface: Translator

Translates the pojo into an EntityNode format. Note that all stored values (even terminal properties) are associated with a node.

Specified by:

save in interface Translator<T>

Parameters:

pojo - is an object from the pojo entity graph; possibly the whole graph

path - is the path that the entitynode will be created with - the path to the pojo

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

Returns:

an EntityNode relevant to the pojo

loadAbstract

protected abstract T loadAbstract(Node node,
             LoadContext ctx)

Implement loading

saveAbstract

protected abstract Node saveAbstract(T pojo,
                Path path,
                boolean index,
                SaveContext ctx)

Implement saving