Package org.ametys.plugins.workspaces.search.query

Class KeywordQuery

java.lang.Object

org.ametys.plugins.workspaces.search.query.KeywordQuery

All Implemented Interfaces:

Query

public class KeywordQuery
extends Object
implements Query

Represents a Query testing the keywords property of a project resource.

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
KeywordQuery(String... keywords)	Build a KeywordQuery to test if the keywords property is equal to one of the given keywords
KeywordQuery(Collection<String> keywords)	Build a KeywordQuery to test if the keywords property is equal to one of the given keywords
KeywordQuery(Query.Operator operator, String... keywords)	Build a KeywordQuery to test if the keywords property is equal or different to one of the given keywords
KeywordQuery(Query.Operator operator, Collection<String> keywords)	Build a KeywordQuery.

Method Summary

Modifier and Type	Method	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

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

buildAsJson, rewrite, toString

Constructor Details

KeywordQuery

public KeywordQuery(String... keywords)

Build a KeywordQuery to test if the keywords property is equal to one of the given keywords

Parameters:

keywords - the keywords.

KeywordQuery

public KeywordQuery(Collection<String> keywords)

Build a KeywordQuery to test if the keywords property is equal to one of the given keywords

Parameters:

keywords - the keywords.

KeywordQuery

public KeywordQuery(Query.Operator operator,
 String... keywords)

Build a KeywordQuery to test if the keywords property is equal or different to one of the given keywords

Parameters:

operator - the operator (equal ot not-equal)

keywords - the keywords.

KeywordQuery

public KeywordQuery(Query.Operator operator,
 Collection<String> keywords)

Build a KeywordQuery.

Parameters:

operator - the operator.

keywords - the keywords.

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.