Package org.ametys.cms.search.query

Class AbstractTextQuery

java.lang.Object

org.ametys.cms.search.query.AbstractFieldQuery

org.ametys.cms.search.query.AbstractTextQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

RichTextQuery, StringQuery

public abstract class AbstractTextQuery
extends AbstractFieldQuery

Represents a Query testing a text field.

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 String	_language	The language.
protected Query.Operator	_operator	The operator.
protected String	_value	The value to test.
protected boolean	_valueAlreadyEscaped	true if the value is already escaped and there is no need to escape again the value during the build of the query.

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

_fieldPath

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	build()	Build the solr query string representing the Query object.
static void	checkStringValue(String value)	Ensure that the string value is valid (i.e.
boolean	equals(Object obj)
static String	escapeStringValue(String value, Query.Operator operator)	Escape from a string value the characters that can modify the query field
String	getLanguage()	Get the language.
Query.Operator	getOperator()	Get the operator.
String	getValue()	Get the value.
int	hashCode()

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

getFieldPath

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.

_value

protected String _value

The value to test.

_language

protected String _language

The language.

_valueAlreadyEscaped

protected boolean _valueAlreadyEscaped

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

Constructor Details

AbstractTextQuery

public AbstractTextQuery(String fieldPath)

Build a AbstractTextQuery testing the existence of the field.

Parameters:

fieldPath - the field path

AbstractTextQuery

public AbstractTextQuery(String fieldPath,
 String value)

Build a text query.

Parameters:

fieldPath - the field's path

value - the value.

AbstractTextQuery

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

Build a text query.

Parameters:

fieldPath - the field's path

value - the value.

language - the query language (can be null).

AbstractTextQuery

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

Build a text query.

Parameters:

fieldPath - the field's path

op - the operator.

value - the value.

language - the query language (can be null).

AbstractTextQuery

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

Build a text 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

getOperator

public Query.Operator getOperator()

Get the operator.

Returns:

the operator.

getValue

public String getValue()

Get the value.

Returns:

the value.

getLanguage

public String getLanguage()

Get the language.

Returns:

the language.

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

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 AbstractFieldQuery

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractFieldQuery

checkStringValue

public static void checkStringValue(String value)
                             throws QuerySyntaxException

Ensure that the string value is valid (i.e. the parentheses are balanced), and throw an exception if it isn't.

Parameters:

value - the string value to check.

Throws:

QuerySyntaxException - if the value is invalid.

escapeStringValue

public static String escapeStringValue(String value,
 Query.Operator operator)

Escape from a string value the characters that can modify the query field

Parameters:

value - the string value.

operator - the operator

Returns:

the escaped value.