org.ojai.store

Interface Query

All Superinterfaces:

Buildable, Container, JsonString

@API.Public
 @API.ImmutableOnBuild
public interface Query
extends Buildable, Container, JsonString

OJAI interface which lets users build an OJAI Query that can be executed on an OJAI DocumentStore.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIMIT OJAI field name for the limit(long) operator
static String	OFFSET OJAI field name for the offset(long) operator
static String	ORDERBY OJAI field name for the orderBy(FieldPath...) operator
static String	SELECT OJAI field name for the select(FieldPath...) operator.
static String	WHERE OJAI field name for the where(QueryCondition) operator

Method Summary

Modifier and Type	Method and Description
Query	build() Builds this Query object and make it immutable.
Object	getOption(String optionName) Returns the value of the named query option.
Query	limit(long limit) Restricts the maximum number of documents returned from this query to the specified value.
Query	offset(long offset) Zero (0) based index which specifies number of Documents to skip before returning any result.
Query	orderBy(FieldPath... fieldPaths) Sets the sort ordering of the returned Documents to the ascending order of specified field paths.
Query	orderBy(FieldPath field, SortOrder order) Sets the sort ordering of the returned Documents to the specified field and order.
Query	orderBy(String... fieldPaths) Sets the sort ordering of the returned Documents to the ascending order of specified field paths.
Query	orderBy(String field, SortOrder order) Sets the sort ordering of the returned Documents to the specified field and order.
Query	orderBy(String field, String order) Sets the sort ordering of the returned Documents to the specified field and order.
Query	select(FieldPath... fieldPaths) Adds the list of field paths to the list of projected fields.
Query	select(String... fieldPaths) Adds the list of field paths to the list of projected fields.
Query	setOption(String optionName, Object value) Sets a named query option.
Query	setOptions(Document options) Sets multiple query options for this Query.
Query	setTimeout(long timeoutInMilliseconds) Sets a duration after which the query will fails with QueryTimeoutException.
Query	waitForTrackedWrites(String writesContext) Sets the writes-context for this query.
Query	where(QueryCondition condition) Sets the filtering condition for the query.
Query	where(String conditionJson) Sets the filtering condition for the query.

Methods inherited from interface org.ojai.Buildable

isBuilt

Methods inherited from interface org.ojai.Container

empty, isEmpty, isReadOnly, size

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Field Detail

SELECT

static final String SELECT

OJAI field name for the select(FieldPath...) operator.

See Also:

Constant Field Values

ORDERBY

static final String ORDERBY

OJAI field name for the orderBy(FieldPath...) operator

See Also:

Constant Field Values

WHERE

static final String WHERE

OJAI field name for the where(QueryCondition) operator

See Also:

Constant Field Values

LIMIT

static final String LIMIT

OJAI field name for the limit(long) operator

See Also:

Constant Field Values

OFFSET

static final String OFFSET

OJAI field name for the offset(long) operator

See Also:

Constant Field Values

Method Detail

setOption

Query setOption(@API.NonNullable
                String optionName,
                @API.NonNullable
                Object value)
         throws IllegalArgumentException

Sets a named query option. A query option can be used to provide hints to query execution engine. However, under stable conditions, a query option can not alter the result of the query.

Refer to OJAI Driver's documentation for the list of supported options.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

getOption

Object getOption(@API.NonNullable
                 String optionName)

Returns the value of the named query option.

Returns:

value of the named query option; null if no such option exist

setOptions

Query setOptions(@API.Nullable
                 Document options)
          throws IllegalArgumentException

Sets multiple query options for this Query.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

setTimeout

Query setTimeout(long timeoutInMilliseconds)
          throws IllegalArgumentException

Sets a duration after which the query will fails with QueryTimeoutException.

A query timeout occurs when the specified time has passed since a query response was requested, either by calling Iterator.next() on iterator of query's DocumentStream, or between successive callback of DocumentListener.documentArrived(Document).

Returns:

this for chained invocation

Throws:

IllegalArgumentException - If the timeout value is negative

waitForTrackedWrites

Query waitForTrackedWrites(@API.NonNullable
                           String writesContext)
                    throws IllegalArgumentException

Sets the writes-context for this query.

A writes-context allows this query to "see" all the writes that happened inside the writes-context of a DocumentStore.

Returns:

this for chained invocation

Throws:

NullPointerException - if the commit context is null

IllegalArgumentException - if the specified writes-context can not be parsed

See Also:

DocumentStore.beginTrackingWrites(), DocumentStore.beginTrackingWrites(String), DocumentStore.endTrackingWrites()

select

Query select(@API.NonNullable
             String... fieldPaths)
      throws IllegalArgumentException

Adds the list of field paths to the list of projected fields. If not specified, the entire Document will be returned.

Multiple invocation will append new fields to the list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

select

Query select(@API.NonNullable
             FieldPath... fieldPaths)
      throws IllegalArgumentException

Adds the list of field paths to the list of projected fields. If not specified, the entire Document will be returned.

Multiple invocation will append new fields to the list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

where

Query where(@API.NonNullable
            String conditionJson)
     throws OjaiException,
            IllegalArgumentException

Sets the filtering condition for the query.

Multiple invocation will 'AND' the individual conditions.

Returns:

this for chained invocation

Throws:

OjaiException

IllegalArgumentException

where

Query where(@API.NonNullable
            QueryCondition condition)
     throws OjaiException,
            IllegalArgumentException

Sets the filtering condition for the query.

Multiple invocation will 'AND' the individual conditions.

Returns:

this for chained invocation

Throws:

OjaiException

IllegalArgumentException

orderBy

Query orderBy(@API.NonNullable
              String... fieldPaths)
       throws IllegalArgumentException

Sets the sort ordering of the returned Documents to the ascending order of specified field paths.

Multiple invocation will append the field to the sort list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the same field is specified more than once

orderBy

Query orderBy(@API.NonNullable
              FieldPath... fieldPaths)
       throws IllegalArgumentException

Sets the sort ordering of the returned Documents to the ascending order of specified field paths.

Multiple invocation will append the field to the sort list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the same field is specified more than once

orderBy

Query orderBy(@API.NonNullable
              String field,
              @API.NonNullable
              String order)
       throws IllegalArgumentException

Sets the sort ordering of the returned Documents to the specified field and order.

Multiple invocation will append the field to the sort list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the same field is specified more than once

IllegalArgumentException - if the supplied field path can not be parsed or order is neither "ASC" or "DESC", ignoring case

orderBy

Query orderBy(@API.NonNullable
              String field,
              @API.NonNullable
              SortOrder order)
       throws IllegalArgumentException

Sets the sort ordering of the returned Documents to the specified field and order.

Multiple invocation will append the field to the sort list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the same field is specified more than once

orderBy

Query orderBy(@API.NonNullable
              FieldPath field,
              @API.NonNullable
              SortOrder order)
       throws IllegalArgumentException

Sets the sort ordering of the returned Documents to the specified field and order.

Multiple invocation will append the field to the sort list.

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the same field is specified more than once

offset

Query offset(long offset)
      throws IllegalArgumentException

Zero (0) based index which specifies number of Documents to skip before returning any result. Negative values are not permitted.

Multiple invocation will overwrite the previous value.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

limit

Query limit(long limit)
     throws IllegalArgumentException

Restricts the maximum number of documents returned from this query to the specified value. Negative values are not permitted.

Multiple invocation will overwrite the previous value.

Returns:

this for chained invocation

Throws:

IllegalArgumentException

build

Query build()

Builds this Query object and make it immutable.

Specified by:

build in interface Buildable

Returns:

this for chaining