org.nuiton.topia

Interface TopiaJpaSupport

All Known Subinterfaces:

TopiaContext, TopiaContextImplementor

All Known Implementing Classes:

AbstractTopiaContext

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, Object... propertyNamesAndValues) Execute JPA-QL operation on data (Update, Delete).
<T> List<T>	find(String jpaql, int startIndex, int endIndex, Object... propertyNamesAndValues) Allow to do some JPA-QL query using the given bounds.
<T> List<T>	findAll(String jpaql, Object... propertyNamesAndValues) 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> T	findUnique(String jpaql, Object... propertyNamesAndValues) Allow to do some JPA-QL query and return an unique result.

Method Detail

findAll

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

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,
               Object... propertyNamesAndValues)

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,
               Object... propertyNamesAndValues)

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,
          Object... propertyNamesAndValues)

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.