org.opencms.db
Interface I_CmsDriver

All Known Subinterfaces:
I_CmsUserDriver
All Known Implementing Classes:
CmsHistoryDriver, CmsProjectDriver, CmsUserDriver, CmsVfsDriver

public interface I_CmsDriver

Generic base driver interface.

Since:
6.0.0
Version:
$Revision: 1.16 $
Author:
Carsten Weinholz

Field Summary
static java.lang.String AND_CONDITION
          Operator to concatenate or conditions.
static java.lang.String BEGIN_CONDITION
          String to start a single condition.
static java.lang.String BEGIN_EXCLUDE_CONDITION
          Operator to concatenate exclude conditions.
static java.lang.String BEGIN_INCLUDE_CONDITION
          Operator to concatenate include conditions.
static java.lang.String END_CONDITION
          String to end a single condition.
static java.lang.String OR_CONDITION
          Operator to concatenate or conditions.
 
Method Summary
 void init(CmsDbContext dbc, CmsConfigurationManager configurationManager, java.util.List successiveDrivers, CmsDriverManager driverManager)
          Initializes the driver.
 java.lang.String toString()
          Returns information about the driver.
 

Field Detail

AND_CONDITION

public static final java.lang.String AND_CONDITION
Operator to concatenate or conditions.

See Also:
Constant Field Values

BEGIN_CONDITION

public static final java.lang.String BEGIN_CONDITION
String to start a single condition.

See Also:
Constant Field Values

BEGIN_EXCLUDE_CONDITION

public static final java.lang.String BEGIN_EXCLUDE_CONDITION
Operator to concatenate exclude conditions.

See Also:
Constant Field Values

BEGIN_INCLUDE_CONDITION

public static final java.lang.String BEGIN_INCLUDE_CONDITION
Operator to concatenate include conditions.

See Also:
Constant Field Values

END_CONDITION

public static final java.lang.String END_CONDITION
String to end a single condition.

See Also:
Constant Field Values

OR_CONDITION

public static final java.lang.String OR_CONDITION
Operator to concatenate or conditions.

See Also:
Constant Field Values
Method Detail

init

public void init(CmsDbContext dbc,
                 CmsConfigurationManager configurationManager,
                 java.util.List successiveDrivers,
                 CmsDriverManager driverManager)
          throws CmsException
Initializes the driver.

Parameters:
dbc - the current database context
configurationManager - the configuration manager
successiveDrivers - a list of successive drivers to be initialized
driverManager - the initialized OpenCms driver manager
Throws:
CmsException - if something goes wrong

toString

public java.lang.String toString()
Returns information about the driver.

Returns:
an information string