org.opencms.db
Interface I_CmsDriver

All Known Subinterfaces:

I_CmsUserDriver

All Known Implementing Classes:

CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsHistoryDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsUserDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver

public interface I_CmsDriver

Generic base driver interface.

Since:

6.0.0

Field Summary

static String	AND_CONDITION Operator to concatenate or conditions.
static String	BEGIN_CONDITION String to start a single condition.
static String	BEGIN_EXCLUDE_CONDITION Operator to concatenate exclude conditions.
static String	BEGIN_INCLUDE_CONDITION Operator to concatenate include conditions.
static String	END_CONDITION String to end a single condition.
static String	OR_CONDITION Operator to concatenate or conditions.

Method Summary

void	init(CmsDbContext dbc, CmsConfigurationManager configurationManager, List<String> successiveDrivers, CmsDriverManager driverManager) Initializes the driver.
String	toString() Returns information about the driver.

Field Detail

AND_CONDITION

static final String AND_CONDITION

Operator to concatenate or conditions.

See Also:

Constant Field Values

BEGIN_CONDITION

static final String BEGIN_CONDITION

String to start a single condition.

See Also:

Constant Field Values

BEGIN_EXCLUDE_CONDITION

static final String BEGIN_EXCLUDE_CONDITION

Operator to concatenate exclude conditions.

See Also:

Constant Field Values

BEGIN_INCLUDE_CONDITION

static final String BEGIN_INCLUDE_CONDITION

Operator to concatenate include conditions.

See Also:

Constant Field Values

END_CONDITION

static final String END_CONDITION

String to end a single condition.

See Also:

Constant Field Values

OR_CONDITION

static final String OR_CONDITION

Operator to concatenate or conditions.

See Also:

Constant Field Values

Method Detail

init

void init(CmsDbContext dbc,
          CmsConfigurationManager configurationManager,
          List<String> 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

String toString()

Returns information about the driver.

Overrides:

toString in class Object

Returns:

an information string