AbstractOptionsForSelect (Achilles Core 6.1.0 API)

java.lang.Object
- info.archinnov.achilles.internals.dsl.options.AbstractOptionsForSelect<T>

Direct Known Subclasses:

AbstractOptionsForCRUDInsert, AbstractOptionsForCRUDUpdate, AbstractOptionsForUpdateOrDelete, AbstractSelectWhere, AbstractSelectWhereJSON, AbstractSelectWhereTypeMap, FindWithOptions
```
public abstract class AbstractOptionsForSelect<T extends AbstractOptionsForSelect<T>>
extends Object
```

Constructor Summary

Constructors
Constructor and Description

AbstractOptionsForSelect()

Constructors
Constructor and Description
`AbstractOptionsForSelect()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract CassandraOptions`	`getOptions()`
`protected abstract T`	`getThis()`
`T`	`isIdempotent()` Hint the current statement as idempotent.
`T`	`isIdempotent(boolean idempotent)` Give a hint whether the current statement is idempotent.
`T`	`withConsistencyLevel(ConsistencyLevel consistencyLevel)` Set the given consistency level on the generated statement
`T`	`withDMLResultsDisplaySize(int DMLResultsDisplaySize)` When DEBUG log is enabled, restrict the Results Display to maximum DMLResultsDisplaySize rows.
`T`	`withFetchSize(int fetchSize)` Set the given fetch size on the generated statement
`T`	`withOptionalConsistencyLevel(Optional<ConsistencyLevel> consistencyLevel)` Set the given consistency level on the generated statement IF NOT NULL
`T`	`withOptionalOutgoingPayload(Optional<Map<String,ByteBuffer>> outgoingPayload)` Set the given outgoing payload map on the generated statement IF NOT NULL
`T`	`withOptionalPagingState(Optional<PagingState> pagingState)` Set the given paging state on the generated statement IF NOT NULL
`T`	`withOptionalPagingStateString(Optional<String> pagingStateString)` Set the given paging state string on the generated statement IF NOT NULL
`T`	`withOptionalRetryPolicy(Optional<com.datastax.driver.core.policies.RetryPolicy> retryPolicy)` Set the given retry policy
`T`	`withOptionalSerialConsistencyLevel(Optional<ConsistencyLevel> serialConsistencyLevel)` Set the given serial consistency level on the generated statement IF NOT NULL
`T`	`withOutgoingPayload(Map<String,ByteBuffer> outgoingPayload)` Set the given outgoing payload map on the generated statement
`T`	`withPagingState(PagingState pagingState)` Set the given paging state on the generated statement
`T`	`withPagingState(String pagingState)` Set the given paging state string on the generated statement
`T`	`withReadTimeoutInMillis(Integer readTimeoutInMillis)` Set read timeout in millisecs.
`T`	`withResultSetAsyncListener(java.util.function.Function<ResultSet,ResultSet> resultSetAsyncListener)` Add the given async listener on the `ResultSet` object.
`T`	`withResultSetAsyncListeners(List<java.util.function.Function<ResultSet,ResultSet>> resultSetAsyncListeners)` Add the given list of async listeners on the `ResultSet` object.
`T`	`withRetryPolicy(com.datastax.driver.core.policies.RetryPolicy retryPolicy)` Set the given retry policy
`T`	`withRowAsyncListener(java.util.function.Function<Row,Row> rowAsyncListener)` Add the given async listener on the `Row` object.
`T`	`withRowAsyncListeners(List<java.util.function.Function<Row,Row>> rowAsyncListeners)` Add the given list of async listeners on the `Row` object.
`T`	`withSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel)` Set the given serial consistency level on the generated statement
`T`	`withTracing()` Enable query tracing.
`T`	`withTracing(boolean tracing)` Enable query tracing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractOptionsForSelect
```
public AbstractOptionsForSelect()
```
- Method Detail
  - getThis
```
protected abstract T getThis()
```
  - getOptions
```
protected abstract CassandraOptions getOptions()
```
  - withConsistencyLevel
```
public T withConsistencyLevel(ConsistencyLevel consistencyLevel)
```
    Set the given consistency level on the generated statement
    
    Throws:
    
    NullPointerException - if consistencyLevel is null
  - withOptionalConsistencyLevel
```
public T withOptionalConsistencyLevel(Optional<ConsistencyLevel> consistencyLevel)
```
    Set the given consistency level on the generated statement IF NOT NULL
  - withSerialConsistencyLevel
```
public T withSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel)
```
    Set the given serial consistency level on the generated statement
    
    Throws:
    
    NullPointerException - if serialConsistencyLevel is null
  - withOptionalSerialConsistencyLevel
```
public T withOptionalSerialConsistencyLevel(Optional<ConsistencyLevel> serialConsistencyLevel)
```
    Set the given serial consistency level on the generated statement IF NOT NULL
  - withFetchSize
```
public T withFetchSize(int fetchSize)
```
    Set the given fetch size on the generated statement
  - isIdempotent
```
public T isIdempotent()
```
    Hint the current statement as idempotent. Useful for retry strategy
  - isIdempotent
```
public T isIdempotent(boolean idempotent)
```
    Give a hint whether the current statement is idempotent. Useful for retry strategy
  - withOutgoingPayload
```
public T withOutgoingPayload(Map<String,ByteBuffer> outgoingPayload)
```
    Set the given outgoing payload map on the generated statement
    
    Throws:
    
    NullPointerException - if outgoingPayload is null
  - withOptionalOutgoingPayload
```
public T withOptionalOutgoingPayload(Optional<Map<String,ByteBuffer>> outgoingPayload)
```
    Set the given outgoing payload map on the generated statement IF NOT NULL
  - withPagingState
```
public T withPagingState(PagingState pagingState)
```
    Set the given paging state on the generated statement
    
    Throws:
    
    NullPointerException - if pagingState is null
  - withPagingState
```
public T withPagingState(String pagingState)
```
    Set the given paging state string on the generated statement
    
    Throws:
    
    NullPointerException - if paging state string is null
  - withOptionalPagingState
```
public T withOptionalPagingState(Optional<PagingState> pagingState)
```
    Set the given paging state on the generated statement IF NOT NULL
  - withOptionalPagingStateString
```
public T withOptionalPagingStateString(Optional<String> pagingStateString)
```
    Set the given paging state string on the generated statement IF NOT NULL
  - withRetryPolicy
```
public T withRetryPolicy(com.datastax.driver.core.policies.RetryPolicy retryPolicy)
```
    Set the given retry policy
    
    Throws:
    
    NullPointerException - if value is null
  - withOptionalRetryPolicy
```
public T withOptionalRetryPolicy(Optional<com.datastax.driver.core.policies.RetryPolicy> retryPolicy)
```
    Set the given retry policy
  - withResultSetAsyncListeners
```
public T withResultSetAsyncListeners(List<java.util.function.Function<ResultSet,ResultSet>> resultSetAsyncListeners)
```
    Add the given list of async listeners on the ResultSet object. Example of usage:
```
 .withResultSetAsyncListeners(Arrays.asList(resultSet -> {
 //Do something with the resultSet object here
 }))

 
```
    Remark: it is not allowed to consume the ResultSet values. It is strongly advised to read only meta data
  - withResultSetAsyncListener
```
public T withResultSetAsyncListener(java.util.function.Function<ResultSet,ResultSet> resultSetAsyncListener)
```
    Add the given async listener on the ResultSet object. Example of usage:
```
 .withResultSetAsyncListener(resultSet -> {
 //Do something with the resultSet object here
 })

 
```
    Remark: it is not allowed to consume the ResultSet values. It is strongly advised to read only meta data
  - withRowAsyncListeners
```
public T withRowAsyncListeners(List<java.util.function.Function<Row,Row>> rowAsyncListeners)
```
    Add the given list of async listeners on the Row object. Example of usage:
```
 .withRowAsyncListeners(Arrays.asList(row -> {
 //Do something with the row object here
 }))

 
```
    Remark: You can inspect and read values from the row object
  - withRowAsyncListener
```
public T withRowAsyncListener(java.util.function.Function<Row,Row> rowAsyncListener)
```
    Add the given async listener on the Row object. Example of usage:
```
 .withRowAsyncListener(row -> {
 //Do something with the row object here
 })

 
```
    Remark: You can inspect and read values from the row object
  - withTracing
```
public T withTracing(boolean tracing)
```
    Enable query tracing. Please configure the logger ACHILLES_DML_STATEMENT at TRACE level to see tracing results. Alternatively you can configure a single entity logger to restrict tracing display only to this entity
  - withTracing
```
public T withTracing()
```
    Enable query tracing. Please configure the logger ACHILLES_DML_STATEMENT at TRACE level to see tracing results. Alternatively you can configure a single entity logger to restrict tracing display only to this entity
  - withReadTimeoutInMillis
```
public T withReadTimeoutInMillis(Integer readTimeoutInMillis)
```
    Set read timeout in millisecs.
    This paramater is useful when using user-defined aggregates. You may want to increase the read timeout if the aggregates is expected to take longer than the defaut timeout
    
    Parameters:
    
    readTimeoutInMillis - read timeout in millis
  - withDMLResultsDisplaySize
```
public T withDMLResultsDisplaySize(int DMLResultsDisplaySize)
```
    When DEBUG log is enabled, restrict the Results Display to maximum DMLResultsDisplaySize rows.
    
    WARNING: there is a hard-limit of maximum 100 rows. If you provide a value greater than 100 the number of displayed returned rows will still be capped to 100. If you provide a negative number, it will default to 0
    
    Parameters:
    
    DMLResultsDisplaySize - the maximum number of returned rows to be displayed

Class AbstractOptionsForSelect<T extends AbstractOptionsForSelect<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractOptionsForSelect

Method Detail

getThis

getOptions

withConsistencyLevel

withOptionalConsistencyLevel

withSerialConsistencyLevel

withOptionalSerialConsistencyLevel

withFetchSize

isIdempotent

isIdempotent

withOutgoingPayload

withOptionalOutgoingPayload

withPagingState

withPagingState

withOptionalPagingState

withOptionalPagingStateString

withRetryPolicy

withOptionalRetryPolicy

withResultSetAsyncListeners

withResultSetAsyncListener

withRowAsyncListeners

withRowAsyncListener

withTracing

withTracing

withReadTimeoutInMillis

withDMLResultsDisplaySize