com.atlassian.crowd.search.query.entity

Class EntityQuery<T>

java.lang.Object

com.atlassian.crowd.search.query.entity.EntityQuery<T>

All Implemented Interfaces:

Query<T>

Direct Known Subclasses:

AliasQuery, ApplicationQuery, AuthenticatedTokenQuery, DirectoryQuery, GroupQuery, TokenQuery, UserQuery

public abstract class EntityQuery<T>
extends Object
implements Query<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_RESULTS Flag to indicate that an EntityQuery should retrieve all results.
static int	MAX_MAX_RESULTS This is the recommended maximum number of 'max' results the system will allow you to return.

Constructor Summary

Constructors

Constructor and Description
EntityQuery(Class<T> returnType, EntityDescriptor entityDescriptor, SearchRestriction searchRestriction, int startIndex, int maxResults)
EntityQuery(EntityQuery<T> query, int startIndex, int maxResults)
EntityQuery(EntityQuery query, Class<T> returnType)

Method Summary

Modifier and Type	Method and Description
EntityQuery<T>	addToMaxResults(int add)
static int	addToMaxResults(int maxResults, int add) Simple utility method that increases or decreases the result limit and deals with ALL_RESULTS, overflow and prevents negative values.
static long	allResultsToLongMax(int maxResults) Converts max results limit to long value - replaces ALL_RESULTS with Long.MAX_VALUE}.
EntityQuery<T>	baseSplitQuery()
boolean	equals(Object o)
EntityDescriptor	getEntityDescriptor()
int	getMaxResults()
Class<T>	getReturnType()
SearchRestriction	getSearchRestriction()
int	getStartIndex()
boolean	hasAllResults()
int	hashCode()
Optional<List<EntityQuery<T>>>	splitOrRestrictionIfNeeded(int maxSize) Splits the query if needed.
String	toString()
EntityQuery<T>	withAllResults()
EntityQuery<T>	withMaxResults(int maxResults)
<Q> EntityQuery<Q>	withReturnType(Class<Q> returnType)
EntityQuery<T>	withSearchRestriction(SearchRestriction searchRestriction)
EntityQuery<T>	withStartIndex(int startIndex)
EntityQuery<T>	withStartIndexAndMaxResults(int startIndex, int maxResults)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_MAX_RESULTS

public static final int MAX_MAX_RESULTS

This is the recommended maximum number of 'max' results the system will allow you to return. This value is NOT enforced. ApplicationServiceGeneric often retrieves (startIndex + maxResults) number of results which breaks this MAX_MAX_RESULTS.

See Also:

Constant Field Values

ALL_RESULTS

public static final int ALL_RESULTS

Flag to indicate that an EntityQuery should retrieve all results.

WARNING: using this flag could retrieve thousands or millions of entities. Misuse can cause massive performance problems. This flag should only ever be used in exceptional circumstances.

If you need to find "all" entities, then consider making multiple successive calls to Crowd to receive partial results. That way, the entire result set is never stored in memory on the Crowd server at any one time.

See Also:

Constant Field Values

Constructor Detail

EntityQuery

public EntityQuery(Class<T> returnType,
                   EntityDescriptor entityDescriptor,
                   SearchRestriction searchRestriction,
                   int startIndex,
                   int maxResults)

EntityQuery

public EntityQuery(EntityQuery query,
                   Class<T> returnType)

EntityQuery

public EntityQuery(EntityQuery<T> query,
                   int startIndex,
                   int maxResults)

Method Detail

getEntityDescriptor

public EntityDescriptor getEntityDescriptor()

getSearchRestriction

public SearchRestriction getSearchRestriction()

Specified by:

getSearchRestriction in interface Query<T>

getStartIndex

public int getStartIndex()

Specified by:

getStartIndex in interface Query<T>

getMaxResults

public int getMaxResults()

Specified by:

getMaxResults in interface Query<T>

getReturnType

public Class<T> getReturnType()

Specified by:

getReturnType in interface Query<T>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

addToMaxResults

public static int addToMaxResults(int maxResults,
                                  int add)

Simple utility method that increases or decreases the result limit and deals with ALL_RESULTS, overflow and prevents negative values.

allResultsToLongMax

public static long allResultsToLongMax(int maxResults)

Converts max results limit to long value - replaces ALL_RESULTS with Long.MAX_VALUE}.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

withReturnType

public <Q> EntityQuery<Q> withReturnType(Class<Q> returnType)

withStartIndex

public EntityQuery<T> withStartIndex(int startIndex)

withMaxResults

public EntityQuery<T> withMaxResults(int maxResults)

withStartIndexAndMaxResults

public EntityQuery<T> withStartIndexAndMaxResults(int startIndex,
                                                  int maxResults)

withSearchRestriction

public EntityQuery<T> withSearchRestriction(SearchRestriction searchRestriction)

baseSplitQuery

public EntityQuery<T> baseSplitQuery()

Returns:

query with adjusted start index and maximum results which is required for merging query results

splitOrRestrictionIfNeeded

public Optional<List<EntityQuery<T>>> splitOrRestrictionIfNeeded(int maxSize)

Splits the query if needed. Query is split if the number of OR conditions is higher than maxSize. Only top level condition split is supported. Note that the start index and max conditions are adjusted.

Returns:

split queries if split is needed or Optional#empty otherwise

withAllResults

public EntityQuery<T> withAllResults()

addToMaxResults

public EntityQuery<T> addToMaxResults(int add)

hasAllResults

public boolean hasAllResults()