KickJava   Java API By Example, From Geeks To Geeks.

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


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>Resource</code> is a container for data stored within the database. Raw resources
58  * are not particulary useful. It is necessary to have a resource implementation
59  * that provides handling for a specific content type before anything useful can
60  * be done.
61  */
62 public interface Resource {
63    /**
64     * Returns the <code>Collection</code> instance that this resource is
65     * associated with. All resources must exist within the context of a
66     * <code>collection</code>.
67     *
68     * @return the collection associated with the resource.
69     * @exception XMLDBException with expected error codes.<br />
70     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
71     * specific errors that occur.<br />
72     */
73    Collection getParentCollection() throws XMLDBException;
74
75    /**
76     * Returns the unique id for this Resource or null if the resource is
77     * anonymous.
78     *
79     * @return the id for the Resource or null if no id exists.
80     * @exception XMLDBException with expected error codes.<br />
81     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
82     * specific errors that occur.<br />
83     */
84    String JavaDoc getId() throws XMLDBException;
85
86    /**
87     * Returns the resource type for this Resource.
88     * <p />
89     * XML:DB defined resource types are: <p />
90     * XMLResource - all XML data stored in the database<br />
91     * BinaryResource - Binary blob data stored in the database<br />
92     *
93     * @return the resource type for the Resource.
94     * @exception XMLDBException with expected error codes.<br />
95     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
96     * specific errors that occur.<br />
97     */
98    String JavaDoc getResourceType() throws XMLDBException;
99    
100    /**
101     * Retrieves the content from the resource. The type of the content varies
102     * depending what type of resource is being used.
103     *
104     * @return the content of the resource.
105     * @exception XMLDBException with expected error codes.<br />
106     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
107     * specific errors that occur.<br />
108     */
109    Object JavaDoc getContent() throws XMLDBException;
110
111    /**
112     * Sets the content for this resource. The type of content that can be set
113     * depends on the type of resource being used.
114     *
115     * @param value the content value to set for the resource.
116     * @exception XMLDBException with expected error codes.<br />
117     * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
118     * specific errors that occur.<br />
119     */
120    void setContent(Object JavaDoc value) throws XMLDBException;
121 }
122
123
Popular Tags