io.crnk.jpa

Interface JpaRepositoryFilter

All Known Subinterfaces:

QuerydslRepositoryFilter

All Known Implementing Classes:

JpaRepositoryFilterBase, QuerydslRepositoryFilterBase

public interface JpaRepositoryFilter

Can be registered with the JpaModule and gets notified about all kinds of document events. The filter then has to possiblity to do all kinds of changes.

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.lang.Class<?> resourceType) Specifies whether any of the filter methods should be executed for the given resourceType.;
<T,I extends java.io.Serializable> JpaEntityRepository<T,I>	filterCreation(JpaEntityRepository<T,I> repository) Called when document is created.
<S,I extends java.io.Serializable,T,J extends java.io.Serializable> JpaRelationshipRepository<S,I,T,J>	filterCreation(JpaRelationshipRepository<S,I,T,J> repository) Called when document is created.
<T> JpaQueryExecutor<T>	filterExecutor(java.lang.Object repository, io.crnk.core.queryspec.QuerySpec querySpec, JpaQueryExecutor<T> executor) Allows to customize the query executor.
<T> JpaQuery<T>	filterQuery(java.lang.Object repository, io.crnk.core.queryspec.QuerySpec querySpec, JpaQuery<T> query) Allows to customize the query.
io.crnk.core.queryspec.QuerySpec	filterQuerySpec(java.lang.Object repository, io.crnk.core.queryspec.QuerySpec querySpec) Allows to customize the querySpec before creating the query.
<T> io.crnk.core.resource.list.ResourceList<T>	filterResults(java.lang.Object repository, io.crnk.core.queryspec.QuerySpec querySpec, io.crnk.core.resource.list.ResourceList<T> resources) Allows to filter resources and return the filtered list.
java.util.List<Tuple>	filterTuples(java.lang.Object repository, io.crnk.core.queryspec.QuerySpec querySpec, java.util.List<Tuple> tuples) Allows to filter tuples and return the filtered slistet.

Method Detail

filterCreation

<T,I extends java.io.Serializable> JpaEntityRepository<T,I> filterCreation(JpaEntityRepository<T,I> repository)

Called when document is created. Allows customizations and replacement.

Type Parameters:

T - document class

I - identifier class

Parameters:

repository - to filter

Returns:

filtered document

filterCreation

<S,I extends java.io.Serializable,T,J extends java.io.Serializable> JpaRelationshipRepository<S,I,T,J> filterCreation(JpaRelationshipRepository<S,I,T,J> repository)

Called when document is created. Allows customizations and replacement.

Type Parameters:

S - source document class

I - source identifier class

T - target document class

J - target identifier class

Parameters:

repository - to filter

Returns:

filtered document

accept

boolean accept(java.lang.Class<?> resourceType)

Specifies whether any of the filter methods should be executed for the given resourceType.;

Parameters:

resourceType - to filter

Returns:

true if filter should be used for the given resouceType.

filterQuerySpec

io.crnk.core.queryspec.QuerySpec filterQuerySpec(java.lang.Object repository,
                                                 io.crnk.core.queryspec.QuerySpec querySpec)

Allows to customize the querySpec before creating the query.

Parameters:

repository - where the query is executed

querySpec - to filter

Returns:

filtered querySpec

filterQuery

<T> JpaQuery<T> filterQuery(java.lang.Object repository,
                            io.crnk.core.queryspec.QuerySpec querySpec,
                            JpaQuery<T> query)

Allows to customize the query.

Type Parameters:

T - document class

Parameters:

repository - where the query is executed

querySpec - that is used to query

query - to filter

Returns:

filtered query

filterExecutor

<T> JpaQueryExecutor<T> filterExecutor(java.lang.Object repository,
                                       io.crnk.core.queryspec.QuerySpec querySpec,
                                       JpaQueryExecutor<T> executor)

Allows to customize the query executor.

Type Parameters:

T - document class

Parameters:

repository - where the query is executed

querySpec - that is used to query

executor - to filter

Returns:

filtered executor

filterTuples

java.util.List<Tuple> filterTuples(java.lang.Object repository,
                                   io.crnk.core.queryspec.QuerySpec querySpec,
                                   java.util.List<Tuple> tuples)

Allows to filter tuples and return the filtered slistet.

Parameters:

repository - where the query is executed

querySpec - that is used to query

tuples - to filter

Returns:

filtered list of tuples

filterResults

<T> io.crnk.core.resource.list.ResourceList<T> filterResults(java.lang.Object repository,
                                                             io.crnk.core.queryspec.QuerySpec querySpec,
                                                             io.crnk.core.resource.list.ResourceList<T> resources)

Allows to filter resources and return the filtered list.

Type Parameters:

T - document class

Parameters:

repository - where the query is executed

querySpec - that is used to query

resources - to filter

Returns:

filtered list of resources