KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xmldb > api > base > Database


1 package org.xmldb.api.base;
2
3 /*
4  * The XML:DB Initiative Software License, Version 1.0
5  *
6  *
7  * Copyright (c) 2000-2001 The XML:DB Initiative. All rights
8  * reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright
15  * notice, this list of conditions and the following disclaimer.
16  *
17  * 2. Redistributions in binary form must reproduce the above copyright
18  * notice, this list of conditions and the following disclaimer in
19  * the documentation and/or other materials provided with the
20  * distribution.
21  *
22  * 3. The end-user documentation included with the redistribution,
23  * if any, must include the following acknowledgment:
24  * "This product includes software developed by the
25  * XML:DB Initiative (http://www.xmldb.org/)."
26  * Alternately, this acknowledgment may appear in the software itself,
27  * if and wherever such third-party acknowledgments normally appear.
28  *
29  * 4. The name "XML:DB Initiative" must not be used to endorse or
30  * promote products derived from this software without prior written
31  * permission. For written permission, please contact info@xmldb.org.
32  *
33  * 5. Products derived from this software may not be called "XML:DB",
34  * nor may "XML:DB" appear in their name, without prior written
35  * permission of the XML:DB Initiative.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the XML:DB Initiative. For more information
53  * on the XML:DB Initiative, please see <http://www.xmldb.org/>.
54  */
55
56 /**
57  * <code>Database</code> is an encapsulation of the database driver
58  * functionality that is
59  * necessary to access an XML database. Each vendor must provide their own
60  * implmentation of the <code>Database</code> interface. The implementation
61  * is registered with the
62  * <code>DatabaseManager</code> to provide access to the resources of the XML database.
63  * <p />
64  * In general usage client applications should only access <code>Database</code>
65  * implementations directly during initialization.
66  */
67 public interface Database extends Configurable {
68    /**
69     * Retrieves a <code>Collection</code> instance based on the URI provided
70     * in the <code>uri</code> parameter. The format of the URI is defined in the
71     * documentation for DatabaseManager.getCollection().
72     *
73     * @param uri the URI to use to locate the collection.
74     * @return The <code>Collection</code> instance
75     * @exception XMLDBException with expected error codes.<br />
76     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
77     * specific errors that occur.<br />
78     * <code>ErrroCodes.INVALID_URI</code> If the URI is not in a valid format. <br />
79     */
80    Collection getCollection(String JavaDoc uri) throws XMLDBException;
81
82    /**
83     * acceptsURI determines whether this <code>Database</code> implementation
84     * can handle the URI. It should return true
85     * if the Database instance knows how to handle the URI and false otherwise.
86     *
87     * @param uri the URI to check for.
88     * @return true if the URI can be handled, false otherwise.
89     * @exception XMLDBException with expected error codes.<br />
90     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
91     * specific errors that occur.<br />
92     * <code>ErrroCodes.INVALID_URI</code> If the URI is not in a valid format. <br />
93     */
94    boolean acceptsURI(String JavaDoc uri) throws XMLDBException;
95
96    /**
97     * Returns the XML:DB API Conformance level for the implementation. This can
98     * be used by client programs to determine what functionality is available to
99     * 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 JavaDoc getConformanceLevel() throws XMLDBException;
107 }
108
109
Popular Tags