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 and Description
protected String	_pageId The id.
protected boolean	_withSubPages True to search for a whole hierarchy.

Constructor Summary

Constructors

Constructor and Description
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 and 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

Field Detail

_pageId

protected String _pageId

The id.

_withSubPages

protected boolean _withSubPages

True to search for a whole hierarchy.

Constructor Detail

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 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.