com.mmnaseri.utils.spring.data.query

Interface QueryDescriptor

All Superinterfaces:

InvocationMatcher

All Known Implementing Classes:

DefaultQueryDescriptor

public interface QueryDescriptor
extends InvocationMatcher

This interface encapsulates everything that we can know about a query.

Since:

1.0 (9/17/15)

Author:

Milad Naseri (mmnaseri@programmer.net)

Method Summary

Modifier and Type	Method and Description
List<List<Parameter>>	getBranches()
RepositoryFactoryConfiguration	getConfiguration()
String	getFunction()
int	getLimit()
Page	getPage(Invocation invocation) Given an actual, runtime invocation, returns the page metadata for that invocation as per this query, or null if no pagination was indicated.
RepositoryMetadata	getRepositoryMetadata()
Sort	getSort(Invocation invocation) Given an actual, runtime invocation, returns the sort metadata for that invocation as per this qery, or returns null to indicate no ordering is required.
boolean	isDistinct()

Methods inherited from interface com.mmnaseri.utils.spring.data.domain.InvocationMatcher

matches

Method Detail

getConfiguration

RepositoryFactoryConfiguration getConfiguration()

Returns:

the repository factory configuration that were used when the current query was discovered

getRepositoryMetadata

RepositoryMetadata getRepositoryMetadata()

Returns:

metadata pertaining to the repository to which this query belongs

isDistinct

boolean isDistinct()

Returns:

whether query results are expected to be distinct

getFunction

String getFunction()

Returns:

the function name that should be applied to the entities selected as per this query. Could be null to indicate that no function should be applied.

getLimit

int getLimit()

Returns:

the maximum number of items this query is expected to return. A non-positive value indicates no limit.

getPage

Page getPage(Invocation invocation)

Given an actual, runtime invocation, returns the page metadata for that invocation as per this query, or null if no pagination was indicated.

Parameters:

invocation - the invocation

Returns:

the pagination metadata

getSort

Sort getSort(Invocation invocation)

Given an actual, runtime invocation, returns the sort metadata for that invocation as per this qery, or returns null to indicate no ordering is required.

Parameters:

invocation - the invocation

Returns:

the sort metadata

getBranches

List<List<Parameter>> getBranches()

Returns:

a list of decision branches which forms this query. Each decision branch is a set of conjunctive criteria about any single entity. This means to be evaluated to true, all of the parameters in that branch must match the entity. Decision branches are disjunctive towards each other, meaning that the moment one of them was evaluated to true the rest will be disregarded.