com.sdl.delivery.iq.query.api

Interface Query

All Known Implementing Classes:

SearchQuery

public interface Query

Represents a fluent query API. Based on Examine.

Method Summary

Modifier and Type	Method and Description
Query	facets(List<Facet> facets) 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.
String	getNestedPath() Returns the nested query path.
Operation	groupedAnd(List<String> fields, List<?> query) Grouped AND query on multiple fields and values.
Operation	groupedNot(List<String> fields, List<?> query) Grouped NOT query on multiple fields and values.
Operation	groupedOr(List<String> fields, List<?> query) Grouped OR query on multiple fields and values.
Query	groupEnd() Ends group.
Query	groupStart() Starts group.
BooleanOperation	id(String id) 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.
BooleanOperation	itemType(String itemType) Searches or constrains to item types.
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query) Searches given text in the specified fields.
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query, MatchOperation operation) Searches given text in the specified fields with given operation.
BooleanOperation	multiMatch(List<String> wildCardFieldNames, String query, MatchOperation operation, 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.
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.
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 operation) Sets the operation in Query object.

Method Detail

groupStart

Query groupStart()
          throws QueryException

Starts group.

Returns:

Query object.

Throws:

QueryException

not

Query not()

Used to invert (boolean) a node.

Returns:

Query object.

getBooleanOperation

Optional<BooleanOperationType> getBooleanOperation()

Gets the current boolean operation of this Query.

Returns:

a boolean operation enum.

id

BooleanOperation id(String id)
             throws QueryException

Searches for an Id.

Parameters:

id - the id

Returns:

the operation with an ID criteria.

Throws:

QueryException

id

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

Searches for an Id, separating the identifiers as int.

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

BooleanOperation multiMatch(String query)
                     throws QueryException

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.

Parameters:

query - The text to be searched.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

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

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.

Parameters:

query - The text to be searched.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

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

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.

Parameters:

wildCardFieldNames - The field names.

query - The text to be searched.

operation - The operation.

Returns:

a query object as boolean operation.

Throws:

QueryException

multiMatch

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

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.

Parameters:

wildCardFieldNames - The field names.

query - The text to be searched.

operation - The operation.

type - The type.

Returns:

a query object as boolean operation.

Throws:

QueryException

itemType

BooleanOperation itemType(String itemType)
                   throws QueryException

Searches or constrains to item types.

Parameters:

itemType - the item type

Returns:

the operation with an ItemType criteria.

Throws:

QueryException

field

BooleanOperation field(String fieldName,
                       String fieldValue)
                throws QueryException

Default text query on a field.

Parameters:

fieldName - the field name

fieldValue - the search string

Returns:

a query object as boolean operation.

Throws:

QueryException

field

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

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

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

BooleanOperation field(String fieldName,
                       TermValue fieldValue)
                throws QueryException

Default text query on a field.

Parameters:

fieldName - the field name

fieldValue - the search string

Returns:

a query object as boolean operation.

Throws:

QueryException

field

BooleanOperation field(String fieldName,
                       TermValues fieldValues)
                throws QueryException

Alternative text queries on a field.

Parameters:

fieldName - the field name

fieldValues - the search strings

Returns:

a query object as boolean operation.

Throws:

QueryException

field

BooleanOperation field(String fieldName,
                       Object fieldValue)
                throws QueryException

Default text query on a field.

Parameters:

fieldName - the field name

fieldValue - the search object

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on date range.

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

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

Query on date range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

Query on an int range.

Parameters:

fieldName - the field name

lower - the from int.

upper - the from int.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on an int range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

Query on a double range.

Parameters:

fieldName - the field name

lower - the from double.

upper - the from double.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on a double range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

Query on an float range.

Parameters:

fieldName - the field name

lower - the from int.

upper - the from int.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on a float range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

Query on an long range.

Parameters:

fieldName - the field name

lower - the from long.

upper - the from long.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on a long range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

Query on an string range.

Parameters:

fieldName - the field name

lower - the from string.

upper - the from string.

Returns:

a query object as boolean operation.

Throws:

QueryException

range

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

Query on a string range, with the option to include the lower and upper bounds. Basically a >= <= 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

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

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.

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

groupedOr

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

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.

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

groupedNot

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

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.

Parameters:

fields - the list of fields.

query - the query parameters

Returns:

a query object as boolean operation.

Throws:

QueryException

withOperation

Query withOperation(BooleanOperation operation)

Sets the operation in Query object.

Parameters:

operation - The operation.

Returns:

The current instance.

sortFieldsDescending

Query sortFieldsDescending(List<String> fieldNames)

Sets descending sort fields.

Parameters:

fieldNames - The fields.

sortFieldsAscending

Query sortFieldsAscending(List<String> fieldNames)

Sets sort fields.

Parameters:

fieldNames - The fields.

sortStringFieldsDescending

Query sortStringFieldsDescending(List<String> fieldNames)

Sets descending sort fields having string type.

Parameters:

fieldNames - The fields.

sortStringFieldsAscending

Query sortStringFieldsAscending(List<String> fieldNames)

Sets sort fields having string type.

Parameters:

fieldNames - The fields.

groupEnd

Query groupEnd()
        throws QueryException

Ends group.

Returns:

Parent Query object.

Throws:

QueryException

facets

Query facets(List<Facet> facets)

Sets the facets.

Parameters:

facets - The facets.

Returns:

The current instance.

isNested

boolean isNested()

Returns true if query is marked as a nested query.

Returns:

true if query is marked as a nested query.

getNestedPath

String getNestedPath()

Returns the nested query path.

Returns:

The nested query path.