Package org.ametys.web.search.query

Class SiteTypeQuery

java.lang.Object

org.ametys.web.search.query.SiteTypeQuery

All Implemented Interfaces:

Query

public class SiteTypeQuery
extends Object
implements Query

Represents a Query testing the site type 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 Query.Operator	_operator
private List<String>	_types

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
boolean	equals(Object obj)
Query.Operator	getOperator()	Get the operator.
List<String>	getTypes()	Get the site types.
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

toString

Field Detail

_operator

private Query.Operator _operator

_types

private List<String> _types

Constructor Detail

SiteTypeQuery

public SiteTypeQuery()

Build a SiteTypeQuery to test if the site type property exists

SiteTypeQuery

public SiteTypeQuery(String... types)

Build a SiteTypeQuery to test if the site type property is equals to one of the given site type

Parameters:

types - the site type.

SiteTypeQuery

public SiteTypeQuery(Collection<String> types)

Build a SiteTypeQuery to test if the site type property is equals to one of the given site types

Parameters:

types - the site types.

SiteTypeQuery

public SiteTypeQuery(Query.Operator operator,
                     String... types)

Build a SiteTypeQuery to test if the site type property is equals or different to one of the given site types

Parameters:

operator - the operator (equals ot not-equals)

types - the site types.

SiteTypeQuery

public SiteTypeQuery(Query.Operator operator,
                     Collection<String> types)

Build a SiteTypeQuery.

Parameters:

operator - the operator.

types - the site types.

Method Detail

getOperator

public Query.Operator getOperator()

Get the operator.

Returns:

the operator

getTypes

public List<String> getTypes()

Get the site types.

Returns:

the site types.

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