001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.db;
029
030import org.opencms.configuration.CmsConfigurationManager;
031import org.opencms.main.CmsException;
032
033import java.util.List;
034
035/**
036 * Generic base driver interface.<p>
037 *
038 * @since 6.0.0
039 */
040public interface I_CmsDriver {
041
042    /** Operator to concatenate or conditions. */
043    String AND_CONDITION = " AND ";
044
045    /** String to start a single condition. */
046    String BEGIN_CONDITION = " (";
047
048    /** Operator to concatenate exclude conditions. */
049    String BEGIN_EXCLUDE_CONDITION = " AND NOT (";
050
051    /** Operator to concatenate include conditions. */
052    String BEGIN_INCLUDE_CONDITION = " AND (";
053
054    /** String to end a single condition. */
055    String END_CONDITION = ") ";
056
057    /** Operator to concatenate or conditions. */
058    String OR_CONDITION = " OR ";
059
060    /**
061     * Initializes the driver.<p>
062     *
063     * @param dbc the current database context
064     * @param configurationManager the configuration manager
065     * @param successiveDrivers a list of successive drivers to be initialized
066     * @param driverManager the initialized OpenCms driver manager
067     *
068     * @throws CmsException if something goes wrong
069     */
070    void init(
071        CmsDbContext dbc,
072        CmsConfigurationManager configurationManager,
073        List<String> successiveDrivers,
074        CmsDriverManager driverManager) throws CmsException;
075
076    /**
077     * Returns information about the driver.<p>
078     *
079     * @return an information string
080     */
081    String toString();
082
083}