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>Resource</code> is a container for data stored within the database. Raw resources
058: * are not particulary useful. It is necessary to have a resource implementation
059: * that provides handling for a specific content type before anything useful can
060: * be done.
061: */
062: public interface Resource {
063: /**
064: * Returns the <code>Collection</code> instance that this resource is
065: * associated with. All resources must exist within the context of a
066: * <code>collection</code>.
067: *
068: * @return the collection associated with the resource.
069: * @exception XMLDBException with expected error codes.<br />
070: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
071: * specific errors that occur.<br />
072: */
073: Collection getParentCollection() throws XMLDBException;
074:
075: /**
076: * Returns the unique id for this Resource or null if the resource is
077: * anonymous.
078: *
079: * @return the id for the Resource or null if no id exists.
080: * @exception XMLDBException with expected error codes.<br />
081: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
082: * specific errors that occur.<br />
083: */
084: String getId() throws XMLDBException;
085:
086: /**
087: * Returns the resource type for this Resource.
088: * <p />
089: * XML:DB defined resource types are: <p />
090: * XMLResource - all XML data stored in the database<br />
091: * BinaryResource - Binary blob data stored in the database<br />
092: *
093: * @return the resource type for the Resource.
094: * @exception XMLDBException with expected error codes.<br />
095: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
096: * specific errors that occur.<br />
097: */
098: String getResourceType() throws XMLDBException;
099:
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 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 value) throws XMLDBException;
121: }
|