org.picketlink.idm.query.internal

Class DefaultIdentityQuery<T extends IdentityType>

java.lang.Object

org.picketlink.idm.query.internal.DefaultIdentityQuery<T>

Type Parameters:

T -

All Implemented Interfaces:

IdentityQuery<T>

public class DefaultIdentityQuery<T extends IdentityType>
extends Object
implements IdentityQuery<T>

Default IdentityQuery implementation.

Author:

Shane Bryzak

Constructor Summary

Constructors

Constructor and Description
DefaultIdentityQuery(IdentityQueryBuilder queryBuilder, IdentityContext context, Class<T> identityType, StoreSelector storeSelector)

Method Summary

Methods

Modifier and Type	Method and Description
Set<Condition>	getConditions() Returns a set containing all conditions used by this query to filter its results.
Class<T>	getIdentityType() The type used to create this query.
int	getLimit() Returns the number of instances to retrieve.
int	getOffset()
Object	getPaginationContext()
Object[]	getParameter(QueryParameter queryParameter) Returns the value used to restrict the given query parameter.
Map<QueryParameter,Object[]>	getParameters() Returns a map with all the parameter set for this query.
Map<QueryParameter,Object[]>	getParameters(Class<?> type)
int	getResultCount() Count of all query results.
List<T>	getResultList() Execute the query against the underlying identity stores and returns a list containing all instances of the type (defined when creating this query instance) that match the conditions previously specified.
Set<Sort>	getSorting() Returns a set containing all sorting conditions used to filter the results.
QueryParameter[]	getSortParameters()
boolean	isSortAscending()
IdentityQuery<T>	setLimit(int limit) Set the maximum number of results to retrieve.
IdentityQuery<T>	setOffset(int offset) Set the position of the first result to retrieve.
IdentityQuery<T>	setPaginationContext(Object object) Used for pagination models like LDAP when search will return some object (like cookie) for searching on next page
IdentityQuery<T>	setParameter(QueryParameter queryParameter, Object... value) Set a query parameter to this query in order to filter the results.
IdentityQuery<T>	setSortAscending(boolean sortAscending) Specify if sorting will be ascending (true) or descending (false)
IdentityQuery<T>	setSortParameters(QueryParameter... sortParameters) Parameters used to sort the results.
IdentityQuery<T>	sortBy(Sort... sorts) Add to this query the sorting conditions to be applied to the results.
IdentityQuery<T>	where(Condition... condition) Add to this query the conditions that will be used to filter results.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIdentityQuery

public DefaultIdentityQuery(IdentityQueryBuilder queryBuilder,
                    IdentityContext context,
                    Class<T> identityType,
                    StoreSelector storeSelector)

Method Detail

setParameter

public IdentityQuery<T> setParameter(QueryParameter queryParameter,
                            Object... value)

Description copied from interface: IdentityQuery

Set a query parameter to this query in order to filter the results.

This method always create an equality condition. For more conditions options take a look at IdentityQueryBuilder and use the IdentityQuery.where(Condition...) instead.

Specified by:

setParameter in interface IdentityQuery<T extends IdentityType>

Parameters:

queryParameter - The query parameter.

value - The value to match for equality.

Returns:

where

public IdentityQuery<T> where(Condition... condition)

Description copied from interface: IdentityQuery

Add to this query the conditions that will be used to filter results.

Any condition previously added to this query will be preserved and the new conditions added. If you want to clear the conditions you must create a new query instance.

Specified by:

where in interface IdentityQuery<T extends IdentityType>

Parameters:

condition - One or more conditions created from IdentityQueryBuilder.

Returns:

sortBy

public IdentityQuery<T> sortBy(Sort... sorts)

Description copied from interface: IdentityQuery

Add to this query the sorting conditions to be applied to the results.

Specified by:

sortBy in interface IdentityQuery<T extends IdentityType>

Parameters:

sorts - The ordering conditions.

Returns:

getSorting

public Set<Sort> getSorting()

Description copied from interface: IdentityQuery

Returns a set containing all sorting conditions used to filter the results.

Specified by:

getSorting in interface IdentityQuery<T extends IdentityType>

Returns:

getIdentityType

public Class<T> getIdentityType()

Description copied from interface: IdentityQuery

The type used to create this query.

Specified by:

getIdentityType in interface IdentityQuery<T extends IdentityType>

Returns:

getParameters

public Map<QueryParameter,Object[]> getParameters()

Description copied from interface: IdentityQuery

Returns a map with all the parameter set for this query.

Specified by:

getParameters in interface IdentityQuery<T extends IdentityType>

Returns:

getParameter

public Object[] getParameter(QueryParameter queryParameter)

Description copied from interface: IdentityQuery

Returns the value used to restrict the given query parameter.

Specified by:

getParameter in interface IdentityQuery<T extends IdentityType>

Returns:

getParameters

public Map<QueryParameter,Object[]> getParameters(Class<?> type)

Specified by:

getParameters in interface IdentityQuery<T extends IdentityType>

getLimit

public int getLimit()

Description copied from interface: IdentityQuery

Returns the number of instances to retrieve.

Specified by:

getLimit in interface IdentityQuery<T extends IdentityType>

Returns:

getOffset

public int getOffset()

Specified by:

getOffset in interface IdentityQuery<T extends IdentityType>

getPaginationContext

public Object getPaginationContext()

Specified by:

getPaginationContext in interface IdentityQuery<T extends IdentityType>

See Also:

IdentityQuery.setPaginationContext(Object object)

getSortParameters

public QueryParameter[] getSortParameters()

Specified by:

getSortParameters in interface IdentityQuery<T extends IdentityType>

See Also:

IdentityQuery.setSortParameters(QueryParameter...)

isSortAscending

public boolean isSortAscending()

Specified by:

isSortAscending in interface IdentityQuery<T extends IdentityType>

Returns:

true if sorting will be ascending

See Also:

IdentityQuery.setSortAscending(boolean)

getResultList

public List<T> getResultList()

Description copied from interface: IdentityQuery

Execute the query against the underlying identity stores and returns a list containing all instances of the type (defined when creating this query instance) that match the conditions previously specified.

Specified by:

getResultList in interface IdentityQuery<T extends IdentityType>

Returns:

getResultCount

public int getResultCount()

Description copied from interface: IdentityQuery

Count of all query results. It takes into account query parameters, but it doesn't take into account pagination parameter like offset and limit

Specified by:

getResultCount in interface IdentityQuery<T extends IdentityType>

Returns:

count of all query results

setOffset

public IdentityQuery<T> setOffset(int offset)

Description copied from interface: IdentityQuery

Set the position of the first result to retrieve.

Specified by:

setOffset in interface IdentityQuery<T extends IdentityType>

Returns:

setLimit

public IdentityQuery<T> setLimit(int limit)

Description copied from interface: IdentityQuery

Set the maximum number of results to retrieve.

Specified by:

setLimit in interface IdentityQuery<T extends IdentityType>

Parameters:

limit - the number of instances to retrieve.

Returns:

setSortParameters

public IdentityQuery<T> setSortParameters(QueryParameter... sortParameters)

Description copied from interface: IdentityQuery

Parameters used to sort the results. First parameter has biggest priority. For example: setSortParameter(User.LAST_NAME, User.FIRST_NAME) means that results will be sorted primarily by lastName and firstName will be used to sort only records with same lastName

Specified by:

setSortParameters in interface IdentityQuery<T extends IdentityType>

Parameters:

sortParameters - parameters to specify sort criteria

Returns:

this query

setSortAscending

public IdentityQuery<T> setSortAscending(boolean sortAscending)

Description copied from interface: IdentityQuery

Specify if sorting will be ascending (true) or descending (false)

Specified by:

setSortAscending in interface IdentityQuery<T extends IdentityType>

Parameters:

sortAscending - to specify if sorting will be ascending or descending

Returns:

this query

setPaginationContext

public IdentityQuery<T> setPaginationContext(Object object)

Description copied from interface: IdentityQuery

Used for pagination models like LDAP when search will return some object (like cookie) for searching on next page

Specified by:

setPaginationContext in interface IdentityQuery<T extends IdentityType>

Parameters:

object - to be used for search next page

Returns:

this query

getConditions

public Set<Condition> getConditions()

Description copied from interface: IdentityQuery

Returns a set containing all conditions used by this query to filter its results.

Specified by:

getConditions in interface IdentityQuery<T extends IdentityType>

Returns: