Package org.ametys.web.search.query

Class PageQuery

java.lang.Object

org.ametys.web.search.query.PageQuery

All Implemented Interfaces:

Query

public class PageQuery
extends Object
implements Query

Query testing the id of a page or its ancestor ids (enabling to search the subpages of a given one).

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
protected Query.Operator	_operator	The operator.
protected String	_pageId	The id.
protected boolean	_withSubPages	True to search for a whole hierarchy.

Constructor Summary

Constructors

Constructor	Description
PageQuery(boolean withSubPages)	Create a PageQuery which searches on the given page (and optionally its sub-pages).
PageQuery(String pageId, boolean withSubPages)	Create a PageQuery which searches on the given page (and optionally its sub-pages).

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
boolean	equals(Object obj)
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 Details

_operator

protected Query.Operator _operator

The operator.

_pageId

protected String _pageId

The id.

_withSubPages

protected boolean _withSubPages

True to search for a whole hierarchy.

Constructor Details

PageQuery

public PageQuery(boolean withSubPages)

Create a PageQuery which searches on the given page (and optionally its sub-pages).

Parameters:

withSubPages - true to search for sub-pages too.

PageQuery

public PageQuery(String pageId,
 boolean withSubPages)

Create a PageQuery which searches on the given page (and optionally its sub-pages).

Parameters:

pageId - the page id.

withSubPages - true to search for sub-pages of the given page id too.

Method Details

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