org.nuxeo.ecm.core.query

Class QueryFilter

java.lang.Object

org.nuxeo.ecm.core.query.QueryFilter

All Implemented Interfaces:

Serializable

public class QueryFilter
extends Object
implements Serializable

Filtering parameters that can be passed when executing a FilterableQuery.

This includes filtering on the BROWSE permission for the given principal, filtering on facets, and applying query transformers.

You can also include a limit and offset, to get a subset of the total.

Author:

Florent Guillaume

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static QueryFilter	EMPTY
protected FacetFilter	facetFilter
protected long	limit
protected long	offset
protected String[]	permissions
protected Principal	principal The principal.
protected String[]	principals
protected Collection<SQLQuery.Transformer>	queryTransformers

Constructor Summary

Constructors

Constructor and Description
QueryFilter(Principal principal, String[] principals, String[] permissions, FacetFilter facetFilter, Collection<SQLQuery.Transformer> queryTransformers, long limit, long offset) Constructs a query filter.

Method Summary

Modifier and Type	Method and Description
FacetFilter	getFacetFilter()
long	getLimit()
long	getOffset()
String[]	getPermissions()
Principal	getPrincipal()
String[]	getPrincipals()
Collection<SQLQuery.Transformer>	getQueryTransformers()
String	toString()
static QueryFilter	withoutLimitOffset(QueryFilter other)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final QueryFilter EMPTY

principal

protected final Principal principal

The principal. Note that this MUST be Serializable.

principals

protected final String[] principals

permissions

protected final String[] permissions

facetFilter

protected final FacetFilter facetFilter

queryTransformers

protected final Collection<SQLQuery.Transformer> queryTransformers

limit

protected final long limit

offset

protected final long offset

Constructor Detail

QueryFilter

public QueryFilter(Principal principal,
                   String[] principals,
                   String[] permissions,
                   FacetFilter facetFilter,
                   Collection<SQLQuery.Transformer> queryTransformers,
                   long limit,
                   long offset)

Constructs a query filter.

Note that the principal MUST be Serializable.

Method Detail

withoutLimitOffset

public static QueryFilter withoutLimitOffset(QueryFilter other)

getPrincipal

public Principal getPrincipal()

getPrincipals

public String[] getPrincipals()

getPermissions

public String[] getPermissions()

getFacetFilter

public FacetFilter getFacetFilter()

getQueryTransformers

public Collection<SQLQuery.Transformer> getQueryTransformers()

getLimit

public long getLimit()

getOffset

public long getOffset()

toString

public String toString()

Overrides:

toString in class Object