001: package org.xmldb.api.base;
002:
003: /*
004: * The XML:DB Initiative Software License, Version 1.0
005: *
006: *
007: * Copyright (c) 2000-2001 The XML:DB Initiative. All rights
008: * reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions
012: * are met:
013: *
014: * 1. Redistributions of source code must retain the above copyright
015: * notice, this list of conditions and the following disclaimer.
016: *
017: * 2. Redistributions in binary form must reproduce the above copyright
018: * notice, this list of conditions and the following disclaimer in
019: * the documentation and/or other materials provided with the
020: * distribution.
021: *
022: * 3. The end-user documentation included with the redistribution,
023: * if any, must include the following acknowledgment:
024: * "This product includes software developed by the
025: * XML:DB Initiative (http://www.xmldb.org/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The name "XML:DB Initiative" must not be used to endorse or
030: * promote products derived from this software without prior written
031: * permission. For written permission, please contact info@xmldb.org.
032: *
033: * 5. Products derived from this software may not be called "XML:DB",
034: * nor may "XML:DB" appear in their name, without prior written
035: * permission of the XML:DB Initiative.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
041: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
042: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
043: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
044: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
045: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
046: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
047: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
048: * SUCH DAMAGE.
049: * ====================================================================
050: *
051: * This software consists of voluntary contributions made by many
052: * individuals on behalf of the XML:DB Initiative. For more information
053: * on the XML:DB Initiative, please see <http://www.xmldb.org/>.
054: */
055:
056: /**
057: * <code>Database</code> is an encapsulation of the database driver
058: * functionality that is
059: * necessary to access an XML database. Each vendor must provide their own
060: * implmentation of the <code>Database</code> interface. The implementation
061: * is registered with the
062: * <code>DatabaseManager</code> to provide access to the resources of the XML database.
063: * <p />
064: * In general usage client applications should only access <code>Database</code>
065: * implementations directly during initialization.
066: */
067: public interface Database extends Configurable {
068: /**
069: * Retrieves a <code>Collection</code> instance based on the URI provided
070: * in the <code>uri</code> parameter. The format of the URI is defined in the
071: * documentation for DatabaseManager.getCollection().
072: *
073: * @param uri the URI to use to locate the collection.
074: * @return The <code>Collection</code> instance
075: * @exception XMLDBException with expected error codes.<br />
076: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
077: * specific errors that occur.<br />
078: * <code>ErrroCodes.INVALID_URI</code> If the URI is not in a valid format. <br />
079: */
080: Collection getCollection(String uri) throws XMLDBException;
081:
082: /**
083: * acceptsURI determines whether this <code>Database</code> implementation
084: * can handle the URI. It should return true
085: * if the Database instance knows how to handle the URI and false otherwise.
086: *
087: * @param uri the URI to check for.
088: * @return true if the URI can be handled, false otherwise.
089: * @exception XMLDBException with expected error codes.<br />
090: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
091: * specific errors that occur.<br />
092: * <code>ErrroCodes.INVALID_URI</code> If the URI is not in a valid format. <br />
093: */
094: boolean acceptsURI(String uri) throws XMLDBException;
095:
096: /**
097: * Returns the XML:DB API Conformance level for the implementation. This can
098: * be used by client programs to determine what functionality is available to
099: * them.
100: *
101: * @return the XML:DB API conformance level for this implementation.
102: * @exception XMLDBException with expected error codes.<br />
103: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
104: * specific errors that occur.<br />
105: */
106: String getConformanceLevel() throws XMLDBException;
107: }
|