Package org.ametys.web.search.query

Class SitemapQuery

java.lang.Object

org.ametys.web.search.query.SitemapQuery

All Implemented Interfaces:

Query

public class SitemapQuery
extends Object
implements Query

Represents a Query testing the sitemap property.

Nested Class Summary

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

Query.LogicalOperator, Query.Operator

Constructor Summary

Constructors

Constructor	Description
SitemapQuery()	Build a SitemapQuery to test if the sitemap property exists.
SitemapQuery(String... names)	Build a SitemapQuery.
SitemapQuery(Collection<String> names)	Build a SitemapQuery.
SitemapQuery(Query.Operator operator, String... names)	Build a SitemapQuery.
SitemapQuery(Query.Operator operator, Collection<String> names)	Build a SitemapQuery.

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

toString

Constructor Detail

SitemapQuery

public SitemapQuery()

Build a SitemapQuery to test if the sitemap property exists.

SitemapQuery

public SitemapQuery(String... names)

Build a SitemapQuery.

Parameters:

names - the site names.

SitemapQuery

public SitemapQuery(Collection<String> names)

Build a SitemapQuery.

Parameters:

names - the site names.

SitemapQuery

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

Build a SitemapQuery.

Parameters:

operator - the operator.

names - the site names.

SitemapQuery

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

Build a SitemapQuery.

Parameters:

operator - the operator.

names - the site names.

Method Detail

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