org.ametys.cms.search.query

Class StringQuery

java.lang.Object

org.ametys.cms.search.query.AbstractFieldQuery

org.ametys.cms.search.query.StringQuery

All Implemented Interfaces:

Query

public class StringQuery
extends AbstractFieldQuery

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

Modifier and Type	Field and Description
protected String	_language The language.
protected Query.Operator	_operator The operator.
protected String	_value The value to test.
protected static Pattern	FULLTEXT_ESCAPE_CHARS Escape '{', '}', ':' and '!' characters to prevent the user from changing the query field.
protected static String	FULLTEXT_ESCAPE_CHARS_REPLACEMENT The replacement.

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

_fieldPath

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
static String	escapeStringValue(String value) Escape from a string value the characters that can modify the query field (':', '{' and '}').
String	getLanguage() Get the language.
Query.Operator	getOperator() Get the operator.
String	getValue() Get the value.

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

getFieldPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FULLTEXT_ESCAPE_CHARS

protected static final Pattern FULLTEXT_ESCAPE_CHARS

Escape '{', '}', ':' and '!' characters to prevent the user from changing the query field.

FULLTEXT_ESCAPE_CHARS_REPLACEMENT

protected static final String FULLTEXT_ESCAPE_CHARS_REPLACEMENT

The replacement.

See Also:

Constant Field Values

_operator

protected Query.Operator _operator

The operator.

_value

protected String _value

The value to test.

_language

protected String _language

The language.

Constructor Detail

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

Method Detail

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.

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)

Escape from a string value the characters that can modify the query field (':', '{' and '}').

Parameters:

value - the string value.

Returns:

the escaped value.