SimpleRiverSource (elasticsearch-river-jdbc 1.3.4.0 API)

java.lang.Object
- org.xbib.elasticsearch.river.jdbc.strategy.simple.SimpleRiverSource<RC>

All Implemented Interfaces:

RiverSource<RC>

Direct Known Subclasses:

ColumnRiverSource
```
public class SimpleRiverSource<RC extends SimpleRiverContext>
extends Object
implements RiverSource<RC>
```
Simple river source implementation. The simple river source iterates through a JDBC result set, merges the rows into Elasticsearch documents, and passes them to a bulk indexer. There are two channels open, one for reading the database, one for writing.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Calendar`	`calendar`
`protected RC`	`context`
`protected org.elasticsearch.common.joda.time.DateTimeZone`	`dateTimeZone`
`protected Locale`	`locale`
`protected String`	`password`
`protected Connection`	`readConnection`
`protected boolean`	`suspended`
`protected TimeZone`	`timezone`
`protected String`	`url`
`protected String`	`user`
`protected Connection`	`writeConnection`

Constructor Summary

Constructors
Constructor and Description

SimpleRiverSource()

Constructors
Constructor and Description
`SimpleRiverSource()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterFetch()` Executed after fetch() has been executed or threw an exception.
`void`	`afterRows(ResultSet results, KeyValueStreamListener listener)` Executed after all rows have been fetched from result set
`void`	`afterRows(SQLCommand command, ResultSet results, KeyValueStreamListener listener)` After the rows keys and values, let the listener know about the end of the result set.
`void`	`beforeFetch()` Executed before fetch() is executed
`void`	`beforeRows(ResultSet results, KeyValueStreamListener listener)` Executed before rows are fetched from result set
`void`	`beforeRows(SQLCommand command, ResultSet results, KeyValueStreamListener listener)` Before rows are read, let the KeyValueStreamListener know about the keys.
`SimpleRiverSource`	`bind(PreparedStatement statement, List<Object> values)` Bind values to prepared statement
`SimpleRiverSource`	`close(ResultSet result)` Close result set
`SimpleRiverSource`	`close(Statement statement)` Close statement
`SimpleRiverSource`	`closeReading()` Close read connection
`SimpleRiverSource`	`closeWriting()` Close read connection
`ResultSet`	`executeQuery(PreparedStatement statement)` Execute prepared query statement
`ResultSet`	`executeQuery(Statement statement, String sql)` Execute query statement
`RiverSource`	`executeUpdate(PreparedStatement statement)` Execute prepared update statement
`RiverSource`	`executeUpdate(Statement statement, String sql)` Execute prepared update statement
`void`	`fetch()` River fetch.
`Connection`	`getConnectionForReading()` Get JDBC connection for reading
`Connection`	`getConnectionForWriting()` Get JDBC connection for writing.
`Locale`	`getLocale()` Get the current locale
`TimeZone`	`getTimeZone()` Get the current timezone of this river source for the JDBC setTimestamp() call
`String`	`getUrl()`
`protected void`	`merge(SQLCommand command, ResultSet results, KeyValueStreamListener listener)` Merge key/values from JDBC result set
`SimpleRiverSource<RC>`	`newInstance()` Create new river source instance
`boolean`	`nextRow(ResultSet results, KeyValueStreamListener listener)` Executed when next row is fetched from result set
`boolean`	`nextRow(SQLCommand command, ResultSet results, KeyValueStreamListener listener)` Get next row and prepare the values for processing.
`Object`	`parseType(ResultSet result, Integer i, int type, Locale locale)` Parse of value of result set
`PreparedStatement`	`prepareQuery(String sql)` Prepare a query statement
`PreparedStatement`	`prepareUpdate(String sql)` Prepare an update statement
`SimpleRiverSource`	`register(CallableStatement statement, Map<String,Object> values)` Register variables in callable statement
`void`	`resume()` Resume river source
`SimpleRiverSource`	`setLocale(Locale locale)` Set the locale for JDBC
`SimpleRiverSource`	`setPassword(String password)` Set the password authentication
`SimpleRiverSource`	`setRiverContext(RC context)` Set the river context
`SimpleRiverSource`	`setTimeZone(TimeZone timezone)` Set the timezone for JDBC setTimestamp() calls with calendar object.
`SimpleRiverSource`	`setUrl(String url)` Set JDBC connection URL
`SimpleRiverSource`	`setUser(String user)` Set the user authentication
`void`	`shutdown()` Shutdown source
`String`	`strategy()` The strategy this river source supports.
`void`	`suspend()` Suspend river source

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

- Field Detail
  - context
```
protected RC extends SimpleRiverContext context
```
  - url
```
protected String url
```
  - user
```
protected String user
```
  - password
```
protected String password
```
  - readConnection
```
protected Connection readConnection
```
  - writeConnection
```
protected Connection writeConnection
```
  - locale
```
protected Locale locale
```
  - timezone
```
protected TimeZone timezone
```
  - calendar
```
protected Calendar calendar
```
  - dateTimeZone
```
protected org.elasticsearch.common.joda.time.DateTimeZone dateTimeZone
```
  - suspended
```
protected volatile boolean suspended
```
- Constructor Detail
  - SimpleRiverSource
```
public SimpleRiverSource()
```
- Method Detail
  - strategy
```
public String strategy()
```
    Description copied from interface: RiverSource
    
    The strategy this river source supports.
    
    Specified by:
    
    strategy in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    the strategy as a string
  - newInstance
```
public SimpleRiverSource<RC> newInstance()
```
    Description copied from interface: RiverSource
    
    Create new river source instance
    
    Specified by:
    
    newInstance in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    a new river source instance
  - setRiverContext
```
public SimpleRiverSource setRiverContext(RC context)
```
    Description copied from interface: RiverSource
    
    Set the river context
    
    Specified by:
    
    setRiverContext in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    context - the context
    
    Returns:
    this river source
  - setUrl
```
public SimpleRiverSource setUrl(String url)
```
    Description copied from interface: RiverSource
    
    Set JDBC connection URL
    
    Specified by:
    
    setUrl in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    url - the JDBC connection URL
    
    Returns:
    this river source
  - getUrl
```
public String getUrl()
```
  - setUser
```
public SimpleRiverSource setUser(String user)
```
    Description copied from interface: RiverSource
    
    Set the user authentication
    
    Specified by:
    
    setUser in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    user - the user
    
    Returns:
    this river source
  - setPassword
```
public SimpleRiverSource setPassword(String password)
```
    Description copied from interface: RiverSource
    
    Set the password authentication
    
    Specified by:
    
    setPassword in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    password - the password
    
    Returns:
    this river source
  - setLocale
```
public SimpleRiverSource setLocale(Locale locale)
```
    Description copied from interface: RiverSource
    
    Set the locale for JDBC
    
    Specified by:
    
    setLocale in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    locale - locale
    
    Returns:
    this river source
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: RiverSource
    
    Get the current locale
    
    Specified by:
    
    getLocale in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    the time zone
  - setTimeZone
```
public SimpleRiverSource setTimeZone(TimeZone timezone)
```
    Description copied from interface: RiverSource
    
    Set the timezone for JDBC setTimestamp() calls with calendar object.
    
    Specified by:
    
    setTimeZone in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    timezone - the time zone
    
    Returns:
    this river source
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Description copied from interface: RiverSource
    
    Get the current timezone of this river source for the JDBC setTimestamp() call
    
    Specified by:
    
    getTimeZone in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    the time zone
  - suspend
```
public void suspend()
```
    Description copied from interface: RiverSource
    
    Suspend river source
    
    Specified by:
    
    suspend in interface RiverSource<RC extends SimpleRiverContext>
  - resume
```
public void resume()
```
    Description copied from interface: RiverSource
    
    Resume river source
    
    Specified by:
    
    resume in interface RiverSource<RC extends SimpleRiverContext>
  - getConnectionForReading
```
public Connection getConnectionForReading()
                                   throws SQLException
```
    Get JDBC connection for reading
    
    Specified by:
    
    getConnectionForReading in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    the connection
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - getConnectionForWriting
```
public Connection getConnectionForWriting()
                                   throws SQLException
```
    Get JDBC connection for writing. FOr executing "update", "insert", callable statements
    
    Specified by:
    
    getConnectionForWriting in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    the connection
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - beforeFetch
```
public void beforeFetch()
                 throws Exception
```
    Description copied from interface: RiverSource
    
    Executed before fetch() is executed
    
    Specified by:
    
    beforeFetch in interface RiverSource<RC extends SimpleRiverContext>
    
    Throws:
    
    Exception
  - fetch
```
public void fetch()
           throws SQLException,
                  IOException
```
    River fetch. Issue a series of SQL statements.
    
    Specified by:
    
    fetch in interface RiverSource<RC extends SimpleRiverContext>
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
  - afterFetch
```
public void afterFetch()
                throws Exception
```
    Description copied from interface: RiverSource
    
    Executed after fetch() has been executed or threw an exception.
    
    Specified by:
    
    afterFetch in interface RiverSource<RC extends SimpleRiverContext>
    
    Throws:
    
    Exception
  - shutdown
```
public void shutdown()
```
    Description copied from interface: RiverSource
    
    Shutdown source
    
    Specified by:
    
    shutdown in interface RiverSource<RC extends SimpleRiverContext>
  - merge
```
protected void merge(SQLCommand command,
         ResultSet results,
         KeyValueStreamListener listener)
              throws SQLException,
                     IOException,
                     ParseException
```
    Merge key/values from JDBC result set
    
    Parameters:
    results - result set
    listener - the value listener
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
    
    ParseException
  - prepareQuery
```
public PreparedStatement prepareQuery(String sql)
                               throws SQLException
```
    Prepare a query statement
    
    Specified by:
    
    prepareQuery in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    sql - the SQL statement
    
    Returns:
    a prepared statement
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - prepareUpdate
```
public PreparedStatement prepareUpdate(String sql)
                                throws SQLException
```
    Prepare an update statement
    
    Specified by:
    
    prepareUpdate in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    sql - the SQL statement
    
    Returns:
    a prepared statement
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - bind
```
public SimpleRiverSource bind(PreparedStatement statement,
                     List<Object> values)
                       throws SQLException
```
    Bind values to prepared statement
    
    Specified by:
    
    bind in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the prepared statement
    values - the values to bind
    
    Returns:
    this river source
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - register
```
public SimpleRiverSource register(CallableStatement statement,
                         Map<String,Object> values)
                           throws SQLException
```
    Register variables in callable statement
    
    Specified by:
    
    register in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - callable statement
    values - values
    
    Returns:
    this river source
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - executeQuery
```
public ResultSet executeQuery(PreparedStatement statement)
                       throws SQLException
```
    Execute prepared query statement
    
    Specified by:
    
    executeQuery in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the prepared statement
    
    Returns:
    the result set
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - executeQuery
```
public ResultSet executeQuery(Statement statement,
                     String sql)
                       throws SQLException
```
    Execute query statement
    
    Specified by:
    
    executeQuery in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the statement
    sql - the SQL
    
    Returns:
    the result set
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - executeUpdate
```
public RiverSource executeUpdate(PreparedStatement statement)
                          throws SQLException
```
    Execute prepared update statement
    
    Specified by:
    
    executeUpdate in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the prepared statement
    
    Returns:
    the result set
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - executeUpdate
```
public RiverSource executeUpdate(Statement statement,
                        String sql)
                          throws SQLException
```
    Execute prepared update statement
    
    Specified by:
    
    executeUpdate in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the prepared statement
    sql - SQL query
    
    Returns:
    the result set
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - beforeRows
```
public void beforeRows(ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException
```
    Description copied from interface: RiverSource
    
    Executed before rows are fetched from result set
    
    Specified by:
    
    beforeRows in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    results - the result set
    listener - a result set listener or null
    
    Throws:
    
    SQLException
    
    IOException
  - beforeRows
```
public void beforeRows(SQLCommand command,
              ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException
```
    Before rows are read, let the KeyValueStreamListener know about the keys. If the SQL command was a callable statement and a register is there, look into the register map for the key names, not in the result set metadata.
    
    Specified by:
    
    beforeRows in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    command - the SQL command that created this result set
    results - the result set
    listener - the key/value stream listener
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
  - nextRow
```
public boolean nextRow(ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException
```
    Description copied from interface: RiverSource
    
    Executed when next row is fetched from result set
    
    Specified by:
    
    nextRow in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    results - the result set
    listener - a result set listener or null
    
    Returns:
    true if next row could be processed, otherwise false
    
    Throws:
    
    SQLException
    
    IOException
  - nextRow
```
public boolean nextRow(SQLCommand command,
              ResultSet results,
              KeyValueStreamListener listener)
                throws SQLException,
                       IOException
```
    Get next row and prepare the values for processing. The labels of each columns are used for the ValueListener as paths for JSON object merging.
    
    Specified by:
    
    nextRow in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    command - the SQL command that created this result set
    results - the result set
    listener - the listener
    
    Returns:
    true if row exists and was processed, false otherwise
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
  - afterRows
```
public void afterRows(ResultSet results,
             KeyValueStreamListener listener)
               throws SQLException,
                      IOException
```
    Description copied from interface: RiverSource
    
    Executed after all rows have been fetched from result set
    
    Specified by:
    
    afterRows in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    results - the result set
    listener - a result set listener or null
    
    Throws:
    
    SQLException
    
    IOException
  - afterRows
```
public void afterRows(SQLCommand command,
             ResultSet results,
             KeyValueStreamListener listener)
               throws SQLException,
                      IOException
```
    After the rows keys and values, let the listener know about the end of the result set.
    
    Specified by:
    
    afterRows in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    command - the SQL command that created this result set
    results - the result set
    listener - the key/value stream listener
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
  - close
```
public SimpleRiverSource close(ResultSet result)
                        throws SQLException
```
    Close result set
    
    Specified by:
    
    close in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    result - the result set to be closed or null
    
    Returns:
    this river source
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - close
```
public SimpleRiverSource close(Statement statement)
                        throws SQLException
```
    Close statement
    
    Specified by:
    
    close in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    statement - the statement to be closed or null
    
    Returns:
    this river source
    
    Throws:
    
    SQLException - when SQL execution gives an error
  - closeReading
```
public SimpleRiverSource closeReading()
```
    Close read connection
    
    Specified by:
    
    closeReading in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    this river source
  - closeWriting
```
public SimpleRiverSource closeWriting()
```
    Close read connection
    
    Specified by:
    
    closeWriting in interface RiverSource<RC extends SimpleRiverContext>
    
    Returns:
    this river source
  - parseType
```
public Object parseType(ResultSet result,
               Integer i,
               int type,
               Locale locale)
                 throws SQLException,
                        IOException,
                        ParseException
```
    Parse of value of result set
    
    Specified by:
    
    parseType in interface RiverSource<RC extends SimpleRiverContext>
    
    Parameters:
    result - the result set
    i - the offset in the result set
    type - the JDBC type
    locale - the locale to use for parsing
    
    Returns:
    The parse value
    
    Throws:
    
    SQLException - when SQL execution gives an error
    
    IOException - when input/output error occurs
    
    ParseException - if number format could not be parsed

Class SimpleRiverSource<RC extends SimpleRiverContext>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

url

user

password

readConnection

writeConnection

locale

timezone

calendar

dateTimeZone

suspended

Constructor Detail

SimpleRiverSource

Method Detail

strategy

newInstance

setRiverContext

setUrl

getUrl

setUser

setPassword

setLocale

getLocale

setTimeZone

getTimeZone

suspend

resume

getConnectionForReading

getConnectionForWriting

beforeFetch

fetch

afterFetch

shutdown

merge

prepareQuery

prepareUpdate

bind

register

executeQuery

executeQuery

executeUpdate

executeUpdate

beforeRows

beforeRows

nextRow

nextRow

afterRows

afterRows

close

close

closeReading

closeWriting

parseType