Package io.stargate.sdk.rest.domain

Class SearchTableQuery.SearchTableQueryBuilder

java.lang.Object

io.stargate.sdk.rest.domain.SearchTableQuery.SearchTableQueryBuilder

Enclosing class:

SearchTableQuery

public static class SearchTableQuery.SearchTableQueryBuilder
extends Object

Builder pattern.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	fieldsToRetrieve	If empty the API retrieve all fields SELECT *.
protected List<Sort>	fieldsToSort	Help sorted by result.
protected List<Filter>	filters	Use to build the where Clause as a JsonString if the field whereClause is not provided.
protected int	pageSize	Page size.
protected String	pageState	First page does not need page state.
protected String	whereClause	One can provide the full where clause as a JSON String.

Constructor Summary

Constructors

Constructor	Description
SearchTableQueryBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
SearchTableQuery	build()	Terminal call to build immutable instance of SearchTableQuery.
String	getWhereClause()	Build Where Clause based on Filters.
SearchTableQuery.SearchTableQueryBuilder	select(String... fields)	Only return those fields if provided
SearchTableQuery.SearchTableQueryBuilder	sortBy(Sort... fields)	Only return those fields if provided
SearchTableQuery.SearchTableWhere	where(String fieldName)	Only return those fields if provided
SearchTableQuery.SearchTableQueryBuilder	withPageSize(int pageSize)	withPageSize
SearchTableQuery.SearchTableQueryBuilder	withPageState(String pageState)	withPageState
SearchTableQuery.SearchTableQueryBuilder	withReturnedFields(String... fields)	Only return those fields if provided
SearchTableQuery.SearchTableQueryBuilder	withSortedFields(Sort... fields)	Only return those fields if provided
SearchTableQuery.SearchTableQueryBuilder	withWhereClauseJson(String where)	Use 'where" to help you create

Methods inherited from class java.lang.Object

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

Field Details

pageSize

protected int pageSize

Page size.

pageState

protected String pageState

First page does not need page state.

fieldsToRetrieve

protected List<String> fieldsToRetrieve

If empty the API retrieve all fields SELECT *.

fieldsToSort

protected List<Sort> fieldsToSort

Help sorted by result. fieldName + ASC/DESC.

whereClause

protected String whereClause

One can provide the full where clause as a JSON String. If not null it will be used and the filters will be ignored.

filters

protected List<Filter> filters

Use to build the where Clause as a JsonString if the field whereClause is not provided. - FieldName + condition + value

Constructor Details

SearchTableQueryBuilder

public SearchTableQueryBuilder()

Default constructor.

Method Details

build

public SearchTableQuery build()

Terminal call to build immutable instance of SearchTableQuery.

Returns:

immutable instance of SearchTableQuery.

withPageSize

public SearchTableQuery.SearchTableQueryBuilder withPageSize(int pageSize)

withPageSize

Parameters:

pageSize - int

Returns:

SearchTableQueryBuilder

withPageState

public SearchTableQuery.SearchTableQueryBuilder withPageState(String pageState)

withPageState

Parameters:

pageState - String

Returns:

SearchTableQueryBuilder

withReturnedFields

public SearchTableQuery.SearchTableQueryBuilder withReturnedFields(String... fields)

Only return those fields if provided

Parameters:

fields - String

Returns:

SearchTableQueryBuilder

select

public SearchTableQuery.SearchTableQueryBuilder select(String... fields)

Only return those fields if provided

Parameters:

fields - String

Returns:

SearchTableQueryBuilder

withSortedFields

public SearchTableQuery.SearchTableQueryBuilder withSortedFields(Sort... fields)

Only return those fields if provided

Parameters:

fields - SortField

Returns:

SearchTableQueryBuilder

sortBy

public SearchTableQuery.SearchTableQueryBuilder sortBy(Sort... fields)

Only return those fields if provided

Parameters:

fields - SortField

Returns:

SearchTableQueryBuilder

withWhereClauseJson

public SearchTableQuery.SearchTableQueryBuilder withWhereClauseJson(String where)

Use 'where" to help you create

Parameters:

where - String

Returns:

SearchTableQueryBuilder

where

public SearchTableQuery.SearchTableWhere where(String fieldName)

Only return those fields if provided

Parameters:

fieldName - String

Returns:

SearchTableWhere

getWhereClause

public String getWhereClause()

Build Where Clause based on Filters.

Returns:

String