Package org.ametys.web.search.query

Class SiteQuery

java.lang.Object

org.ametys.web.search.query.SiteQuery

All Implemented Interfaces:

Query

public class SiteQuery
extends Object
implements Query

Represents a Query testing the site property.

Nested Class Summary

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

Query.LogicalOperator, Query.Operator

Field Summary

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

BOOL_FILTER, BOOL_MUST, BOOL_MUST_NOT, BOOL_SHOULD

Constructor Summary

Constructors

Constructor	Description
SiteQuery()	Build a SiteQuery to test if the site property exists
SiteQuery(String... names)	Build a SiteQuery to test if the site property is equals to one of the given site names
SiteQuery(Collection<String> names)	Build a SiteQuery to test if the site property is equals to one of the given site names
SiteQuery(Query.Operator operator, String... names)	Build a SiteQuery to test if the site property is equals or different to one of the given site names
SiteQuery(Query.Operator operator, Collection<String> names)	Build a SiteQuery.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
boolean	equals(Object obj)
List<String>	getNames()	Get the site names.
Query.Operator	getOperator()	Get the operator.
int	hashCode()

Methods inherited from class java.lang.Object

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

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

buildAsJson, rewrite, toString

Constructor Details

SiteQuery

public SiteQuery()

Build a SiteQuery to test if the site property exists

SiteQuery

public SiteQuery(String... names)

Build a SiteQuery to test if the site property is equals to one of the given site names

Parameters:

names - the site names.

SiteQuery

public SiteQuery(Collection<String> names)

Build a SiteQuery to test if the site property is equals to one of the given site names

Parameters:

names - the site names.

SiteQuery

public SiteQuery(Query.Operator operator,
 String... names)

Build a SiteQuery to test if the site property is equals or different to one of the given site names

Parameters:

operator - the operator (equals ot not-equals)

names - the site names.

SiteQuery

public SiteQuery(Query.Operator operator,
 Collection<String> names)

Build a SiteQuery.

Parameters:

operator - the operator.

names - the site names.

Method Details

getOperator

public Query.Operator getOperator()

Get the operator.

Returns:

the operator

getNames

public List<String> getNames()

Get the site names.

Returns:

the site names.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object