com.dhtmlx.connector
Class DataWrapper

java.lang.Object
  extended by com.dhtmlx.connector.DataWrapper
Direct Known Subclasses:
DBDataWrapper

public abstract class DataWrapper
extends java.lang.Object

The Class DataWrapper. Abstract data access class. Provides base methods for CRUD operations.


Constructor Summary
DataWrapper()
           
 
Method Summary
 void begin_transaction()
          Begin transaction.
 void commit_transaction()
          Commit transaction.
abstract  void delete(DataAction data, DataRequest source)
          Delete data from storage
abstract  java.lang.String get_size(DataRequest source)
          Gets the size of the data in storage.
 java.lang.String get_sql(OperationType name, java.util.HashMap<java.lang.String,java.lang.String> data)
          Gets the sql string for named operation
abstract  ConnectorResultSet get_variants(DataRequest source, java.lang.String field)
          Gets the all variations of defined field in the storage
 void init(java.lang.Object connection, DataConfig external_config)
          Inits self
abstract  void insert(DataAction data, DataRequest source)
          Insert data in storage
 boolean is_global_transaction()
          Checks if current mode is "global transaction"
 boolean is_record_transaction()
          Checks if current mode is "record transaction"
 void rollback_transaction()
          Rollback transaction.
abstract  ConnectorResultSet select(DataRequest source)
          Select data from storage
 void set_transaction_mode(TransactionType mode)
          Sets the transaction mode.
abstract  void update(DataAction data, DataRequest source)
          Update data in storage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataWrapper

public DataWrapper()
Method Detail

init

public void init(java.lang.Object connection,
                 DataConfig external_config)
Inits self

Parameters:
connection - the connection
external_config - the data config

insert

public abstract void insert(DataAction data,
                            DataRequest source)
                     throws ConnectorOperationException
Insert data in storage

Parameters:
data - the data wrapped in DataAction object
source - the source defined by DataRequest object
Throws:
ConnectorOperationException - the connector operation exception

delete

public abstract void delete(DataAction data,
                            DataRequest source)
                     throws ConnectorOperationException
Delete data from storage

Parameters:
data - the data wrapped in DataAction object
source - the source defined by DataRequest object
Throws:
ConnectorOperationException - the connector operation exception

update

public abstract void update(DataAction data,
                            DataRequest source)
                     throws ConnectorOperationException
Update data in storage

Parameters:
data - the data wrapped in DataAction object
source - the source defined by DataRequest object
Throws:
ConnectorOperationException - the connector operation exception

select

public abstract ConnectorResultSet select(DataRequest source)
                                   throws ConnectorOperationException
Select data from storage

Parameters:
source - the source defined by DataRequest object
Returns:
the connector result set
Throws:
ConnectorOperationException - the connector operation exception

get_size

public abstract java.lang.String get_size(DataRequest source)
                                   throws ConnectorOperationException
Gets the size of the data in storage.

Parameters:
source - the source defined by DataRequest object
Returns:
the size of collection in storage
Throws:
ConnectorOperationException - the connector operation exception

get_variants

public abstract ConnectorResultSet get_variants(DataRequest source,
                                                java.lang.String field)
                                         throws ConnectorOperationException
Gets the all variations of defined field in the storage

Parameters:
source - the source defined by DataRequest object
Returns:
the set of variations
Throws:
ConnectorOperationException - the connector operation exception

get_sql

public java.lang.String get_sql(OperationType name,
                                java.util.HashMap<java.lang.String,java.lang.String> data)
                         throws ConnectorConfigException
Gets the sql string for named operation

Parameters:
name - the name of operation
data - the hash of data, will be used to fill vars in sql
Returns:
the sql string
Throws:
ConnectorConfigException - the connector config exception

begin_transaction

public void begin_transaction()
                       throws ConnectorConfigException,
                              ConnectorOperationException
Begin transaction.

Throws:
ConnectorConfigException - the connector config exception
ConnectorOperationException - the connector operation exception

commit_transaction

public void commit_transaction()
                        throws ConnectorConfigException,
                               ConnectorOperationException
Commit transaction.

Throws:
ConnectorConfigException - the connector config exception
ConnectorOperationException - the connector operation exception

rollback_transaction

public void rollback_transaction()
                          throws ConnectorConfigException,
                                 ConnectorOperationException
Rollback transaction.

Throws:
ConnectorConfigException - the connector config exception
ConnectorOperationException - the connector operation exception

set_transaction_mode

public void set_transaction_mode(TransactionType mode)
Sets the transaction mode.

Parameters:
mode - the new _transaction_mode

is_global_transaction

public boolean is_global_transaction()
Checks if current mode is "global transaction"

Returns:
true, if "global transaction" flag is set

is_record_transaction

public boolean is_record_transaction()
Checks if current mode is "record transaction"

Returns:
true, if "record transaction" flag is set