org.objectweb.cjdbc.common.sql
Class AlterRequest

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

All Implemented Interfaces:

java.io.Serializable

public class AlterRequest

extends AbstractWriteRequest

This class defines a AlterRequest

Version:

1.0

Author:

Nicolas Modrzyk

See Also:

Serialized Form

Field Summary

private DatabaseColumn	column The column altered
private boolean	isAdd
private boolean	isDrop
private static long	serialVersionUID
private DatabaseTable	table The table to alter.

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, cursorName, escapeProcessing, fetchSize, id, isAutoCommit, isParsed, isReadOnly, login, maxRows, requestType, sqlQuery, sqlSkeleton, timeoutInSeconds, transactionId, transactionIsolation

Constructor Summary

AlterRequest(CJDBCInputStream in)

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

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

Method Summary

void	cloneParsing(AbstractRequest request) Clones the parsing of a request.
DatabaseColumn	getColumn() Returns the column value.
DatabaseTable	getDatabaseTable() Returns the table value.
boolean	isAdd() Returns the isAdd value.
boolean	needsMacroProcessing() Returns true if this request requires macro (RAND(), NOW(), ...) processing.
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.
boolean	returnsResultSet() Does this request returns a ResultSet?

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

cloneTableNameAndColumns, getColumns, getPk, getTableName, mightBlock, setBlocking

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

debug, equals, getCacheAbility, getCursorName, getEscapeProcessing, getFetchSize, getId, getLineSeparator, getLogin, getMaxRows, getSQL, getSQLShortForm, getSqlSkeleton, getTimeout, getTransactionId, getTransactionIsolation, isAlter, isAutoCommit, isCreate, isDDL, isDelete, isDML, isDriverProcessed, isDrop, isInsert, isParsed, isReadOnly, isSelect, isUpdate, receiveResultSetParams, sendResultSetParams, sendToStream, setCacheAbility, setCursorName, setDriverProcessed, setFetchSize, setId, setIsAutoCommit, setIsReadOnly, setLogin, setMaxRows, setSQL, setSqlSkeleton, setTimeout, setTransactionId, setTransactionIsolation, trimCarriageReturnAndTabs

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

table

private transient DatabaseTable table

The table to alter.

column

private transient DatabaseColumn column

The column altered

isDrop

private transient boolean isDrop

isAdd

private transient boolean isAdd

Constructor Detail

AlterRequest

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

Creates a new AlterRequest instance. The caller must give an SQL request, without any leading or trailing spaces and beginning with 'alter table '

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

Parameters:

sqlQuery - the SQL request

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)

AlterRequest

public AlterRequest(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 AlterRequest instance. The caller must give an SQL request, without any leading or trailing spaces and beginning with 'alter table '

If the syntax is incorrect an exception is thrown.

Parameters:

sqlQuery - the SQL request

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

AlterRequest

public AlterRequest(CJDBCInputStream in)
             throws java.io.IOException

See Also:

AbstractWriteRequest

Method Detail

needsMacroProcessing

public boolean needsMacroProcessing()

Description copied from class: AbstractRequest

Returns true if this request requires macro (RAND(), NOW(), ...) processing.

Specified by:

needsMacroProcessing in class AbstractRequest

Returns:

true if macro processing is required

See Also:

AbstractRequest.needsMacroProcessing()

returnsResultSet

public boolean returnsResultSet()

Description copied from class: AbstractRequest

Does this request returns a ResultSet?

Specified by:

returnsResultSet in class AbstractRequest

Returns:

true is this request will return a ResultSet

See Also:

AbstractRequest.returnsResultSet()

parse

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

Description copied from class: AbstractRequest

Parses the SQL request and extract the selected columns and tables given the DatabaseSchema of the database targeted by this request.

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 parsing must be case sensitive

Throws:

java.sql.SQLException - if the parsing fails

See Also:

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

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(org.objectweb.cjdbc.common.sql.AbstractRequest)

getDatabaseTable

public DatabaseTable getDatabaseTable()

Returns the table value.

Returns:

Returns the table.

getColumn

public DatabaseColumn getColumn()

Returns the column value.

Returns:

Returns the column.

isAdd

public boolean isAdd()

Returns the isAdd value.

Returns:

Returns the isAdd.