Package org.ametys.plugins.workspaces.search.query

Class ProjectQuery

java.lang.Object

org.ametys.plugins.workspaces.search.query.ProjectQuery

All Implemented Interfaces:

Query

public class ProjectQuery
extends Object
implements Query

Represents a Query testing the project property.

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	Description
private List<String>	_ids
private Query.Operator	_operator

Constructor Summary

Constructors

Constructor	Description
ProjectQuery()	Build a ProjectQuery to test if the project property exits
ProjectQuery(String... ids)	Build a ProjectQuery to test if the project property is equal to one of the given project ids
ProjectQuery(Collection<String> ids)	Build a ProjectQuery to test if the project property is equal to one of the given project ids
ProjectQuery(Query.Operator operator, String... ids)	Build a ProjectQuery to test if the project property is equal or different to one of the given project ids
ProjectQuery(Query.Operator operator, Collection<String> ids)	Build a ProjectQuery.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.query.Query

toString

Field Detail

_operator

private Query.Operator _operator

_ids

private List<String> _ids

Constructor Detail

ProjectQuery

public ProjectQuery()

Build a ProjectQuery to test if the project property exits

ProjectQuery

public ProjectQuery(String... ids)

Build a ProjectQuery to test if the project property is equal to one of the given project ids

Parameters:

ids - the project ids.

ProjectQuery

public ProjectQuery(Collection<String> ids)

Build a ProjectQuery to test if the project property is equal to one of the given project ids

Parameters:

ids - the project ids.

ProjectQuery

public ProjectQuery(Query.Operator operator,
                    String... ids)

Build a ProjectQuery to test if the project property is equal or different to one of the given project ids

Parameters:

operator - the operator (equal ot not-equal)

ids - the project ids.

ProjectQuery

public ProjectQuery(Query.Operator operator,
                    Collection<String> ids)

Build a ProjectQuery.

Parameters:

operator - the operator.

ids - the project ids.

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.