Package org.nuxeo.ecm.core.query

Class QueryFilter

java.lang.Object

org.nuxeo.ecm.core.query.QueryFilter

All Implemented Interfaces:

QueryFilter<SQLQuery.Transformer>

public class QueryFilter
extends Object
implements QueryFilter<SQLQuery.Transformer>

Filtering parameters that can be passed when executing a query.

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
QueryFilter(NuxeoPrincipal 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	Description
FacetFilter	getFacetFilter()
long	getLimit()
long	getOffset()
String[]	getPermissions()
NuxeoPrincipal	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 NuxeoPrincipal principal

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(NuxeoPrincipal principal,
                   String[] principals,
                   String[] permissions,
                   FacetFilter facetFilter,
                   Collection<SQLQuery.Transformer> queryTransformers,
                   long limit,
                   long offset)

Constructs a query filter.

Method Detail

withoutLimitOffset

public static QueryFilter withoutLimitOffset(QueryFilter other)

getPrincipal

public NuxeoPrincipal getPrincipal()

Specified by:

getPrincipal in interface QueryFilter<SQLQuery.Transformer>

getPrincipals

public String[] getPrincipals()

Specified by:

getPrincipals in interface QueryFilter<SQLQuery.Transformer>

getPermissions

public String[] getPermissions()

Specified by:

getPermissions in interface QueryFilter<SQLQuery.Transformer>

getFacetFilter

public FacetFilter getFacetFilter()

Specified by:

getFacetFilter in interface QueryFilter<SQLQuery.Transformer>

getQueryTransformers

public Collection<SQLQuery.Transformer> getQueryTransformers()

Specified by:

getQueryTransformers in interface QueryFilter<SQLQuery.Transformer>

getLimit

public long getLimit()

Specified by:

getLimit in interface QueryFilter<SQLQuery.Transformer>

getOffset

public long getOffset()

Specified by:

getOffset in interface QueryFilter<SQLQuery.Transformer>

toString

public String toString()

Overrides:

toString in class Object