Package org.ametys.cms.search.query

Class StringQuery

java.lang.Object

org.ametys.cms.search.query.AbstractOperatorQuery<String>

org.ametys.cms.search.query.AbstractTextQuery

org.ametys.cms.search.query.StringQuery

All Implemented Interfaces:

Cloneable, Query

public class StringQuery
extends AbstractTextQuery

Represents a Query testing a string field.

Nested Class Summary

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

Query.LogicalOperator, Query.Operator

Field Summary

Fields inherited from class org.ametys.cms.search.query.AbstractTextQuery

_language, _valueAlreadyEscaped

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

BOOL_FILTER, BOOL_MUST, BOOL_MUST_NOT, BOOL_SHOULD

Constructor Summary

Constructors

Constructor	Description
StringQuery(String fieldPath)	Build a StringQuery testing the existence of the field.
StringQuery(String fieldPath, String value)	Build a string query.
StringQuery(String fieldPath, String value, String language)	Build a string query.
StringQuery(String fieldPath, Query.Operator op, String value, String language)	Build a string query.
StringQuery(String fieldPath, Query.Operator op, String value, String language, boolean alreadyEscaped)	Build a string query.

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.

Methods inherited from class org.ametys.cms.search.query.AbstractTextQuery

checkStringValue, equals, escapeStringValue, getLanguage, hashCode

Methods inherited from class org.ametys.cms.search.query.AbstractOperatorQuery

getFieldName, getOperator, getValue, rewrite, valueForQuery

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

buildAsJson, toString

Constructor Details

StringQuery

public StringQuery(String fieldPath)

Build a StringQuery testing the existence of the field.

Parameters:

fieldPath - the field path

StringQuery

public StringQuery(String fieldPath,
 String value)

Build a string query.

Parameters:

fieldPath - the field's path

value - the value.

StringQuery

public StringQuery(String fieldPath,
 String value,
 String language)

Build a string query.

Parameters:

fieldPath - the field's path

value - the value.

language - the query language (can be null).

StringQuery

public StringQuery(String fieldPath,
 Query.Operator op,
 String value,
 String language)

Build a string query.

Parameters:

fieldPath - the field's path

op - the operator.

value - the value.

language - the query language (can be null).

StringQuery

public StringQuery(String fieldPath,
 Query.Operator op,
 String value,
 String language,
 boolean alreadyEscaped)

Build a string query.

Parameters:

fieldPath - the field's path

op - the operator.

value - the value.

language - the query language (can be null).

alreadyEscaped - true if the value is already escaped and there is no need to escape again the value during the build of the query.

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

Overrides:

build in class AbstractTextQuery

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.