org.ametys.cms.search.query

Class AbstractUsersQuery

java.lang.Object

org.ametys.cms.search.query.AbstractUsersQuery

All Implemented Interfaces:

Query

public abstract class AbstractUsersQuery
extends Object
implements Query

Query testing users.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields

Modifier and Type	Field and Description
private Query.Operator	_operator
private Collection<UserIdentity>	_users

Constructor Summary

Constructors

Constructor and Description
AbstractUsersQuery(Collection<UserIdentity> users) Build a user query.
AbstractUsersQuery(Collection<UserIdentity> users, Query.Operator operator) Build a user query.
AbstractUsersQuery(UserIdentity... users) Build a user query.

Method Summary

Modifier and Type	Method and Description
String	build() Build the solr query string representing the Query object.
protected abstract String	getField() The query field.

Methods inherited from class java.lang.Object

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

Field Detail

_users

private Collection<UserIdentity> _users

_operator

private Query.Operator _operator

Constructor Detail

AbstractUsersQuery

public AbstractUsersQuery(UserIdentity... users)

Build a user query.

Parameters:

users - The users to test.

AbstractUsersQuery

public AbstractUsersQuery(Collection<UserIdentity> users)

Build a user query.

Parameters:

users - The users to test.

AbstractUsersQuery

public AbstractUsersQuery(Collection<UserIdentity> users,
                          Query.Operator operator)

Build a user query.

Parameters:

users - The users to test.

operator - The query operator (can be EQ or NE).

Method Detail

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Specified by:

build in interface Query

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

getField

protected abstract String getField()

The query field.

Returns:

The query field.