play.db.jpa

Class GenericModel

java.lang.Object

play.db.jpa.JPABase

play.db.jpa.GenericModel

All Implemented Interfaces:

Serializable, Model

Direct Known Subclasses:

JPASupport, Model

@MappedSuperclass
public class GenericModel
extends JPABase

A super class for JPA entities

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericModel.JPAQuery A JPAQuery

Nested classes/interfaces inherited from class play.db.jpa.JPABase

JPABase.JPAQueryException

Nested classes/interfaces inherited from interface play.db.Model

Model.BinaryField, Model.Choices, Model.Factory, Model.Manager, Model.Property

Field Summary

Fields inherited from class play.db.jpa.JPABase

willBeSaved

Constructor Summary

Constructors

Constructor and Description
GenericModel()

Method Summary

Modifier and Type	Method and Description
void	_saveAttachment()
void	_setupAttachment()
static GenericModel.JPAQuery	all() Prepare a query to find *all* entities.
static long	count() Count entities
static long	count(String query, Object... params) Count entities with a special query.
boolean	create() store (ie insert) the entity.
static <T extends JPABase> T	create(Class<?> type, String name, Map<String,String[]> params, Annotation[] annotations) Deprecated.
static <T extends JPABase> T	create(ParamNode rootParamNode, String name, Class<?> type, Annotation[] annotations)
static <T extends JPABase> T	create(String name, Scope.Params params)
<T extends JPABase> T	delete() Delete the entity.
static int	delete(String query, Object... params) Batch delete of entities
static int	deleteAll() Delete all entities
static <T extends JPABase> T	edit(Object o, String name, Map<String,String[]> params, Annotation[] annotations) Deprecated.
<T extends GenericModel> T	edit(ParamNode rootParamNode, String name)
static <T extends JPABase> T	edit(ParamNode rootParamNode, String name, Object o, Annotation[] annotations)
<T extends GenericModel> T	edit(String name, Map<String,String[]> params) Deprecated.
<T extends GenericModel> T	edit(String dbName, ParamNode rootParamNode, String name)
static <T extends JPABase> T	edit(String dbName, ParamNode rootParamNode, String name, Object o, Annotation[] annotations)
static GenericModel.JPAQuery	find(String query, Object... params) Prepare a query to find entities.
static <T extends JPABase> List<T>	findAll() Find all entities of this type
static <T extends JPABase> T	findById(Object id) Find the entity with the corresponding id.
<T extends JPABase> T	merge() Merge this object to obtain a managed entity (useful when the object comes from the Cache).
<T extends JPABase> T	refresh() Refresh the entity state.
<T extends JPABase> T	save() store (ie insert) the entity.
boolean	validateAndCreate()
boolean	validateAndSave()

Methods inherited from class play.db.jpa.JPABase

_delete, _key, _save, em, em, equals, getEntityId, hashCode, isPersistent, isPersistent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericModel

public GenericModel()

Method Detail

create

@Deprecated
public static <T extends JPABase> T create(Class<?> type,
                                                        String name,
                                                        Map<String,String[]> params,
                                                        Annotation[] annotations)

Deprecated.

This method is deprecated. Use this instead: public static <T extends JPABase> T create(ParamNode rootParamNode, String name, Class<?> type, Annotation[] annotations)

create

public static <T extends JPABase> T create(ParamNode rootParamNode,
                                           String name,
                                           Class<?> type,
                                           Annotation[] annotations)

edit

@Deprecated
public static <T extends JPABase> T edit(Object o,
                                                      String name,
                                                      Map<String,String[]> params,
                                                      Annotation[] annotations)

Deprecated.

This method is deprecated. Use this instead: public static <T extends JPABase> T edit(ParamNode rootParamNode, String name, Object o, Annotation[] annotations)

Returns:

the entity

See Also:

edit(ParamNode, String, Object, Annotation[])

edit

public static <T extends JPABase> T edit(ParamNode rootParamNode,
                                         String name,
                                         Object o,
                                         Annotation[] annotations)

edit

public static <T extends JPABase> T edit(String dbName,
                                         ParamNode rootParamNode,
                                         String name,
                                         Object o,
                                         Annotation[] annotations)

edit

@Deprecated
public <T extends GenericModel> T edit(String name,
                                                    Map<String,String[]> params)

Deprecated.

This method is deprecated. Use this instead: public <T extends GenericModel> T edit(ParamNode rootParamNode, String name)

edit

public <T extends GenericModel> T edit(ParamNode rootParamNode,
                                       String name)

edit

public <T extends GenericModel> T edit(String dbName,
                                       ParamNode rootParamNode,
                                       String name)

validateAndSave

public boolean validateAndSave()

validateAndCreate

public boolean validateAndCreate()

save

public <T extends JPABase> T save()

store (ie insert) the entity.

create

public boolean create()

store (ie insert) the entity.

refresh

public <T extends JPABase> T refresh()

Refresh the entity state.

merge

public <T extends JPABase> T merge()

Merge this object to obtain a managed entity (useful when the object comes from the Cache).

delete

public <T extends JPABase> T delete()

Delete the entity.

Returns:

The deleted entity.

create

public static <T extends JPABase> T create(String name,
                                           Scope.Params params)

count

public static long count()

Count entities

Returns:

number of entities of this class

count

public static long count(String query,
                         Object... params)

Count entities with a special query. Example : Long moderatedPosts = Post.count("moderated", true);

Parameters:

query - HQL query or shortcut

params - Params to bind to the query

Returns:

A long

findAll

public static <T extends JPABase> List<T> findAll()

Find all entities of this type

findById

public static <T extends JPABase> T findById(Object id)

Find the entity with the corresponding id.

Parameters:

id - The entity id

Returns:

The entity

find

public static GenericModel.JPAQuery find(String query,
                                         Object... params)

Prepare a query to find entities.

Parameters:

query - HQL query or shortcut

params - Params to bind to the query

Returns:

A JPAQuery

all

public static GenericModel.JPAQuery all()

Prepare a query to find *all* entities.

Returns:

A JPAQuery

delete

public static int delete(String query,
                         Object... params)

Batch delete of entities

Parameters:

query - HQL query or shortcut

params - Params to bind to the query

Returns:

Number of entities deleted

deleteAll

public static int deleteAll()

Delete all entities

Returns:

Number of entities deleted

_setupAttachment

public void _setupAttachment()

_saveAttachment

public void _saveAttachment()