com.googlecode.objectify.impl

Class PropertyPopulator<P,D>

java.lang.Object

com.googlecode.objectify.impl.PropertyPopulator<P,D>

All Implemented Interfaces:

Populator<P>

public class PropertyPopulator<P,D>
extends Object
implements Populator<P>

Associates a Property with a Translator and provides a more convenient interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected Property	property
protected Translator<P,D>	translator

Constructor Summary

Constructors

Constructor and Description
PropertyPopulator(Property prop, Translator<P,D> trans)

Method Summary

Modifier and Type	Method and Description
LoadConditions	getLoadConditions()
Property	getProperty()
D	getValue(Object pojo, SaveContext ctx, Path containerPath) Get the value for the property and translate it into datastore format.
void	load(com.google.appengine.api.datastore.PropertyContainer container, LoadContext ctx, Path containerPath, Object intoPojo) Gets the appropriate value from the container and sets it on the appropriate field of the pojo.
void	save(Object onPojo, boolean index, SaveContext ctx, Path containerPath, com.google.appengine.api.datastore.PropertyContainer into) Gets the appropriate field value from the pojo and puts it in the container at the appropriate prop name and with the appropriate indexing.
void	setValue(Object pojo, D value, LoadContext ctx, Path containerPath) Set this raw datastore value on the relevant property of the pojo, doing whatever translations are necessary.
String	toString() This is easier to debug if we have a string value

Methods inherited from class java.lang.Object

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

Field Detail

property

protected Property property

translator

protected Translator<P,D> translator

Constructor Detail

PropertyPopulator

public PropertyPopulator(Property prop,
                         Translator<P,D> trans)

Method Detail

getProperty

public Property getProperty()

getLoadConditions

public LoadConditions getLoadConditions()

toString

public String toString()

This is easier to debug if we have a string value

Overrides:

toString in class Object

load

public void load(com.google.appengine.api.datastore.PropertyContainer container,
                 LoadContext ctx,
                 Path containerPath,
                 Object intoPojo)

Gets the appropriate value from the container and sets it on the appropriate field of the pojo.

Specified by:

load in interface Populator<P>

Parameters:

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

ctx - holds state information during an entity load.

containerPath - is the current path to this translator

intoPojo - is an optional parameter; sometimes we need to create an object at a higher level and pass it down through a stack of translators. Most translators will ignore this, but some will have special behavior, for example, this allows collections to be recycled.

setValue

public void setValue(Object pojo,
                     D value,
                     LoadContext ctx,
                     Path containerPath)
              throws SkipException

Set this raw datastore value on the relevant property of the pojo, doing whatever translations are necessary.

Throws:

SkipException

save

public void save(Object onPojo,
                 boolean index,
                 SaveContext ctx,
                 Path containerPath,
                 com.google.appengine.api.datastore.PropertyContainer into)

Gets the appropriate field value from the pojo and puts it in the container at the appropriate prop name and with the appropriate indexing.

Specified by:

save in interface Populator<P>

Parameters:

onPojo - is the parent pojo which holds the property we represent

index - is the default state of indexing up to this point

containerPath - is the path to the container; each property will extend this path.

getValue

public D getValue(Object pojo,
                  SaveContext ctx,
                  Path containerPath)

Get the value for the property and translate it into datastore format.