SqlOperation (sormula)

java.lang.Object
- org.sormula.operation.SqlOperation<R>

Type Parameters:

R - class type which contains members for columns of a row in a table

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ModifyOperation, ScalarSelectOperation
```
public abstract class SqlOperation<R>
extends java.lang.Object
implements java.lang.AutoCloseable
```
Base class for all database operations.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

SqlOperation(Table<R> table)
Constructs for a table.

Constructors
Constructor and Description
`SqlOperation(Table<R> table)` Constructs for a table.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Requests cancel for currently executing statement.
`protected void`	`cascade(R row, boolean post)` Executes all cascade operations that were created by `prepareCascades()`.
`void`	`close()` Cleans up after operation is no longer needed.
`protected void`	`closeCascades()` Closes the `CascadeOperation` objects for this operation.
`protected void`	`closeStatement()` Closes the prepared statement for this operation.
`protected RowField<R,?>`	`createRowField(Table<R> targetTable, java.lang.reflect.Field field)` Creates a `RowField` from a `Field` and `Table`.
`abstract void`	`execute()` Invokes an execute method on a prepared statement.
`protected java.lang.String`	`getBaseSql()` Gets the sql used by this operation.
`int`	`getCascadeDepth()` Gets the depth of the cascade graph relative to the root cascade operation.
`protected java.sql.Connection`	`getConnection()` Gets the JDBC connection from the `Database` associated with this operation.
`java.lang.String`	`getCustomSql()` Gets custom sql set with `setCustomSql(String)`.
`java.util.Map<java.lang.String,java.lang.Object>`	`getNamedParameterMap()` Gets map of all named parameters.
`protected int`	`getNextParameter()` Gets the next JDBC parameter number used by `PreparedStatement` to set parameters.
`OperationTime`	`getOperationTime()` Gets the timings for this operation that have accumulated since `setTimings(boolean)` have been enabled.
`java.lang.Object`	`getParameter(java.lang.String name)` Gets value of named parameter that was set with `setParameter(String, Object)` or `setNamedParameterMap(Map)`.
`java.lang.Object[]`	`getParameters()` Gets parameters that were set by `setParameters(Object...)`.
`java.lang.String`	`getPreparedSql()` Gets sql that was used in `prepare()`.
`protected java.sql.PreparedStatement`	`getPreparedStatement()` Gets the prepared statement used by this operation.
`int`	`getQueryTimeout()` Gets the number of seconds the driver will wait for a Statement object to execute.
`java.lang.String[]`	`getRequiredCascades()` Gets the required cascade names.
`protected java.lang.String`	`getSql()` Gets full sql statement to prepare.
`Table<R>`	`getTable()` Gets the table provided in the constructor.
`protected Table<?>`	`getTargetTable(java.lang.Class<?> targetClass)` Gets a table object from database associated with this operation.
`java.lang.String`	`getTimingId()` Gets the timing id for this operation.
`Where`	`getWhereAnnotation()` Gets the where annotation in use by this operation.
`java.lang.String`	`getWhereConditionName()` Gets where condition name supplied in `setWhere(String)`
`AbstractWhereTranslator<R>`	`getWhereTranslator()` Gets the translator to map row object values into where condition.
`protected void`	`initOperationTime()` Initializes `OperationTime` object that will record elapsed times for this operation.
`boolean`	`isCached()` Gets the caching mode.
`boolean`	`isCascade()` Gets cascade status.
`protected boolean`	`isCascading()` Indicates that cascades will occur with this operation.
`boolean`	`isIncludeIdentityColumns()` Tests if identity columns are used in this operation.
`boolean`	`isPrimaryKey()` Gets primary key status.
`boolean`	`isReadOnly()` Gets read-only indicator.
`boolean`	`isRequiredCascade(java.lang.String cascadeName)` Tests if a cascade name equals current required cascade names.
`boolean`	`isTimings()`
`void`	`logTimings()` Logs current timings for this operation to log.
`protected void`	`prepare()` Creates prepared statement for this operation and invokes `prepareCascades()` to prepare statements for any cascade operations.
`protected void`	`prepareCascades()` Prepares cascades for all cascade annotations on row class.
`protected abstract java.util.List<CascadeOperation<R,?>>`	`prepareCascades(java.lang.reflect.Field field)` Creates and prepares cascade operations based upon cascade annotations for a field.
`protected void`	`prepareCheck()` Prepares statement with `prepare()` if it is null.
`protected java.sql.PreparedStatement`	`prepareStatement()` Creates the prepared statement.
`protected void`	`setBaseSql(java.lang.String sql)` Sets the base sql used by this operation.
`void`	`setCached(boolean cached)` Sets the cache mode for this operation.
`void`	`setCascade(boolean cascade)` Sets whether cascades are enabled for this operation.
`void`	`setCascadeDepth(int cascadeDepth)` Sets the cascade depth.
`void`	`setCustomSql(java.lang.String customSql)` Sets sql to be appended to base sql in operation.
`void`	`setIncludeIdentityColumns(boolean includeIdentityColumns)` Sets when to generate identity columns.
`void`	`setNamedParameterMap(java.util.Map<java.lang.String,java.lang.Object> namedParameterMap)` Sets all named parameters replacing any previously set with `setParameter(String, Object)`.
`protected void`	`setNextParameter(int nextParameter)` Sets the next column index to use in `PreparedStatement`.
`void`	`setParameter(java.lang.String name, java.lang.Object value)` Sets a named parameter value.
`void`	`setParameters(java.lang.Object... parameters)` Sets any parameters to be used by operation.
`void`	`setQueryTimeout(int queryTimeout)` Sets the number of seconds the driver will wait for a Statement object to execute.
`void`	`setReadOnly(boolean readOnly)` Sets read-only indicator.
`void`	`setRequiredCascades(java.lang.String... cascadeNames)` Sets the name(s) of cascades that should occur with this operation.
`void`	`setTimingId(java.lang.String timingId)` Sets the id for the operation times `getOperationTime()`.
`void`	`setTimings(boolean on)` Enables timings for this operation.
`void`	`setWhere(java.lang.String whereConditionName)` Sets where condition from annotation name as defined in `Where.name()` for row.
`void`	`setWhereTranslator(AbstractWhereTranslator<R> whereTranslator)` Sets the translator to map row object values into where condition.
`protected void`	`writeColumns(R row)` Sets all column parameters from a row using the table's `RowTranslator`.
`protected <T> void`	`writeParameter(int parameterIndex, T parameter)` Sets parameter on prepared statement using the appropriate `TypeTranslator`.
`protected void`	`writeParameters()` Prepares statement and then sets all parameters with `writeParameter(int, Object)`.
`protected void`	`writeWhere(R row)` Sets all where parameters from a row using the table's `WhereTranslator`.

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

- Constructor Detail
  - SqlOperation
```
public SqlOperation(Table<R> table)
             throws OperationException
```
    Constructs for a table.
    The operation timings default to the current state of the database Database.isTimings(). If timings are enabled for database then all operations will be timed unless explicitly disabled. Operation will be read only setReadOnly(boolean) if either Database.isReadOnly() or Table.isReadOnly() are true.
    
    Parameters:
    
    table - operations are performed on this table
    
    Throws:
    
    OperationException - if error
- Method Detail
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.Object value)
```
    Sets a named parameter value.
    Named parameters are used when no positional parameters are set with setParameters(Object...). When no positional parameters are available, getParameter(String) is used to get parameter values for all fields defined by Where using Where.fieldNames() or WhereField.name() as named parameter key.
    Named parameters are also looked up for cascades when SelectCascade.sourceParameterFieldNames() contains any field names that begin with dollar ($). symbol. Named parameter map is supplied for all cascade levels so that any level can get value from map.
    
    Parameters:
    
    name - name of parameter
    
    value - value of named parameter
    
    Since:
    
    3.1
  - getParameter
```
public java.lang.Object getParameter(java.lang.String name)
```
    Gets value of named parameter that was set with setParameter(String, Object) or setNamedParameterMap(Map).
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    parameter value or null if no value for name
    
    Since:
    
    3.1
  - setParameters
```
public void setParameters(java.lang.Object... parameters)
```
    Sets any parameters to be used by operation. Parameters must be in the same order as defined by Column.primaryKey() or Where annotation or Row.primaryKeyFields().
    
    Parameters:
    
    parameters - parameters as objects (not from row fields)
  - getParameters
```
public java.lang.Object[] getParameters()
```
    Gets parameters that were set by setParameters(Object...).
    
    Returns:
    
    parameters for this operation
  - getNamedParameterMap
```
public java.util.Map<java.lang.String,java.lang.Object> getNamedParameterMap()
```
    Gets map of all named parameters.
    
    Returns:
    
    map of named parameters (key is parameter name); null for no named parameters
    
    Since:
    
    3.1
  - setNamedParameterMap
```
public void setNamedParameterMap(java.util.Map<java.lang.String,java.lang.Object> namedParameterMap)
```
    Sets all named parameters replacing any previously set with setParameter(String, Object).
    
    Parameters:
    
    namedParameterMap - map of named parameters (key is parameter name); null for no named parameters parameters
    
    Since:
    
    3.1
  - isReadOnly
```
public boolean isReadOnly()
```
    Gets read-only indicator.
    
    Returns:
    
    true if modify operations are not permitted
    
    Since:
    
    1.6 and 2.0
    
    See Also:
    
    Database.isReadOnly()
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Sets read-only indicator. When true, this operation will fail with a ReadOnlyException if it attempts to modify the database. By default read-only is set from the database associated with this operation, Database.isReadOnly(). Set to true as a safe-guard to prevent accidental modification of database.
    
    Parameters:
    
    readOnly - true to prevent modify operations
    
    Since:
    
    1.6 and 2.0
    
    See Also:
    
    Database.setReadOnly(boolean)
  - getQueryTimeout
```
public int getQueryTimeout()
```
    Gets the number of seconds the driver will wait for a Statement object to execute.
    
    Returns:
    
    the current query timeout limit in seconds; zero means there is no limit
    
    Since:
    
    1.9 and 2.3
    
    See Also:
    
    Statement.getQueryTimeout()
  - setQueryTimeout
```
public void setQueryTimeout(int queryTimeout)
```
    Sets the number of seconds the driver will wait for a Statement object to execute. This value is set when statement is prepared in prepare().
    
    Parameters:
    
    queryTimeout - the new query timeout limit in seconds; zero means there is no limit
    
    Since:
    
    1.9 and 2.3
    
    See Also:
    
    Statement.setQueryTimeout(int)
  - getCascadeDepth
```
public int getCascadeDepth()
```
    Gets the depth of the cascade graph relative to the root cascade operation. Root cascade operation is depth 0.
    
    Returns:
    
    cascade depth (0..n)
    
    Since:
    
    4.1
  - setCascadeDepth
```
public void setCascadeDepth(int cascadeDepth)
```
    Sets the cascade depth. Typically set by CascadeOperation
    
    Parameters:
    
    cascadeDepth - 0..n
    
    Since:
    
    4.1
  - isCached
```
public boolean isCached()
```
    Gets the caching mode.
    
    Returns:
    
    true if caching is enabled; false if no caching is performed
    
    Since:
    
    3.0
  - setCached
```
public void setCached(boolean cached)
```
    Sets the cache mode for this operation. True by default. Set to false by WriteOperations when writing cache changes to the database.
    Setting to true enables caching only if Cached annotation is specified for row/table.
    
    Parameters:
    
    cached - true to allow caching; false to prevent caching of rows for this operation
    
    Since:
    
    3.0
  - isCascade
```
public boolean isCascade()
```
    Gets cascade status. Default is true unless turned off by setCascade(boolean).
    
    Returns:
    
    true if cascades are performed; false if cascades are ignored
    
    Since:
    
    3.0
  - setCascade
```
public void setCascade(boolean cascade)
```
    Sets whether cascades are enabled for this operation. Default is true. If false, then cascades will not occur if they are defined for the row.
    Set to false by WriteOperations when writing cache changes to the database since cascades for cached tables are performed at the time the row is put into cache.
    
    Parameters:
    
    cascade - true to perform cascades; false to ignore cascades
    
    Since:
    
    3.0
  - isCascading
```
protected boolean isCascading()
```
    Indicates that cascades will occur with this operation.
    
    Returns:
    
    isCascade() and at least one cascade operation is defined
    
    Since:
    
    3.1
  - writeParameters
```
protected void writeParameters()
                        throws OperationException
```
    Prepares statement and then sets all parameters with writeParameter(int, Object). prepareCheck() or prepare() must be invoked prior to using this method.
    
    Throws:
    
    OperationException - if error
  - writeParameter
```
protected <T> void writeParameter(int parameterIndex,
                                  T parameter)
                           throws java.lang.Exception
```
    Sets parameter on prepared statement using the appropriate TypeTranslator.
    
    Type Parameters:
    
    T - type of parameter
    
    Parameters:
    
    parameterIndex - jdbc prepared statement parameter index
    
    parameter - parameter value
    
    Throws:
    
    java.lang.Exception - if no translator exists for parameter class or error writing parameter
  - execute
```
public abstract void execute()
                      throws OperationException
```
    Invokes an execute method on a prepared statement. The method invoked must be implemented by subclass based upon type of operation. prepareCheck() should be invoked prior to executing sql or use some other means of set up for prepared statement.
    
    Throws:
    
    OperationException - if error
  - cancel
```
public void cancel()
            throws OperationException
```
    Requests cancel for currently executing statement. No synchronization is performed between the thread that invokes this method and other threads that may be modifying this object.
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    1.9 and 2.3
    
    See Also:
    
    Statement.cancel()
  - close
```
public void close()
           throws OperationException
```
    Cleans up after operation is no longer needed. The connection is not closed but all other objects created by this operations are closed. Prepared statement is closed and close method is invoked on all CascadeOperation objects. This method should be invoked when operation is no longer needed for proper JDBC clean up.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    OperationException - if error
  - getTimingId
```
public java.lang.String getTimingId()
```
    Gets the timing id for this operation. If none is set then the default is the hexadecimal string of the hash code of getSql().
    
    Returns:
    
    timing id for this operation
    
    Since:
    
    1.5
  - setTimingId
```
public void setTimingId(java.lang.String timingId)
```
    Sets the id for the operation times getOperationTime(). Typically the default id is sufficient. The id is a key into Database.getOperationTimeMap() which is used to sum multiple instances of timings for this operation.
    Use a custom id to force all operations that use the custom id to be summed into one instance of OperationTime in Database.getOperationTimeMap(). A good custom id to use would be the class name of the class that is using the operation, Class.getName().
    
    Parameters:
    
    timingId - unique id associated with an operation(s)
    
    Since:
    
    1.5
  - setTimings
```
public void setTimings(boolean on)
```
    Enables timings for this operation. When timings are enabled, prepare, write, execute, and read times are recorded. See getOperationTime(). Use logTimings() to write timings to log for this operation. Use Database.logTimings() to write all operation timings to log.
    When on parameter is true, then instance of OperationTime is created at the start of execution for use by this operation. Use getOperationTime() to change default values.
    
    Parameters:
    
    on - true to recording execution times for this operation
    
    Since:
    
    1.5
  - isTimings
```
public boolean isTimings()
```
    Returns:
    
    true if timings are enabled; false if not
    
    Since:
    
    1.5
  - logTimings
```
public void logTimings()
```
    Logs current timings for this operation to log. Alias for OperationTime.logTimings().
    
    Since:
    
    1.5
  - getOperationTime
```
public OperationTime getOperationTime()
```
    Gets the timings for this operation that have accumulated since setTimings(boolean) have been enabled.
    
    Returns:
    
    operation time object containing execution times or NoOperationTime if timings are not enabled
    
    Since:
    
    1.5
  - initOperationTime
```
protected void initOperationTime()
```
    Initializes OperationTime object that will record elapsed times for this operation. This method can't be invoked until timing id and/or sql is known so it is invoked by execute().
  - closeStatement
```
protected void closeStatement()
                       throws OperationException
```
    Closes the prepared statement for this operation.
    
    Throws:
    
    OperationException - if error
  - closeCascades
```
protected void closeCascades()
                      throws OperationException
```
    Closes the CascadeOperation objects for this operation.
    
    Throws:
    
    OperationException - if error
  - prepareCheck
```
protected void prepareCheck()
                     throws OperationException
```
    Prepares statement with prepare() if it is null. Invoke prior to using prepared statement to insure that prepared statement has been set up through Connection.prepareStatement(String). Usually invoked prior to invoking a method on PreparedStatement.
    
    Throws:
    
    OperationException - if error
  - prepare
```
protected void prepare()
                throws OperationException
```
    Creates prepared statement for this operation and invokes prepareCascades() to prepare statements for any cascade operations.
    
    Throws:
    
    OperationException - if error
  - prepareStatement
```
protected java.sql.PreparedStatement prepareStatement()
                                               throws java.sql.SQLException
```
    Creates the prepared statement. Allows for subclasses to override.
    
    Returns:
    
    prepared statement to use for this operation
    
    Throws:
    
    java.sql.SQLException - if error
    
    Since:
    
    4.3
  - prepareCascades
```
protected void prepareCascades()
                        throws OperationException
```
    Prepares cascades for all cascade annotations on row class. Cascade annotations are OneToManyCascade, OneToOneCascade, and Cascade.
    
    Throws:
    
    OperationException - if error
  - prepareCascades
```
protected abstract java.util.List<CascadeOperation<R,?>> prepareCascades(java.lang.reflect.Field field)
                                                                  throws OperationException
```
    Creates and prepares cascade operations based upon cascade annotations for a field.
    
    Parameters:
    
    field - annotation is for this field of row class R
    
    Returns:
    
    list of cascade operations; empty list for none
    
    Throws:
    
    OperationException - if error
  - cascade
```
protected void cascade(R row,
                       boolean post)
                throws OperationException
```
    Executes all cascade operations that were created by prepareCascades().
    
    Parameters:
    
    row - instance of source row
    
    post - true if post cascades are to be executed; false if pre cascades are to be executed
    
    Throws:
    
    OperationException - if error
  - getTargetTable
```
protected Table<?> getTargetTable(java.lang.Class<?> targetClass)
                           throws OperationException
```
    Gets a table object from database associated with this operation.
    
    Parameters:
    
    targetClass - class that cascade is to affect
    
    Returns:
    
    table for target class of annotation
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.4
  - createRowField
```
protected RowField<R,?> createRowField(Table<R> targetTable,
                                       java.lang.reflect.Field field)
                                throws OperationException
```
    Creates a RowField from a Field and Table. Returned RowField will be either MethodAccessField or DirectAccessField based upon values used for Column.fieldAccess() and Row.fieldAccess().
    Typically this method is used to create a field that will receive value from a cascade.
    
    Parameters:
    
    targetTable - table that reads/writes rows that contain field
    
    field - create access to this field
    
    Returns:
    
    MethodAccessField or DirectAccessField annotation(s)
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.4
  - getSql
```
protected java.lang.String getSql()
```
    Gets full sql statement to prepare. Default implementation is to use base sql + custom sql + where sql. Subclasses may override to create more detailed sql.
    
    Returns:
    
    sql to use in prepare()
  - getPreparedSql
```
public java.lang.String getPreparedSql()
```
    Gets sql that was used in prepare().
    
    Returns:
    
    sql that was used in prepared statement
    
    Since:
    
    1.5
  - setCustomSql
```
public void setCustomSql(java.lang.String customSql)
```
    Sets sql to be appended to base sql in operation. Use this to add specialized sql for operation.
    
    Parameters:
    
    customSql - additional sql to be added to base sql or null for none
  - getCustomSql
```
public java.lang.String getCustomSql()
```
    Gets custom sql set with setCustomSql(String).
    
    Returns:
    
    custom sql or null if none
  - getTable
```
public Table<R> getTable()
```
    Gets the table provided in the constructor.
    
    Returns:
    
    table to use in this operation
  - getConnection
```
protected java.sql.Connection getConnection()
```
    Gets the JDBC connection from the Database associated with this operation.
    
    Returns:
    
    Connection
  - setWhere
```
public void setWhere(java.lang.String whereConditionName)
              throws OperationException
```
    Sets where condition from annotation name as defined in Where.name() for row.
    
    Parameters:
    
    whereConditionName - name of where condition to use; "primaryKey" for key defined by Column.primaryKey(), Column.identity(), or Row.primaryKeyFields(); empty string for no where condition
    
    Throws:
    
    OperationException - if error
  - getWhereConditionName
```
public java.lang.String getWhereConditionName()
```
    Gets where condition name supplied in setWhere(String)
    
    Returns:
    
    where condition name
  - getWhereAnnotation
```
public Where getWhereAnnotation()
```
    Gets the where annotation in use by this operation.
    
    Returns:
    
    where annotation set by setWhere(String) or null if none
    
    Since:
    
    3.0
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Gets primary key status.
    
    Returns:
    
    true if where condition for this operation is for primary key
    
    Since:
    
    3.0
  - isIncludeIdentityColumns
```
public boolean isIncludeIdentityColumns()
```
    Tests if identity columns are used in this operation. Default is true. Typically false for insert and update operations.
    
    Returns:
    
    true to include identity columns in sql
    
    See Also:
    
    Column.identity()
  - setIncludeIdentityColumns
```
public void setIncludeIdentityColumns(boolean includeIdentityColumns)
```
    Sets when to generate identity columns. Most operations required that the base base sql be recreated after this method has been used. Typically base sql is recreated with a method like initBaseSql().
    
    Parameters:
    
    includeIdentityColumns - true to include identity columns in sql
  - setRequiredCascades
```
public void setRequiredCascades(java.lang.String... cascadeNames)
```
    Sets the name(s) of cascades that should occur with this operation. Cascades with names that equal any of the names specified in cascadeNames parameter will be executed. The default value for required cascade names is Table.getRequiredCascades().
    For all cascades that are executed, cascadeNames is passed on to the cascade operation so that all cascades for all levels use the same required cascade names.
    The wildcard "*" parameter will result in StackOverflowError if cascade relationships form a cyclic graph and no termination condition exists to end the recursion.
    
    Parameters:
    
    cascadeNames - name(s) of cascades to use; "*" for wildcard to use all cascades
    
    Since:
    
    3.0
  - getRequiredCascades
```
public java.lang.String[] getRequiredCascades()
```
    Gets the required cascade names.
    
    Returns:
    
    names of cascades to use
    
    Since:
    
    3.0
  - isRequiredCascade
```
public boolean isRequiredCascade(java.lang.String cascadeName)
```
    Tests if a cascade name equals current required cascade names.
    
    Parameters:
    
    cascadeName - check this name
    
    Returns:
    
    true if required cascades is a "*" or if cascadeName equals any of the required cascade names
    
    Since:
    
    3.0
  - writeColumns
```
protected void writeColumns(R row)
                     throws OperationException
```
    Sets all column parameters from a row using the table's RowTranslator.
    
    Parameters:
    
    row - get column values from this row
    
    Throws:
    
    OperationException - if error
  - writeWhere
```
protected void writeWhere(R row)
                   throws OperationException
```
    Sets all where parameters from a row using the table's WhereTranslator.
    
    Parameters:
    
    row - get where parameters from this row
    
    Throws:
    
    OperationException - if error
  - getBaseSql
```
protected java.lang.String getBaseSql()
```
    Gets the sql used by this operation. Typically includes command like select, update, insert, delete, and columns. Does not include where, order by, or other additional sql.
    
    Returns:
    
    base sql used by this operation
  - setBaseSql
```
protected void setBaseSql(java.lang.String sql)
```
    Sets the base sql used by this operation. See getBaseSql() for details.
    
    Parameters:
    
    sql - base sql used by this operation
  - getPreparedStatement
```
protected java.sql.PreparedStatement getPreparedStatement()
```
    Gets the prepared statement used by this operation.
    
    Returns:
    
    prepared statement or null if statement has not been prepared
  - getWhereTranslator
```
public AbstractWhereTranslator<R> getWhereTranslator()
```
    Gets the translator to map row object values into where condition.
    
    Returns:
    
    where translator or null if none
  - setWhereTranslator
```
public void setWhereTranslator(AbstractWhereTranslator<R> whereTranslator)
```
    Sets the translator to map row object values into where condition.
    
    Parameters:
    
    whereTranslator - where translator or null if none
  - getNextParameter
```
protected int getNextParameter()
```
    Gets the next JDBC parameter number used by PreparedStatement to set parameters. Parameter number changes as column and where conditions are prepared. Parameter numbers start at 1 and occur for every "?" in the SQL statement. The parameter numbers are used as the first parameter in the various PreparedStatement set methods.
    
    Returns:
    
    the next PreparedStatement parameter to use
  - setNextParameter
```
protected void setNextParameter(int nextParameter)
```
    Sets the next column index to use in PreparedStatement. See getNextParameter() for details.
    
    Parameters:
    
    nextParameter - the next PreparedStatement parameter to use

Class SqlOperation<R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlOperation

Method Detail

setParameter

getParameter

setParameters

getParameters

getNamedParameterMap

setNamedParameterMap

isReadOnly

setReadOnly

getQueryTimeout

setQueryTimeout

getCascadeDepth

setCascadeDepth

isCached

setCached

isCascade

setCascade

isCascading

writeParameters

writeParameter

execute

cancel

close

getTimingId

setTimingId

setTimings

isTimings

logTimings

getOperationTime

initOperationTime

closeStatement

closeCascades

prepareCheck

prepare

prepareStatement

prepareCascades

prepareCascades

cascade

getTargetTable

createRowField

getSql

getPreparedSql

setCustomSql

getCustomSql

getTable

getConnection

setWhere

getWhereConditionName

getWhereAnnotation

isPrimaryKey

isIncludeIdentityColumns

setIncludeIdentityColumns

setRequiredCascades

getRequiredCascades

isRequiredCascade

writeColumns

writeWhere

getBaseSql

setBaseSql

getPreparedStatement

getWhereTranslator

setWhereTranslator

getNextParameter

setNextParameter