01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/db/I_CmsDriver.java,v $
03: * Date : $Date: 2008-02-27 12:05:42 $
04: * Version: $Revision: 1.17 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.db;
33:
34: import org.opencms.configuration.CmsConfigurationManager;
35: import org.opencms.main.CmsException;
36:
37: import java.util.List;
38:
39: /**
40: * Generic base driver interface.<p>
41: *
42: * @author Carsten Weinholz
43: *
44: * @version $Revision: 1.17 $
45: *
46: * @since 6.0.0
47: */
48: public interface I_CmsDriver {
49:
50: /** Operator to concatenate or conditions. */
51: String AND_CONDITION = " AND ";
52:
53: /** String to start a single condition. */
54: String BEGIN_CONDITION = " (";
55:
56: /** Operator to concatenate exclude conditions. */
57: String BEGIN_EXCLUDE_CONDITION = " AND NOT (";
58:
59: /** Operator to concatenate include conditions. */
60: String BEGIN_INCLUDE_CONDITION = " AND (";
61:
62: /** String to end a single condition. */
63: String END_CONDITION = ") ";
64:
65: /** Operator to concatenate or conditions. */
66: String OR_CONDITION = " OR ";
67:
68: /**
69: * Initializes the driver.<p>
70: *
71: * @param dbc the current database context
72: * @param configurationManager the configuration manager
73: * @param successiveDrivers a list of successive drivers to be initialized
74: * @param driverManager the initialized OpenCms driver manager
75: *
76: * @throws CmsException if something goes wrong
77: */
78: void init(CmsDbContext dbc,
79: CmsConfigurationManager configurationManager,
80: List successiveDrivers, CmsDriverManager driverManager)
81: throws CmsException;
82:
83: /**
84: * Returns information about the driver.<p>
85: *
86: * @return an information string
87: */
88: String toString();
89:
90: }
|