org.objectweb.cjdbc.common.sql
Class UpdateRequest

java.lang.Object
  org.objectweb.cjdbc.common.sql.AbstractRequest
      org.objectweb.cjdbc.common.sql.AbstractWriteRequest
          org.objectweb.cjdbc.common.sql.UpdateRequest

All Implemented Interfaces:

java.io.Serializable

public class UpdateRequest

extends AbstractWriteRequest

implements java.io.Serializable

An UpdateRequest is an SQL request with the following syntax:

   UPDATE table-name SET (column-name=expression[,column-name=expression]*) WHERE search-condition
 

Version:

1.0

Author:

Emmanuel Cecchet , Mathieu Peltier

See Also:

Serialized Form

Field Summary

private boolean	isUnique true if this request updates a UNIQUE row.
private java.util.HashMap	updatedValues

Fields inherited from class org.objectweb.cjdbc.common.sql.AbstractWriteRequest

blocking, columns, pkValue, tableName

Fields inherited from class org.objectweb.cjdbc.common.sql.AbstractRequest

cacheable, escapeProcessing, id, isAutoCommit, isParsed, isReadOnly, login, maxRows, sqlQuery, sqlSkeleton, timeout, transactionId

Constructor Summary

UpdateRequest(java.lang.String sqlQuery, boolean escapeProcessing, int timeout, java.lang.String lineSeparator)
Creates a new UpdateRequest instance.

UpdateRequest(java.lang.String sqlQuery, boolean escapeProcessing, int timeout, java.lang.String lineSeparator, DatabaseSchema schema, int granularity, boolean isCaseSensitive)
Creates a new UpdateRequest instance.

Method Summary

void	cloneParsing(AbstractRequest request) Clones the parsing of a request.
void	debug() Displays some debugging information about this request.
java.util.HashMap	getUpdatedValues() What are the updated values in this request
boolean	isAlter() Returns true if this request in a ALTER statement.
boolean	isCreate() Returns true if this request in a CREATE statement.
boolean	isDelete() Returns true if this request in a DELETE statement.
boolean	isDrop() Returns true if this request in a DROP statement.
boolean	isInsert() Returns true if this request in an INSERT statement.
boolean	isUnique() Returns true as this request updates a UNIQUE row.
boolean	isUpdate() Returns true if this request in an UPDATE statement.
void	parse(DatabaseSchema schema, int granularity, boolean isCaseSensitive) Parses the SQL request and extract the selected columns and tables given the DatabaseSchema of the database targeted by this request.

Methods inherited from class org.objectweb.cjdbc.common.sql.AbstractWriteRequest

cloneTableNameAndColumns, getColumns, getPk, getTableName, isReadRequest, isUnknownRequest, isWriteRequest, mightBlock, setBlocking

Methods inherited from class org.objectweb.cjdbc.common.sql.AbstractRequest

equals, getCacheAbility, getEscapeProcessing, getFetchSize, getId, getLineSeparator, getLogin, getMaxRows, getSQL, getSQLShortForm, getSqlSkeleton, getTimeout, getTransactionId, isAutoCommit, isDriverProcessed, isParsed, isReadOnly, setCacheAbility, setDriverProcessed, setFetchSize, setId, setIsAutoCommit, setIsReadOnly, setLineSeparator, setLogin, setMaxRows, setSQL, setSqlSkeleton, setTimeout, setTransactionId, trimCarriageReturn

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isUnique

private transient boolean isUnique

true if this request updates a UNIQUE row.

updatedValues

private transient java.util.HashMap updatedValues

Constructor Detail

UpdateRequest

public UpdateRequest(java.lang.String sqlQuery,
                     boolean escapeProcessing,
                     int timeout,
                     java.lang.String lineSeparator,
                     DatabaseSchema schema,
                     int granularity,
                     boolean isCaseSensitive)
              throws java.sql.SQLException

Creates a new UpdateRequest instance. The caller must give an SQL request, without any leading or trailing spaces and beginning with 'update ' (it will not be checked).

If the syntax is incorrect an exception is thrown.

Parameters:

sqlQuery - the SQL query

escapeProcessing - should the driver to escape processing before sending to the database ?

timeout - an int value

lineSeparator - the line separator used in the query

schema - a DatabaseSchema value

granularity - parsing granularity as defined in ParsingGranularities

isCaseSensitive - true if parsing is case sensitive

Throws:

java.sql.SQLException - if an error occurs

UpdateRequest

public UpdateRequest(java.lang.String sqlQuery,
                     boolean escapeProcessing,
                     int timeout,
                     java.lang.String lineSeparator)

Creates a new UpdateRequest instance. The caller must give an SQL request, without any leading or trailing spaces and beginning with 'update ' (it will not be checked).

The request is not parsed but it can be done later by a call to parse(DatabaseSchema, int, boolean).

Parameters:

sqlQuery - the SQL query

escapeProcessing - should the driver to escape processing before sending to the database ?

timeout - an int value

lineSeparator - the line separator used in the query

See Also:

parse(org.objectweb.cjdbc.common.sql.schema.DatabaseSchema, int, boolean)

Method Detail

parse

public void parse(DatabaseSchema schema,
                  int granularity,
                  boolean isCaseSensitive)
           throws java.sql.SQLException

Parses the SQL request and extract the selected columns and tables given the DatabaseSchema of the database targeted by this request. Determines also if this query only deletes a single row, and the equivalent INSERT statement.

An exception is thrown when the parsing fails. Warning, this method does not check the validity of the request. In particular, invalid request could be parsed without throwing an exception. However, valid SQL request should never throw an exception.

Specified by:

parse in class AbstractRequest

Parameters:

schema - a DatabaseSchema value

granularity - parsing granularity as defined in ParsingGranularities

isCaseSensitive - true if table name parsing is case sensitive

Throws:

java.sql.SQLException - if the parsing fails

getUpdatedValues

public java.util.HashMap getUpdatedValues()

What are the updated values in this request

Returns:

a hashtable of (colname,value) or null if parsing granularity has stop computation

cloneParsing

public void cloneParsing(AbstractRequest request)

Description copied from class: AbstractRequest

Clones the parsing of a request.

Specified by:

cloneParsing in class AbstractRequest

Parameters:

request - the parsed request to clone

See Also:

AbstractRequest.cloneParsing(AbstractRequest)

isInsert

public boolean isInsert()

Description copied from class: AbstractWriteRequest

Returns true if this request in an INSERT statement.

Specified by:

isInsert in class AbstractWriteRequest

Returns:

false

See Also:

AbstractWriteRequest.isInsert()

isUpdate

public boolean isUpdate()

Description copied from class: AbstractWriteRequest

Returns true if this request in an UPDATE statement.

Specified by:

isUpdate in class AbstractWriteRequest

Returns:

true

See Also:

AbstractWriteRequest.isUpdate()

isDelete

public boolean isDelete()

Description copied from class: AbstractWriteRequest

Returns true if this request in a DELETE statement.

Specified by:

isDelete in class AbstractWriteRequest

Returns:

false

See Also:

AbstractWriteRequest.isDelete()

isCreate

public boolean isCreate()

Description copied from class: AbstractWriteRequest

Returns true if this request in a CREATE statement.

Specified by:

isCreate in class AbstractWriteRequest

Returns:

false

See Also:

AbstractWriteRequest.isCreate()

isDrop

public boolean isDrop()

Description copied from class: AbstractWriteRequest

Returns true if this request in a DROP statement.

Specified by:

isDrop in class AbstractWriteRequest

Returns:

false

See Also:

AbstractWriteRequest.isDrop()

isUnique

public boolean isUnique()

Returns true as this request updates a UNIQUE row.

Returns:

false

debug

public void debug()

Displays some debugging information about this request.

Overrides:

debug in class AbstractRequest

isAlter

public boolean isAlter()

Description copied from class: AbstractWriteRequest

Returns true if this request in a ALTER statement.

Specified by:

isAlter in class AbstractWriteRequest

Returns:

a boolean value

See Also:

AbstractWriteRequest.isAlter()