com.sdl.delivery.iq.query.search

Class SearchQuery

java.lang.Object

com.sdl.delivery.iq.query.search.SearchQuery

All Implemented Interfaces:

Query

public class SearchQuery
extends Object
implements Query

BinaryTree like implementation of Query.

Method Summary

Modifier and Type	Method and Description
Query	facets(List<Facet> fieldNames) Sets the facets.
BooleanOperation	field(String fieldName, Object fieldValue) Default text query on a field.
BooleanOperation	field(String fieldName, String fieldValue) Default text query on a field.
BooleanOperation	field(String fieldName, String fieldValue, boolean escapeDotsInKey) Default text query on a field with the option to escape the dots in the key.
BooleanOperation	field(String fieldName, TermValue fieldValue) Default text query on a field.
BooleanOperation	field(String fieldName, TermValues fieldValues) Alternative text queries on a field.
Optional<BooleanOperationType>	getBooleanOperation() Gets the current boolean operation of this Query.
List<Facet>	getFacets()
String	getNestedPath() Returns the nested query path.
Optional<List<String>>	getSortFields()
BooleanOperation	groupedAnd(List<String> fields, List<?> query) Grouped AND query on multiple fields and values.
BooleanOperation	groupedNot(List<String> fields, List<?> query) Grouped NOT query on multiple fields and values.
BooleanOperation	groupedOr(List<String> fields, List<?> query) Grouped OR query on multiple fields and values.
Query	groupEnd() Ends group.
Query	groupStart() Starts group.
boolean	hasFacets()
BooleanOperation	id(String idString) Searches for an Id.
BooleanOperation	id(String sourceIdentifier, int publicationId, int itemId, int itemType) Searches for an Id, separating the identifiers as int.
boolean	isNested() Returns true if query is marked as a nested query.
boolean	isSortDescending()
boolean	isSortStrings()
BooleanOperation	itemType(String itemType) Searches or constrains to item types.
SearchNode	left()
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query) Searches given text in the specified fields.
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query, MatchOperation matchOperation) Searches given text in the specified fields with given operation.
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query, MatchOperation matchOperation, MatchType type) Searches given text in the specified fields with given operation and type.
BooleanOperation	multiMatch(String query) Searches given text in both content and dynamically indexed fields with the following syntax: "content.*","dynamic.*" The query operator is OR.
static Query	newNestedQuery(String nestedPath)
static Query	newQuery()
Query	not() Used to invert (boolean) a node.
BooleanOperation	range(String fieldName, Double lower, Double upper) Query on a double range.
BooleanOperation	range(String fieldName, Double lower, Double upper, boolean includeLower, boolean includeUpper) Query on a double range, with the option to include the lower and upper bounds.
BooleanOperation	range(String fieldName, Float lower, Float upper) Query on an float range.
BooleanOperation	range(String fieldName, Float lower, Float upper, boolean includeLower, boolean includeUpper) Query on a float range, with the option to include the lower and upper bounds.
BooleanOperation	range(String fieldName, Integer lower, Integer upper) Query on an int range.
BooleanOperation	range(String fieldName, Integer lower, Integer upper, boolean includeLower, boolean includeUpper) Query on an int range, with the option to include the lower and upper bounds.
BooleanOperation	range(String fieldName, Long lower, Long upper) Query on an long range.
BooleanOperation	range(String fieldName, Long lower, Long upper, boolean includeLower, boolean includeUpper) Query on a long range, with the option to include the lower and upper bounds.
BooleanOperation	range(String fieldName, OffsetDateTime lower, OffsetDateTime upper) Query on date range.
BooleanOperation	range(String fieldName, OffsetDateTime lower, OffsetDateTime upper, boolean includeLower, boolean includeUpper) Query on date range, with the option to include the lower and upper bounds.
BooleanOperation	range(String fieldName, String lower, String upper) Query on an string range.
BooleanOperation	range(String fieldName, String lower, String upper, boolean includeLower, boolean includeUpper) Query on a string range, with the option to include the lower and upper bounds.
SearchNode	right()
Query	sortFieldsAscending(List<String> fieldNames) Sets sort fields.
Query	sortFieldsDescending(List<String> fieldNames) Sets descending sort fields.
Query	sortStringFieldsAscending(List<String> fieldNames) Sets sort fields having string type.
Query	sortStringFieldsDescending(List<String> fieldNames) Sets descending sort fields having string type.
Query	withOperation(BooleanOperation op) Sets the operation in Query object.

Methods inherited from class java.lang.Object

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

Method Detail

newQuery

public static Query newQuery()

newNestedQuery

public static Query newNestedQuery(String nestedPath)

groupStart

public Query groupStart()
                 throws QueryException

Description copied from interface: Query

Starts group.

Specified by:

groupStart in interface Query

Returns:

Query object.

Throws:

QueryException

not

public Query not()

Description copied from interface: Query

Used to invert (boolean) a node.

Specified by:

not in interface Query

Returns:

Query object.

getBooleanOperation

public Optional<BooleanOperationType> getBooleanOperation()

Description copied from interface: Query

Gets the current boolean operation of this Query.

Specified by:

getBooleanOperation in interface Query

Returns:

a boolean operation enum.

id

public BooleanOperation id(String idString)
                    throws QueryException

Description copied from interface: Query

Searches for an Id.

Specified by:

id in interface Query

Parameters:

idString - the id

Returns:

the operation with an ID criteria.

Throws:

QueryException

id

public BooleanOperation id(String sourceIdentifier,
                           int publicationId,
                           int itemId,
                           int itemType)
                    throws QueryException

Description copied from interface: Query

Searches for an Id, separating the identifiers as int.

Specified by:

id in interface Query

Parameters:

sourceIdentifier - the source identifier. Currently either 'ish' or 'tcm'

publicationId - the unique id

itemId - the unique id

itemType - the item type

Returns:

the operation with an ID criteria.

Throws:

QueryException

multiMatch

public BooleanOperation multiMatch(String query)
                            throws QueryException

Description copied from interface: Query

Searches given text in both content and dynamically indexed fields with the following syntax: "content.*","dynamic.*" The query operator is OR. Important note: the operator in multi match queries works on the given terms and not on the fields.

Specified by:

multiMatch in interface Query

Parameters:

query - The text to be searched.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

public BooleanOperation multiMatch(List<String> wildCardFieldNames,
                                   String query)
                            throws QueryException

Description copied from interface: Query

Searches given text in the specified fields. This method must be used in case there is a requirement to perform a search in nested sub fields and the field names of the sub fields are unknown. Example: Query.multiMatch(Arrays.asList("content.*", "otherfields*"), "searchvalue"); The query operator is OR. Important note: the operator in multi match queries works on the given terms and not on the fields.

Specified by:

multiMatch in interface Query

query - The text to be searched.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

public BooleanOperation multiMatch(List<String> wildCardFieldNames,
                                   String query,
                                   MatchOperation matchOperation)
                            throws QueryException

Description copied from interface: Query

Searches given text in the specified fields with given operation. This method must be used in case there is a requirement to perform a search in nested sub fields and the field names of the sub fields are unknown. Example: Query.multiMatch(Arrays.asList("content.*", "otherfields*"), "searchvalue"); The given query operator is used. Important note: the operator in multi match queries works on the given terms and not on the fields.

Specified by:

multiMatch in interface Query

Parameters:

wildCardFieldNames - The field names.

query - The text to be searched.

matchOperation - The operation.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

public BooleanOperation multiMatch(List<String> wildCardFieldNames,
                                   String query,
                                   MatchOperation matchOperation,
                                   MatchType type)
                            throws QueryException

Description copied from interface: Query

Searches given text in the specified fields with given operation and type. This method must be used in case there is a requirement to perform a search in nested sub fields and the field names of the sub fields are unknown. Example: Query.multiMatch(Arrays.asList("content.*", "otherfields*"), "searchvalue"); The given query operator is used. Important note: the operator in multi match queries works on the given terms and not on the fields.

Specified by:

multiMatch in interface Query

Parameters:

wildCardFieldNames - The field names.

query - The text to be searched.

matchOperation - The operation.

type - The type.

Returns:

a query object as boolean operation.

Throws:

QueryException

itemType

public BooleanOperation itemType(String itemType)
                          throws QueryException

Description copied from interface: Query

Searches or constrains to item types.

Specified by:

itemType in interface Query

Parameters:

itemType - the item type

Returns:

the operation with an ItemType criteria.

Throws:

QueryException

field

public BooleanOperation field(String fieldName,
                              String fieldValue)
                       throws QueryException

Description copied from interface: Query

Default text query on a field.

Specified by:

field in interface Query

Parameters:

fieldName - the field name

fieldValue - the search string

Returns:

a query object as boolean operation.

Throws:

QueryException

field

public BooleanOperation field(String fieldName,
                              String fieldValue,
                              boolean escapeDotsInKey)
                       throws QueryException

Description copied from interface: Query

Default text query on a field with the option to escape the dots in the key.

Specified by:

field in interface Query

Parameters:

fieldName - the field name

fieldValue - the search String

escapeDotsInKey - whether the dots in the key need to be escaped

Returns:

a query object as boolean operation.

Throws:

QueryException

field

public BooleanOperation field(String fieldName,
                              TermValue fieldValue)
                       throws QueryException

Description copied from interface: Query

Default text query on a field.

Specified by:

field in interface Query

Parameters:

fieldName - the field name

fieldValue - the search string

Returns:

a query object as boolean operation.

Throws:

QueryException

field

public BooleanOperation field(String fieldName,
                              TermValues fieldValues)
                       throws QueryException

Description copied from interface: Query

Alternative text queries on a field.

Specified by:

field in interface Query

Parameters:

fieldName - the field name

fieldValues - the search strings

Returns:

a query object as boolean operation.

Throws:

QueryException

field

public BooleanOperation field(String fieldName,
                              Object fieldValue)
                       throws QueryException

Description copied from interface: Query

Default text query on a field.

Specified by:

field in interface Query

Parameters:

fieldName - the field name

fieldValue - the search object

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              OffsetDateTime lower,
                              OffsetDateTime upper)
                       throws QueryException

Description copied from interface: Query

Query on date range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the lower (from) date.

upper - the upper (to) date.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              OffsetDateTime lower,
                              OffsetDateTime upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on date range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the lower (from) date.

upper - the upper (to) date.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Integer lower,
                              Integer upper)
                       throws QueryException

Description copied from interface: Query

Query on an int range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from int.

upper - the from int.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Integer lower,
                              Integer upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on an int range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from int.

upper - the from int.

includeLower - boolean to include the lower range.

includeUpper - boolean to include the upper range.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Double lower,
                              Double upper)
                       throws QueryException

Description copied from interface: Query

Query on a double range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from double.

upper - the from double.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Double lower,
                              Double upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on a double range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from double.

upper - the from double.

includeLower - boolean to include the lower range.

includeUpper - boolean to include the upper range.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Float lower,
                              Float upper)
                       throws QueryException

Description copied from interface: Query

Query on an float range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from int.

upper - the from int.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Float lower,
                              Float upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on a float range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from float.

upper - the from float.

includeLower - boolean to include the lower range.

includeUpper - boolean to include the upper range.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Long lower,
                              Long upper)
                       throws QueryException

Description copied from interface: Query

Query on an long range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from long.

upper - the from long.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              Long lower,
                              Long upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on a long range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from long.

upper - the from long.

includeLower - boolean to include the lower range.

includeUpper - boolean to include the upper range.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              String lower,
                              String upper)
                       throws QueryException

Description copied from interface: Query

Query on an string range.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from string.

upper - the from string.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

public BooleanOperation range(String fieldName,
                              String lower,
                              String upper,
                              boolean includeLower,
                              boolean includeUpper)
                       throws QueryException

Description copied from interface: Query

Query on a string range, with the option to include the lower and upper bounds. Basically a >= <= query.

Specified by:

range in interface Query

Parameters:

fieldName - the field name

lower - the from string.

upper - the from string.

includeLower - boolean to include the lower range.

includeUpper - boolean to include the upper range.

Returns:

a query object as boolean operation.

Throws:

QueryException

groupedAnd

public BooleanOperation groupedAnd(List<String> fields,
                                   List<?> query)
                            throws QueryException

Description copied from interface: Query

Grouped AND query on multiple fields and values.

Example: groupedAnd({"id","type"},{"1","page"}

becomes: +(+id:1 +type:page) List lengths must match or query param may be smaller.

Specified by:

groupedAnd in interface Query

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

groupedOr

public BooleanOperation groupedOr(List<String> fields,
                                  List<?> query)
                           throws QueryException

Description copied from interface: Query

Grouped OR query on multiple fields and values.

Example: groupedOr({"id","type"},{"1","page"}

becomes: +(id:1 type:page) List lengths must match or query param may be smaller.

Specified by:

groupedOr in interface Query

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

groupedNot

public BooleanOperation groupedNot(List<String> fields,
                                   List<?> query)
                            throws QueryException

Description copied from interface: Query

Grouped NOT query on multiple fields and values.

Example: groupedNot({"id","type"},{"1","page"}

becomes: (-id:1 -type:page) List lengths must match or query param may be smaller.

Specified by:

groupedNot in interface Query

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

groupEnd

public Query groupEnd()
               throws QueryException

Description copied from interface: Query

Ends group.

Specified by:

groupEnd in interface Query

Returns:

Parent Query object.

Throws:

QueryException

sortFieldsAscending

public Query sortFieldsAscending(List<String> fieldNames)

Description copied from interface: Query

Sets sort fields.

Specified by:

sortFieldsAscending in interface Query

Parameters:

fieldNames - The fields.

sortFieldsDescending

public Query sortFieldsDescending(List<String> fieldNames)

Description copied from interface: Query

Sets descending sort fields.

Specified by:

sortFieldsDescending in interface Query

Parameters:

fieldNames - The fields.

sortStringFieldsAscending

public Query sortStringFieldsAscending(List<String> fieldNames)

Description copied from interface: Query

Sets sort fields having string type.

Specified by:

sortStringFieldsAscending in interface Query

Parameters:

fieldNames - The fields.

sortStringFieldsDescending

public Query sortStringFieldsDescending(List<String> fieldNames)

Description copied from interface: Query

Sets descending sort fields having string type.

Specified by:

sortStringFieldsDescending in interface Query

Parameters:

fieldNames - The fields.

withOperation

public Query withOperation(BooleanOperation op)

Description copied from interface: Query

Sets the operation in Query object.

Specified by:

withOperation in interface Query

Parameters:

op - The operation.

Returns:

The current instance.

facets

public Query facets(List<Facet> fieldNames)

Description copied from interface: Query

Sets the facets.

Specified by:

facets in interface Query

Parameters:

fieldNames - The facets.

Returns:

The current instance.

getFacets

public List<Facet> getFacets()

hasFacets

public boolean hasFacets()

isNested

public boolean isNested()

Description copied from interface: Query

Returns true if query is marked as a nested query.

Specified by:

isNested in interface Query

Returns:

true if query is marked as a nested query.

getNestedPath

public String getNestedPath()

Description copied from interface: Query

Returns the nested query path.

Specified by:

getNestedPath in interface Query

Returns:

The nested query path.

getSortFields

public Optional<List<String>> getSortFields()

isSortStrings

public boolean isSortStrings()

isSortDescending

public boolean isSortDescending()

left

public SearchNode left()

right

public SearchNode right()