SimpleRiverContext (elasticsearch-river-jdbc 1.3.4.0 API)

java.lang.Object
- org.xbib.elasticsearch.river.jdbc.strategy.simple.SimpleRiverContext

All Implemented Interfaces:

RiverContext

Direct Known Subclasses:

ColumnRiverContext
```
public class SimpleRiverContext
extends Object
implements RiverContext
```
The river context consists of the parameters that span source and mouth settings. It represents the river state, for supporting the river task execution, and river scripting.

Constructor Summary

Constructors
Constructor and Description

SimpleRiverContext()

Constructors
Constructor and Description
`SimpleRiverContext()`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`asMap()`
`boolean`	`getAutoCommit()`
`Map<String,Object>`	`getColumnNameMap()`
`Map<String,Object>`	`getConnectionProperties()`
`Map<String,Object>`	`getDefinition()` Get river instance definition
`int`	`getFetchSize()`
`Map<String,Object>`	`getLastDatabaseMetadata()`
`long`	`getLastEndDate()`
`long`	`getLastExecutionEndDate()`
`long`	`getLastExecutionStartDate()`
`Map<String,Object>`	`getLastResultSetMetadata()`
`Map<String,Object>`	`getLastRow()`
`long`	`getLastRowCount()`
`long`	`getLastStartDate()`
`org.elasticsearch.common.unit.TimeValue`	`getMaxRetryWait()`
`int`	`getMaxRows()`
`org.elasticsearch.common.metrics.MeterMetric`	`getMetric()` Get metric
`int`	`getQueryTimeout()`
`String`	`getResultSetConcurrency()`
`String`	`getResultSetType()`
`int`	`getRetries()`
`RiverMouth`	`getRiverMouth()` Get river mouth
`RiverSource`	`getRiverSource()` Get river source
`RiverState`	`getRiverState()` Get river state
`int`	`getRounding()`
`int`	`getScale()`
`List<SQLCommand>`	`getStatements()`
`boolean`	`isTimestampDiffSupported()`
`SimpleRiverContext`	`release()` Release all resources
`SimpleRiverContext`	`setAutoCommit(boolean autocommit)` Set auto commit
`SimpleRiverContext`	`setColumnNameMap(Map<String,Object> columnNameMap)` Set column name map.
`SimpleRiverContext`	`setConnectionProperties(Map<String,Object> connectionProperties)` Optional JDBC connection properties
`SimpleRiverContext`	`setDefinition(Map<String,Object> definition)` Set river instance definition
`SimpleRiverContext`	`setFetchSize(int fetchSize)` Set fetch size
`SimpleRiverContext`	`setLastDatabaseMetadata(Map<String,Object> lastDatabaseMetadata)`
`SimpleRiverContext`	`setLastEndDate(long lastEndDate)`
`SimpleRiverContext`	`setLastExecutionEndDate(long lastExecutionEndDate)`
`SimpleRiverContext`	`setLastExecutionStartDate(long lastExecutionStartDate)`
`SimpleRiverContext`	`setLastResultSetMetadata(Map<String,Object> lastResultSetMetadata)`
`SimpleRiverContext`	`setLastRow(Map<String,Object> lastRow)`
`SimpleRiverContext`	`setLastRowCount(long lastRowCount)`
`SimpleRiverContext`	`setLastStartDate(long lastStartDate)`
`SimpleRiverContext`	`setMaxRetryWait(org.elasticsearch.common.unit.TimeValue maxretrywait)` Set maximum count of retries
`SimpleRiverContext`	`setMaxRows(int maxRows)` Set max rows
`RiverContext`	`setMetric(org.elasticsearch.common.metrics.MeterMetric metric)` Set metric
`SimpleRiverContext`	`setQueryTimeout(int queryTimeout)` Set result set query timeout
`SimpleRiverContext`	`setResultSetConcurrency(String resultSetConcurrency)` Set result set concurrency
`SimpleRiverContext`	`setResultSetType(String resultSetType)` Set result set type
`SimpleRiverContext`	`setRetries(int retries)` Set retries
`SimpleRiverContext`	`setRiverMouth(RiverMouth mouth)` Set river mouth
`SimpleRiverContext`	`setRiverSource(RiverSource source)` Set river source
`SimpleRiverContext`	`setRiverState(RiverState riverState)` Set river state
`SimpleRiverContext`	`setRounding(String rounding)` Set rounding of big decimal values.
`SimpleRiverContext`	`setScale(int scale)` Set scale of big decimal values.
`SimpleRiverContext`	`setStatements(List<SQLCommand> sql)` Set the list of SQL statements
`SimpleRiverContext`	`setTimestampDiffSupported(boolean supported)`
`boolean`	`shouldIgnoreNull()`
`SimpleRiverContext`	`shouldIgnoreNull(boolean shouldIgnoreNull)` Should null values in columns be ignored for indexing
`boolean`	`shouldPrepareDatabaseMetadata()`
`SimpleRiverContext`	`shouldPrepareDatabaseMetadata(boolean shouldPrepareDatabaseMetadata)` Should database metadata be used in parameter variables
`boolean`	`shouldPrepareResultSetMetadata()`
`SimpleRiverContext`	`shouldPrepareResultSetMetadata(boolean shouldPrepareResultSetMetadata)` Should result set metadata be used in parameter variables
`boolean`	`shouldTreatBinaryAsString()`
`SimpleRiverContext`	`shouldTreatBinaryAsString(boolean shouldTreatBinaryAsString)` Should binary types (byte arrays) be treated as JSON strings
`String`	`toString()`

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

- Constructor Detail
  - SimpleRiverContext
```
public SimpleRiverContext()
```
- Method Detail
  - setDefinition
```
public SimpleRiverContext setDefinition(Map<String,Object> definition)
```
    Description copied from interface: RiverContext
    
    Set river instance definition
    
    Specified by:
    
    setDefinition in interface RiverContext
    
    Parameters:
    definition - the river instance definition
    
    Returns:
    this context
  - getDefinition
```
public Map<String,Object> getDefinition()
```
    Description copied from interface: RiverContext
    
    Get river instance definition
    
    Specified by:
    
    getDefinition in interface RiverContext
    
    Returns:
    river instance definition
  - setRiverState
```
public SimpleRiverContext setRiverState(RiverState riverState)
```
    Description copied from interface: RiverContext
    
    Set river state
    
    Specified by:
    
    setRiverState in interface RiverContext
    
    Parameters:
    riverState - the river state
    
    Returns:
    this context
  - getRiverState
```
public RiverState getRiverState()
```
    Description copied from interface: RiverContext
    
    Get river state
    
    Specified by:
    
    getRiverState in interface RiverContext
    
    Returns:
    the river state
  - setRiverSource
```
public SimpleRiverContext setRiverSource(RiverSource source)
```
    Description copied from interface: RiverContext
    
    Set river source
    
    Specified by:
    
    setRiverSource in interface RiverContext
    
    Parameters:
    source - the river source
    
    Returns:
    this context
  - getRiverSource
```
public RiverSource getRiverSource()
```
    Description copied from interface: RiverContext
    
    Get river source
    
    Specified by:
    
    getRiverSource in interface RiverContext
    
    Returns:
    the river source
  - setRiverMouth
```
public SimpleRiverContext setRiverMouth(RiverMouth mouth)
```
    Description copied from interface: RiverContext
    
    Set river mouth
    
    Specified by:
    
    setRiverMouth in interface RiverContext
    
    Parameters:
    mouth - the river mouth
    
    Returns:
    this context
  - getRiverMouth
```
public RiverMouth getRiverMouth()
```
    Description copied from interface: RiverContext
    
    Get river mouth
    
    Specified by:
    
    getRiverMouth in interface RiverContext
    
    Returns:
    the river mouth
  - setMetric
```
public RiverContext setMetric(org.elasticsearch.common.metrics.MeterMetric metric)
```
    Description copied from interface: RiverContext
    
    Set metric
    
    Specified by:
    
    setMetric in interface RiverContext
    
    Parameters:
    metric - the meter metric
    
    Returns:
    this context
  - getMetric
```
public org.elasticsearch.common.metrics.MeterMetric getMetric()
```
    Description copied from interface: RiverContext
    
    Get metric
    
    Specified by:
    
    getMetric in interface RiverContext
    
    Returns:
    metric
  - setAutoCommit
```
public SimpleRiverContext setAutoCommit(boolean autocommit)
```
    Description copied from interface: RiverContext
    
    Set auto commit
    
    Specified by:
    
    setAutoCommit in interface RiverContext
    
    Parameters:
    autocommit - true if automatic commit should be performed
    
    Returns:
    this river context
  - getAutoCommit
```
public boolean getAutoCommit()
```
  - setFetchSize
```
public SimpleRiverContext setFetchSize(int fetchSize)
```
    Description copied from interface: RiverContext
    
    Set fetch size
    
    Specified by:
    
    setFetchSize in interface RiverContext
    
    Parameters:
    fetchSize - fetch size
    
    Returns:
    this river context
  - getFetchSize
```
public int getFetchSize()
```
  - setMaxRows
```
public SimpleRiverContext setMaxRows(int maxRows)
```
    Description copied from interface: RiverContext
    
    Set max rows
    
    Specified by:
    
    setMaxRows in interface RiverContext
    
    Parameters:
    maxRows - max rows
    
    Returns:
    this river context
  - getMaxRows
```
public int getMaxRows()
```
  - setRetries
```
public SimpleRiverContext setRetries(int retries)
```
    Description copied from interface: RiverContext
    
    Set retries
    
    Specified by:
    
    setRetries in interface RiverContext
    
    Parameters:
    retries - number of retries
    
    Returns:
    this river context
  - getRetries
```
public int getRetries()
```
  - setMaxRetryWait
```
public SimpleRiverContext setMaxRetryWait(org.elasticsearch.common.unit.TimeValue maxretrywait)
```
    Description copied from interface: RiverContext
    
    Set maximum count of retries
    
    Specified by:
    
    setMaxRetryWait in interface RiverContext
    
    Parameters:
    maxretrywait - maximum count of retries
    
    Returns:
    this river context
  - getMaxRetryWait
```
public org.elasticsearch.common.unit.TimeValue getMaxRetryWait()
```
  - setRounding
```
public SimpleRiverContext setRounding(String rounding)
```
    Description copied from interface: RiverContext
    
    Set rounding of big decimal values. See java.math.BigDecimal#setScale
    
    Specified by:
    
    setRounding in interface RiverContext
    
    Parameters:
    rounding - the rounding of big decimal values
    
    Returns:
    this river context
  - getRounding
```
public int getRounding()
```
  - setScale
```
public SimpleRiverContext setScale(int scale)
```
    Description copied from interface: RiverContext
    
    Set scale of big decimal values. See java.math.BigDecimal#setScale
    
    Specified by:
    
    setScale in interface RiverContext
    
    Parameters:
    scale - the scale of big decimal values
    
    Returns:
    this context
  - getScale
```
public int getScale()
```
  - setResultSetType
```
public SimpleRiverContext setResultSetType(String resultSetType)
```
    Description copied from interface: RiverContext
    
    Set result set type
    
    Specified by:
    
    setResultSetType in interface RiverContext
    
    Parameters:
    resultSetType - result set type
    
    Returns:
    this river context
  - getResultSetType
```
public String getResultSetType()
```
  - setResultSetConcurrency
```
public SimpleRiverContext setResultSetConcurrency(String resultSetConcurrency)
```
    Description copied from interface: RiverContext
    
    Set result set concurrency
    
    Specified by:
    
    setResultSetConcurrency in interface RiverContext
    
    Parameters:
    resultSetConcurrency - result set concurrency
    
    Returns:
    this river context
  - getResultSetConcurrency
```
public String getResultSetConcurrency()
```
  - shouldIgnoreNull
```
public SimpleRiverContext shouldIgnoreNull(boolean shouldIgnoreNull)
```
    Description copied from interface: RiverContext
    
    Should null values in columns be ignored for indexing
    
    Specified by:
    
    shouldIgnoreNull in interface RiverContext
    
    Parameters:
    shouldIgnoreNull - true if null values in columns should be ignored for indexing
    
    Returns:
    this river context
  - shouldIgnoreNull
```
public boolean shouldIgnoreNull()
```
  - shouldPrepareResultSetMetadata
```
public SimpleRiverContext shouldPrepareResultSetMetadata(boolean shouldPrepareResultSetMetadata)
```
    Description copied from interface: RiverContext
    
    Should result set metadata be used in parameter variables
    
    Specified by:
    
    shouldPrepareResultSetMetadata in interface RiverContext
    
    Parameters:
    shouldPrepareResultSetMetadata - true if result set metadata should be used in parameter variables
    
    Returns:
    this river context
  - shouldPrepareResultSetMetadata
```
public boolean shouldPrepareResultSetMetadata()
```
  - shouldPrepareDatabaseMetadata
```
public SimpleRiverContext shouldPrepareDatabaseMetadata(boolean shouldPrepareDatabaseMetadata)
```
    Description copied from interface: RiverContext
    
    Should database metadata be used in parameter variables
    
    Specified by:
    
    shouldPrepareDatabaseMetadata in interface RiverContext
    
    Parameters:
    shouldPrepareDatabaseMetadata - true if database metadata should be used in parameter variables
    
    Returns:
    this river context
  - shouldPrepareDatabaseMetadata
```
public boolean shouldPrepareDatabaseMetadata()
```
  - setLastResultSetMetadata
```
public SimpleRiverContext setLastResultSetMetadata(Map<String,Object> lastResultSetMetadata)
```
  - getLastResultSetMetadata
```
public Map<String,Object> getLastResultSetMetadata()
```
  - setLastDatabaseMetadata
```
public SimpleRiverContext setLastDatabaseMetadata(Map<String,Object> lastDatabaseMetadata)
```
  - getLastDatabaseMetadata
```
public Map<String,Object> getLastDatabaseMetadata()
```
  - setLastRowCount
```
public SimpleRiverContext setLastRowCount(long lastRowCount)
```
  - getLastRowCount
```
public long getLastRowCount()
```
  - setLastStartDate
```
public SimpleRiverContext setLastStartDate(long lastStartDate)
```
  - getLastStartDate
```
public long getLastStartDate()
```
  - setLastEndDate
```
public SimpleRiverContext setLastEndDate(long lastEndDate)
```
  - getLastEndDate
```
public long getLastEndDate()
```
  - setLastExecutionStartDate
```
public SimpleRiverContext setLastExecutionStartDate(long lastExecutionStartDate)
```
  - getLastExecutionStartDate
```
public long getLastExecutionStartDate()
```
  - setLastExecutionEndDate
```
public SimpleRiverContext setLastExecutionEndDate(long lastExecutionEndDate)
```
  - getLastExecutionEndDate
```
public long getLastExecutionEndDate()
```
  - setColumnNameMap
```
public SimpleRiverContext setColumnNameMap(Map<String,Object> columnNameMap)
```
    Description copied from interface: RiverContext
    
    Set column name map. Useful for expanding shortcolumn names to longer variants.
    
    Specified by:
    
    setColumnNameMap in interface RiverContext
    
    Parameters:
    columnNameMap - the column name map
    
    Returns:
    this river context
  - getColumnNameMap
```
public Map<String,Object> getColumnNameMap()
```
  - setLastRow
```
public SimpleRiverContext setLastRow(Map<String,Object> lastRow)
```
  - getLastRow
```
public Map<String,Object> getLastRow()
```
  - setStatements
```
public SimpleRiverContext setStatements(List<SQLCommand> sql)
```
    Description copied from interface: RiverContext
    
    Set the list of SQL statements
    
    Specified by:
    
    setStatements in interface RiverContext
    
    Parameters:
    sql - the list of SQL statements
    
    Returns:
    this river context
  - getStatements
```
public List<SQLCommand> getStatements()
```
  - setTimestampDiffSupported
```
public SimpleRiverContext setTimestampDiffSupported(boolean supported)
```
  - isTimestampDiffSupported
```
public boolean isTimestampDiffSupported()
```
  - setQueryTimeout
```
public SimpleRiverContext setQueryTimeout(int queryTimeout)
```
    Description copied from interface: RiverContext
    
    Set result set query timeout
    
    Specified by:
    
    setQueryTimeout in interface RiverContext
    
    Parameters:
    queryTimeout - the query timeout in seconds
    
    Returns:
    this river context
  - getQueryTimeout
```
public int getQueryTimeout()
```
  - setConnectionProperties
```
public SimpleRiverContext setConnectionProperties(Map<String,Object> connectionProperties)
```
    Description copied from interface: RiverContext
    
    Optional JDBC connection properties
    
    Specified by:
    
    setConnectionProperties in interface RiverContext
    
    Parameters:
    connectionProperties - connection properties
    
    Returns:
    this river context
  - getConnectionProperties
```
public Map<String,Object> getConnectionProperties()
```
  - shouldTreatBinaryAsString
```
public SimpleRiverContext shouldTreatBinaryAsString(boolean shouldTreatBinaryAsString)
```
    Description copied from interface: RiverContext
    
    Should binary types (byte arrays) be treated as JSON strings
    
    Specified by:
    
    shouldTreatBinaryAsString in interface RiverContext
    
    Parameters:
    shouldTreatBinaryAsString - true if binary types (byte arrays) should be treated as JSON strings
    
    Returns:
    this river context
  - shouldTreatBinaryAsString
```
public boolean shouldTreatBinaryAsString()
```
  - release
```
public SimpleRiverContext release()
```
    Description copied from interface: RiverContext
    
    Release all resources
    
    Specified by:
    
    release in interface RiverContext
    
    Returns:
    this river context
  - asMap
```
public Map<String,Object> asMap()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SimpleRiverContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleRiverContext

Method Detail

setDefinition

getDefinition

setRiverState

getRiverState

setRiverSource

getRiverSource

setRiverMouth

getRiverMouth

setMetric

getMetric

setAutoCommit

getAutoCommit

setFetchSize

getFetchSize

setMaxRows

getMaxRows

setRetries

getRetries

setMaxRetryWait

getMaxRetryWait

setRounding

getRounding

setScale

getScale

setResultSetType

getResultSetType

setResultSetConcurrency

getResultSetConcurrency

shouldIgnoreNull

shouldIgnoreNull

shouldPrepareResultSetMetadata

shouldPrepareResultSetMetadata

shouldPrepareDatabaseMetadata

shouldPrepareDatabaseMetadata

setLastResultSetMetadata

getLastResultSetMetadata

setLastDatabaseMetadata

getLastDatabaseMetadata

setLastRowCount

getLastRowCount

setLastStartDate

getLastStartDate

setLastEndDate

getLastEndDate

setLastExecutionStartDate

getLastExecutionStartDate

setLastExecutionEndDate

getLastExecutionEndDate

setColumnNameMap

getColumnNameMap

setLastRow

getLastRow

setStatements

getStatements

setTimestampDiffSupported

isTimestampDiffSupported

setQueryTimeout

getQueryTimeout

setConnectionProperties

getConnectionProperties

shouldTreatBinaryAsString

shouldTreatBinaryAsString

release

asMap

toString