com.mmnaseri.utils.spring.data.query.impl

Class DefaultQueryDescriptor

java.lang.Object

com.mmnaseri.utils.spring.data.query.impl.DefaultQueryDescriptor

All Implemented Interfaces:

InvocationMatcher, QueryDescriptor

public class DefaultQueryDescriptor
extends Object
implements QueryDescriptor

This is a mutable query descriptor that you can use to describe what a query does.

Since:

1.0 (9/20/15)

Author:

Milad Naseri (mmnaseri@programmer.net)

Constructor Summary

Constructors

Constructor and Description
DefaultQueryDescriptor(boolean distinct, String function, int limit, PageParameterExtractor pageExtractor, SortParameterExtractor sortExtractor, List<List<Parameter>> branches, RepositoryFactoryConfiguration configuration, RepositoryMetadata repositoryMetadata)

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()
boolean	matches(Object entity, Invocation invocation) Determines whether or not the entity matches the query
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultQueryDescriptor

public DefaultQueryDescriptor(boolean distinct,
                              String function,
                              int limit,
                              PageParameterExtractor pageExtractor,
                              SortParameterExtractor sortExtractor,
                              List<List<Parameter>> branches,
                              RepositoryFactoryConfiguration configuration,
                              RepositoryMetadata repositoryMetadata)

Method Detail

getConfiguration

public RepositoryFactoryConfiguration getConfiguration()

Specified by:

getConfiguration in interface QueryDescriptor

Returns:

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

getRepositoryMetadata

public RepositoryMetadata getRepositoryMetadata()

Specified by:

getRepositoryMetadata in interface QueryDescriptor

Returns:

metadata pertaining to the repository to which this query belongs

isDistinct

public boolean isDistinct()

Specified by:

isDistinct in interface QueryDescriptor

Returns:

whether query results are expected to be distinct

getFunction

public String getFunction()

Specified by:

getFunction in interface QueryDescriptor

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

public int getLimit()

Specified by:

getLimit in interface QueryDescriptor

Returns:

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

getPage

public Page getPage(Invocation invocation)

Description copied from interface: QueryDescriptor

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

Specified by:

getPage in interface QueryDescriptor

Parameters:

invocation - the invocation

Returns:

the pagination metadata

getSort

public Sort getSort(Invocation invocation)

Description copied from interface: QueryDescriptor

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.

Specified by:

getSort in interface QueryDescriptor

Parameters:

invocation - the invocation

Returns:

the sort metadata

getBranches

public List<List<Parameter>> getBranches()

Specified by:

getBranches in interface QueryDescriptor

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.

matches

public boolean matches(Object entity,
                       Invocation invocation)

Description copied from interface: InvocationMatcher

Determines whether or not the entity matches the query

Specified by:

matches in interface InvocationMatcher

Parameters:

entity - the entity

invocation - the query method invocation

Returns:

true if it was a match

toString

public String toString()

Overrides:

toString in class Object