AbstractBatchHandler (Quick 1.3 API)

java.lang.Object
- org.hisp.quick.batchhandler.AbstractBatchHandler<T>

All Implemented Interfaces:

BatchHandler<T>
```
public abstract class AbstractBatchHandler<T>
extends Object
implements BatchHandler<T>
```
Abstract class to be extended by concrete batch handler implementations.

Author:

Lars Helge Overland

Field Summary

Fields
Modifier and Type Field and Description

protected StatementBuilder<T> statementBuilder

Fields
Modifier and Type	Field and Description
`protected StatementBuilder<T>`	`statementBuilder`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractBatchHandler(JdbcConfiguration configuration)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractBatchHandler(JdbcConfiguration configuration)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addObject(T object)` Adds an object to the BatchHandler.
`void`	`deleteObject(T object)` Deletes an object.
`T`	`findObject(T arg)` Retrieves an object, using the unique columns of the given object as argument.
`void`	`flush()` Flushes the BatchHandler by executing a potential remaining statement, and closing the underlying statement object and the database connection.
`protected String`	`getAddObjectSql()` Use for testing purposes only.
`abstract String`	`getAutoIncrementColumn()` Returns the database auto-increment column name, null if none.
`abstract List<String>`	`getColumns()` Returns a list of columns for the table of this batch handler.
`JdbcConfiguration`	`getConfiguration()` Returns the current JdbcConfiguration.
`abstract List<String>`	`getIdentifierColumns()` Returns a list of primary key column names.
`abstract List<Object>`	`getIdentifierValues(T object)` Returns a list of values matching the unique columns for the given object.
`protected List<Object>`	`getObjectList(Object... items)` Returns a List of Object items.
`protected List<String>`	`getStringList(String... items)` Returns a List of String items.
`abstract String`	`getTableName()` Returns the database table name.
`abstract List<String>`	`getUniqueColumns()` Returns a list of unique column names.
`abstract List<Object>`	`getUniqueValues(T object)` Returns a list of values matching the unique columns for the given object.
`abstract List<Object>`	`getValues(T object)` Returns a list of values matching the columns for the given object.
`BatchHandler<T>`	`init()` Initializes the BatchHandler by acquiring a database connection, creating a statement object and initializing a SQL statement.
`abstract boolean`	`isInclusiveUniqueColumns()` Indicates whether rows are unique across all unique columns (inclusive) or unique for each individual unique column (exclusive).
`abstract T`	`mapRow(ResultSet resultSet)` Maps a ResultSet row to an object T.
`boolean`	`objectExists(T object)` Checks whether this object exists in the database or not.
`void`	`updateObject(T object)` Updates an object.

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

- Field Detail
  - statementBuilder
```
protected StatementBuilder<T> statementBuilder
```
- Constructor Detail
  - AbstractBatchHandler
```
protected AbstractBatchHandler(JdbcConfiguration configuration)
```
- Method Detail
  - init
```
public final BatchHandler<T> init()
```
    Description copied from interface: BatchHandler
    
    Initializes the BatchHandler by acquiring a database connection, creating a statement object and initializing a SQL statement.
    
    Specified by:
    
    init in interface BatchHandler<T>
    
    Returns:
    
    this batch handler.
  - getConfiguration
```
public JdbcConfiguration getConfiguration()
```
    Description copied from interface: BatchHandler
    
    Returns the current JdbcConfiguration.
    
    Specified by:
    
    getConfiguration in interface BatchHandler<T>
    
    Returns:
    
    jdbc configuration.
  - addObject
```
public final boolean addObject(T object)
```
    Description copied from interface: BatchHandler
    
    Adds an object to the BatchHandler. Checks if the value is a duplicate, i.e. already added to this BatchHandler instance, before adding it.
    
    Specified by:
    
    addObject in interface BatchHandler<T>
    
    Parameters:
    
    object - the object to add.
    
    Returns:
    
    true if the object was added, false if not.
  - findObject
```
public final T findObject(T arg)
```
    Description copied from interface: BatchHandler
    
    Retrieves an object, using the unique columns of the given object as argument.
    
    Specified by:
    
    findObject in interface BatchHandler<T>
    
    Parameters:
    
    arg - the argument object, identifier properties must be populated.
    
    Returns:
    
    an object.
  - updateObject
```
public final void updateObject(T object)
```
    Description copied from interface: BatchHandler
    
    Updates an object.
    
    Specified by:
    
    updateObject in interface BatchHandler<T>
    
    Parameters:
    
    object - the object to update.
  - deleteObject
```
public final void deleteObject(T object)
```
    Description copied from interface: BatchHandler
    
    Deletes an object.
    
    Specified by:
    
    deleteObject in interface BatchHandler<T>
    
    Parameters:
    
    object - the object to delete.
  - objectExists
```
public final boolean objectExists(T object)
```
    Description copied from interface: BatchHandler
    
    Checks whether this object exists in the database or not.
    
    Specified by:
    
    objectExists in interface BatchHandler<T>
    
    Parameters:
    
    object - the object to check.
    
    Returns:
    
    true if the object exists, false if not.
  - flush
```
public final void flush()
```
    Description copied from interface: BatchHandler
    
    Flushes the BatchHandler by executing a potential remaining statement, and closing the underlying statement object and the database connection.
    
    Specified by:
    
    flush in interface BatchHandler<T>
  - getStringList
```
protected List<String> getStringList(String... items)
```
    Returns a List of String items.
    
    Parameters:
    
    items - the items.
    
    Returns:
    
    a List of String items.
  - getObjectList
```
protected List<Object> getObjectList(Object... items)
```
    Returns a List of Object items.
    
    Parameters:
    
    items - the items.
    
    Returns:
    
    a List of Object items.
  - getAddObjectSql
```
protected String getAddObjectSql()
```
    Use for testing purposes only.
    
    Returns:
    
    the add object SQL string.
  - getTableName
```
public abstract String getTableName()
```
    Returns the database table name.
    
    Returns:
    
    the database table name.
  - getAutoIncrementColumn
```
public abstract String getAutoIncrementColumn()
```
    Returns the database auto-increment column name, null if none.
    
    Returns:
    
    the database auto-increment column name, null if none.
  - isInclusiveUniqueColumns
```
public abstract boolean isInclusiveUniqueColumns()
```
    Indicates whether rows are unique across all unique columns (inclusive) or unique for each individual unique column (exclusive).
    
    Returns:
    
    true if rows are unique across unique columns.
  - getIdentifierColumns
```
public abstract List<String> getIdentifierColumns()
```
    Returns a list of primary key column names.
    
    Returns:
    
    a list of primary key column names.
  - getIdentifierValues
```
public abstract List<Object> getIdentifierValues(T object)
```
    Returns a list of values matching the unique columns for the given object.
    
    Parameters:
    
    object - the object.
    
    Returns:
    
    a list of values matching the unique columns for the given object.
  - getUniqueColumns
```
public abstract List<String> getUniqueColumns()
```
    Returns a list of unique column names.
    
    Returns:
    
    a list of unique column names.
  - getUniqueValues
```
public abstract List<Object> getUniqueValues(T object)
```
    Returns a list of values matching the unique columns for the given object.
    
    Parameters:
    
    object - the object.
    
    Returns:
    
    a list of values matching the unique columns for the given object.
  - getColumns
```
public abstract List<String> getColumns()
```
    Returns a list of columns for the table of this batch handler.
    
    Returns:
    
    a list of columns for the table of this batch handler.
  - getValues
```
public abstract List<Object> getValues(T object)
```
    Returns a list of values matching the columns for the given object.
    
    Parameters:
    
    object - the object.
    
    Returns:
    
    a list of values matching the columns for the given object.
  - mapRow
```
public abstract T mapRow(ResultSet resultSet)
                  throws SQLException
```
    Maps a ResultSet row to an object T.
    
    Parameters:
    
    resultSet - the result set.
    
    Returns:
    
    an object T.
    
    Throws:
    
    SQLException - if SQL operation failed.

Class AbstractBatchHandler<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

statementBuilder

Constructor Detail

AbstractBatchHandler

Method Detail

init

getConfiguration

addObject

findObject

updateObject

deleteObject

objectExists

flush

getStringList

getObjectList

getAddObjectSql

getTableName

getAutoIncrementColumn

isInclusiveUniqueColumns

getIdentifierColumns

getIdentifierValues

getUniqueColumns

getUniqueValues

getColumns

getValues

mapRow