Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

org.objectweb.cjdbc.common.sql.AbstractWriteRequest Class Reference

Inheritance diagram for org.objectweb.cjdbc.common.sql.AbstractWriteRequest:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.cjdbc.common.sql.AbstractWriteRequest:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AbstractWriteRequest (String sqlQuery, boolean escapeProcessing, int timeout, String lineSeparator)
boolean isReadRequest ()
boolean isWriteRequest ()
boolean isUnknownRequest ()
abstract boolean isInsert ()
abstract boolean isUpdate ()
abstract boolean isDelete ()
abstract boolean isAlter ()
abstract boolean isCreate ()
abstract boolean isDrop ()
String getTableName ()
ArrayList getColumns ()
boolean mightBlock ()
void setBlocking (boolean blocking)
String getPk ()

Protected Member Functions

void cloneTableNameAndColumns (AbstractWriteRequest abstractWriteRequest)

Protected Attributes

transient String tableName
transient ArrayList columns
transient boolean blocking = true
transient String pkValue = null

Detailed Description

An AbstractWriteRequest defines the skeleton of read requests that are sent from the driver to the controller.

Author:
Emmanuel Cecchet
Version:
1.0

Definition at line 36 of file AbstractWriteRequest.java.

Constructor & Destructor Documentation

org.objectweb.cjdbc.common.sql.AbstractWriteRequest.AbstractWriteRequest (  String  sqlQuery,
boolean  escapeProcessing,
int  timeout,
String  lineSeparator
) 
 

Creates a new AbstractWriteRequest object

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

Definition at line 62 of file AbstractWriteRequest.java.

00064   {
00065     super(sqlQuery, escapeProcessing, timeout, lineSeparator);
00066   }

Member Function Documentation

void org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns (  AbstractWriteRequest  abstractWriteRequest  )  [protected]
 

Clones table name and columns from an already parsed request.

Parameters:
abstractWriteRequest the already parsed request

Definition at line 169 of file AbstractWriteRequest.java.

References org.objectweb.cjdbc.common.sql.AbstractWriteRequest.columns, org.objectweb.cjdbc.common.sql.AbstractRequest.getCacheAbility(), org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getColumns(), org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getPk(), org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getTableName(), org.objectweb.cjdbc.common.sql.AbstractWriteRequest.pkValue, and org.objectweb.cjdbc.common.sql.AbstractWriteRequest.tableName.

Referenced by org.objectweb.cjdbc.common.sql.UpdateRequest.cloneParsing(), org.objectweb.cjdbc.common.sql.InsertRequest.cloneParsing(), org.objectweb.cjdbc.common.sql.DropRequest.cloneParsing(), org.objectweb.cjdbc.common.sql.DeleteRequest.cloneParsing(), org.objectweb.cjdbc.common.sql.CreateRequest.cloneParsing(), and org.objectweb.cjdbc.common.sql.AlterRequest.cloneParsing().

00171   {
00172     tableName = abstractWriteRequest.getTableName();
00173     columns = abstractWriteRequest.getColumns();
00174     pkValue = abstractWriteRequest.getPk();
00175     cacheable = abstractWriteRequest.getCacheAbility();
00176   }

ArrayList org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getColumns (   ) 
 

Returns an ArrayList of TableColumn objects representing the columns affected by this statement.

Returns:
an ArrayList value

Definition at line 159 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.isUpdateNecessary(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify(), and org.objectweb.cjdbc.controller.cache.result.ResultCacheColumn.processWriteNotify().

00160   {
00161     return columns;
00162   }

String org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getPk (   ) 
 

Returns:
Returns the pk.

Definition at line 201 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns(), and org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.isUpdateNecessary().

00202   {
00203     return pkValue;
00204   }

String org.objectweb.cjdbc.common.sql.AbstractWriteRequest.getTableName (   ) 
 

Returns the name of the table affected by this statement.

Returns:
a String value

Definition at line 148 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.isUpdateNecessary(), org.objectweb.cjdbc.controller.scheduler.raidb1.RAIDb1OptimisticTransactionLevelScheduler.notifyWriteCompleted(), org.objectweb.cjdbc.controller.cache.result.ResultCacheTable.processWriteNotify(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify(), and org.objectweb.cjdbc.controller.cache.result.ResultCacheColumn.processWriteNotify().

00149   {
00150     return tableName;
00151   }

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isAlter (   )  [pure virtual]
 

Returns true if this request in a ALTER statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.loadbalancer.AbstractLoadBalancer.handleMacros(), org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify(), and org.objectweb.cjdbc.controller.cache.result.ResultCacheColumn.processWriteNotify().

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isCreate (   )  [pure virtual]
 

Returns true if this request in a CREATE statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.loadbalancer.AbstractLoadBalancer.handleMacros(), org.objectweb.cjdbc.controller.scheduler.raidb2.RAIDb2PessimisticTransactionLevelScheduler.notifyWriteCompleted(), org.objectweb.cjdbc.controller.scheduler.raidb1.RAIDb1PessimisticTransactionLevelScheduler.notifyWriteCompleted(), org.objectweb.cjdbc.controller.scheduler.raidb1.RAIDb1OptimisticTransactionLevelScheduler.notifyWriteCompleted(), and org.objectweb.cjdbc.controller.scheduler.raidb0.RAIDb0PessimisticTransactionLevelScheduler.notifyWriteCompleted().

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isDelete (   )  [pure virtual]
 

Returns true if this request in a DELETE statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify().

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isDrop (   )  [pure virtual]
 

Returns true if this request in a DROP statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.loadbalancer.AbstractLoadBalancer.handleMacros(), and org.objectweb.cjdbc.controller.scheduler.raidb1.RAIDb1OptimisticTransactionLevelScheduler.notifyWriteCompleted().

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isInsert (   )  [pure virtual]
 

Returns true if this request in an INSERT statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify().

boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isReadRequest (   )  [virtual]
 

Returns:
false
See also:
org.objectweb.cjdbc.common.sql.AbstractRequest.isReadRequest()

Implements org.objectweb.cjdbc.common.sql.AbstractRequest.

Reimplemented in org.objectweb.cjdbc.common.sql.AlterRequest.

Definition at line 72 of file AbstractWriteRequest.java.

00073   {
00074     return false;
00075   }

boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isUnknownRequest (   )  [virtual]
 

Returns:
false
See also:
org.objectweb.cjdbc.common.sql.AbstractRequest.isUnknownRequest()

Implements org.objectweb.cjdbc.common.sql.AbstractRequest.

Reimplemented in org.objectweb.cjdbc.common.sql.AlterRequest.

Definition at line 90 of file AbstractWriteRequest.java.

00091   {
00092     return false;
00093   }

abstract boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isUpdate (   )  [pure virtual]
 

Returns true if this request in an UPDATE statement.

Returns:
a boolean value

Implemented in org.objectweb.cjdbc.common.sql.AlterRequest, org.objectweb.cjdbc.common.sql.CreateRequest, org.objectweb.cjdbc.common.sql.DeleteRequest, org.objectweb.cjdbc.common.sql.DropRequest, org.objectweb.cjdbc.common.sql.InsertRequest, and org.objectweb.cjdbc.common.sql.UpdateRequest.

Referenced by org.objectweb.cjdbc.controller.cache.result.ResultCacheColumnUnique.processWriteNotify().

boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.isWriteRequest (   )  [virtual]
 

Returns:
true
See also:
org.objectweb.cjdbc.common.sql.AbstractRequest.isWriteRequest()

Implements org.objectweb.cjdbc.common.sql.AbstractRequest.

Reimplemented in org.objectweb.cjdbc.common.sql.AlterRequest.

Definition at line 81 of file AbstractWriteRequest.java.

00082   {
00083     return true;
00084   }

boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.mightBlock (   ) 
 

Tests if this request might block.

Returns:
true if this request might block

Definition at line 183 of file AbstractWriteRequest.java.

00184   {
00185     return blocking;
00186   }

void org.objectweb.cjdbc.common.sql.AbstractWriteRequest.setBlocking (  boolean  blocking  ) 
 

Sets if this request might block.

Parameters:
blocking a boolean value

Definition at line 193 of file AbstractWriteRequest.java.

References org.objectweb.cjdbc.common.sql.AbstractWriteRequest.blocking.

00194   {
00195     this.blocking = blocking;
00196   }

Member Data Documentation

transient boolean org.objectweb.cjdbc.common.sql.AbstractWriteRequest.blocking = true [protected]
 

true if this request might block.

Definition at line 48 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.setBlocking().

transient ArrayList org.objectweb.cjdbc.common.sql.AbstractWriteRequest.columns [protected]
 

ArrayList of TableColumn involved in this write query.

Definition at line 45 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns().

transient String org.objectweb.cjdbc.common.sql.AbstractWriteRequest.pkValue = null [protected]
 

Primary key value

Definition at line 51 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns().

transient String org.objectweb.cjdbc.common.sql.AbstractWriteRequest.tableName [protected]
 

Name of the table involved in this write query.

Definition at line 39 of file AbstractWriteRequest.java.

Referenced by org.objectweb.cjdbc.common.sql.AbstractWriteRequest.cloneTableNameAndColumns().

The documentation for this class was generated from the following file:
Generated on Mon Apr 11 22:02:04 2005 for C-JDBC by  doxygen 1.3.9.1