org.nuiton.topia

Interface TopiaJpaSupport

All Known Subinterfaces:

TopiaContext, TopiaContextImplementor

All Known Implementing Classes:

AbstractTopiaContext, HibernateTopiaJpaSupport

public interface TopiaJpaSupport

This API provides methods to use persistence using JPA queries

Since:

3.0

Author:

Arnaud Thimel

Method Summary

Methods

Modifier and Type	Method and Description
int	execute(String jpaql, Map<String,Object> parameters) Execute JPA-QL operation on data (Update, Delete).
int	execute(String jpaql, Object... propertyNamesAndValues) Deprecated. prefer using execute(String, java.util.Map)
<T> List<T>	find(String jpaql, int startIndex, int endIndex, Map<String,Object> parameters) Allow to do some JPA-QL query using the given bounds.
<T> List<T>	find(String jpaql, int startIndex, int endIndex, Object... propertyNamesAndValues) Deprecated. prefer using find(String, int, int, java.util.Map)
<T> List<T>	findAll(String jpaql, Map<String,Object> parameters) Allow to do some JPA-QL query WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity
<T> List<T>	findAll(String jpaql, Object... propertyNamesAndValues) Deprecated. prefer using findAll(String, java.util.Map)
<T> T	findUnique(String jpaql, Map<String,Object> parameters) Allow to do some JPA-QL query and return an unique result.
<T> T	findUnique(String jpaql, Object... propertyNamesAndValues) Deprecated. prefer using findUnique(String, java.util.Map)
void	setUseFlushMode(boolean useFlushMode) Tells to the context if it has to use a flush mode before each query.

Method Detail

findAll

<T> List<T> findAll(String jpaql,
                  Map<String,Object> parameters)

Allow to do some JPA-QL query

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result list

findAll

@Deprecated
<T> List<T> findAll(String jpaql,
                             Object... propertyNamesAndValues)

Deprecated. prefer using findAll(String, java.util.Map)

Allow to do some JPA-QL query

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]

Returns:

The result list

find

<T> List<T> find(String jpaql,
               int startIndex,
               int endIndex,
               Map<String,Object> parameters)

Allow to do some JPA-QL query using the given bounds.

No lower bound : startIndex = 0.
No upper bound : endIndex = -1.

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

startIndex - first index of entity to return

endIndex - last index of entity to return

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result list

find

@Deprecated
<T> List<T> find(String jpaql,
                          int startIndex,
                          int endIndex,
                          Object... propertyNamesAndValues)

Deprecated. prefer using find(String, int, int, java.util.Map)

Allow to do some JPA-QL query using the given bounds.

No lower bound : startIndex = 0.
No upper bound : endIndex = -1.

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

startIndex - first index of entity to return

endIndex - last index of entity to return

propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]

Returns:

The result list

findUnique

<T> T findUnique(String jpaql,
               Map<String,Object> parameters)

Allow to do some JPA-QL query and return an unique result. If nothing if found by the query, will return null. If more than one result is found, will throw an exception.

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The result instance or null

findUnique

@Deprecated
<T> T findUnique(String jpaql,
                          Object... propertyNamesAndValues)

Deprecated. prefer using findUnique(String, java.util.Map)

Allow to do some JPA-QL query and return an unique result. If nothing if found by the query, will return null. If more than one result is found, will throw an exception.

WARNING : Depending on the registered service, this method may not support something else than queries on TopiaEntity

Parameters:

jpaql - the JPA-QL query

propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]

Returns:

The result instance or null

execute

int execute(String jpaql,
          Map<String,Object> parameters)

Execute JPA-QL operation on data (Update, Delete).

Parameters:

jpaql - the JPA-QL query

parameters - a map which keys are the attribute names and values are the attributes expected values

Returns:

The number of entities updated or deleted.

execute

@Deprecated
int execute(String jpaql,
                     Object... propertyNamesAndValues)

Deprecated. prefer using execute(String, java.util.Map)

Execute JPA-QL operation on data (Update, Delete).

Parameters:

jpaql - the JPA-QL query

propertyNamesAndValues - the query parameters. Arguments are key-value paired : [propertyName;value;propertyName;value;...]

Returns:

The number of entities updated or deleted.

setUseFlushMode

void setUseFlushMode(boolean useFlushMode)

Tells to the context if it has to use a flush mode before each query.

By default, we use a flush mode, but in some case it costs to much doing this, that's why you can disable it setting the value to false.

Parameters:

useFlushMode - the new value to set

Since:

2.5