public class Query extends Object implements Filter
CriteriaDefinition
s, Columns
, Sort
, paging state
and QueryOptions
for a CQL query. Query
is created with a fluent API creating immutable objects.Modifier and Type | Method and Description |
---|---|
Query |
and(CriteriaDefinition criteriaDefinition)
Add the given
CriteriaDefinition to the current Query . |
Query |
columns(Columns columns)
|
static Query |
empty()
Static factory method to create an empty
Query . |
boolean |
equals(Object obj) |
Columns |
getColumns() |
Iterable<CriteriaDefinition> |
getCriteriaDefinitions() |
long |
getLimit() |
Optional<ByteBuffer> |
getPagingState() |
Optional<QueryOptions> |
getQueryOptions() |
Sort |
getSort() |
int |
hashCode() |
boolean |
isAllowFiltering() |
Query |
limit(long limit)
Limit the number of returned rows to
limit . |
Query |
pageRequest(Pageable pageable)
Create a
Query initialized with a PageRequest to fetch the first page of results or advance in
paging along with sorting. |
Query |
pagingState(ByteBuffer pagingState)
Set the
paging state to skip rows. |
static Query |
query(CriteriaDefinition... criteriaDefinitions)
Static factory method to create a
Query using the provided CriteriaDefinition . |
static Query |
query(Iterable<? extends CriteriaDefinition> criteriaDefinitions)
Static factory method to create a
Query using the provided CriteriaDefinition . |
Query |
queryOptions(QueryOptions queryOptions)
Set the
QueryOptions . |
protected boolean |
querySettingsEquals(Query that)
Tests whether the settings of the given
Query are equal to this query. |
Query |
sort(Sort sort)
|
String |
toString() |
Query |
withAllowFiltering()
Allow filtering with
this Query . |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
from, from, iterator
and, and, and, and, filter, flatMap, get, isEmpty, map, of, of, of, stream, toList, toSet, toStreamable, toStreamable
forEach, spliterator
public static Query empty()
Query
.empty
in interface Streamable<CriteriaDefinition>
Query
.public static Query query(CriteriaDefinition... criteriaDefinitions)
Query
using the provided CriteriaDefinition
.criteriaDefinitions
- must not be null.Query
for CriteriaDefinition
s.public static Query query(Iterable<? extends CriteriaDefinition> criteriaDefinitions)
Query
using the provided CriteriaDefinition
.criteriaDefinitions
- must not be null.Query
for CriteriaDefinition
s.public Query and(CriteriaDefinition criteriaDefinition)
CriteriaDefinition
to the current Query
.criteriaDefinition
- must not be null.Query
object containing the former settings with CriteriaDefinition
applied.public Iterable<CriteriaDefinition> getCriteriaDefinitions()
getCriteriaDefinitions
in interface Filter
CriteriaDefinition
s.public Query columns(Columns columns)
Columns
to the Query
instance. Existing definitions are merged or overwritten for overriding
ColumnName
s in columns
.public Query pageRequest(Pageable pageable)
Query
initialized with a PageRequest
to fetch the first page of results or advance in
paging along with sorting. Reads (and overrides, if set) page size
into
QueryOptions.getPageSize()
and sets PagingState
and Sort
.pageable
- must not be null.Query
object containing the former settings with PageRequest
applied.CassandraPageRequest
public Query pagingState(ByteBuffer pagingState)
paging state
to skip rows.pagingState
- must not be null.Query
object containing the former settings with paging state
applied.public Optional<ByteBuffer> getPagingState()
paging state
.public Query queryOptions(QueryOptions queryOptions)
QueryOptions
.queryOptions
- must not be null.Query
object containing the former settings with QueryOptions
applied.public Optional<QueryOptions> getQueryOptions()
QueryOptions
.public Query limit(long limit)
limit
.limit
- Query
object containing the former settings with limit
applied.public long getLimit()
public Query withAllowFiltering()
this
Query
.Query
object containing the former settings with allowFiltering
applied.public boolean isAllowFiltering()
protected boolean querySettingsEquals(Query that)
Query
are equal to this query.that
- Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.