001: package org.xmldb.api.modules;
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: import org.xmldb.api.base.*;
056:
057: import org.w3c.dom.*;
058: import org.xml.sax.*;
059:
060: /**
061: * Provides access to XML resources stored in the database. An XMLResource can
062: * be accessed either as text XML or via the DOM or SAX APIs.<p />
063: *
064: * The default behavior for getContent and setContent is to work with XML data
065: * as text so these methods work on <code>String</code> content. I.e. it is always
066: * possible to do the following <BR/>
067: * <code>
068: * if (resource instanceof XMLResource) { <BR/>
069: * String foo = (String)resource.getContent(); <BR/>
070: * }</code>
071: */
072: public interface XMLResource extends Resource {
073: public static final String RESOURCE_TYPE = "XMLResource";
074:
075: /**
076: * Returns the content of the <code>Resource</code> as a DOM Node.
077: *
078: * @return The XML content as a DOM <code>Node</code>
079: * @exception XMLDBException with expected error codes.<br />
080: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
081: * specific errors that occur.<br />
082: */
083: Node getContentAsDOM() throws XMLDBException;
084:
085: /**
086: * Sets the content of the <code>Resource</code> using a DOM Node as the
087: * source.
088: *
089: * @param content The new content value
090: * @exception XMLDBException with expected error codes.<br />
091: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
092: * specific errors that occur.<br />
093: * <code>ErrorCodes.INVALID_RESOURCE</code> if the content value provided is
094: * null.<br />
095: * <code>ErrorCodes.WRONG_CONTENT_TYPE</code> if the content provided in not
096: * a valid DOM <code>Node</code>.
097: */
098: void setContentAsDOM(Node content) throws XMLDBException;
099:
100: /**
101: * Allows you to use a <code>ContentHandler</code> to parse the XML data from
102: * the database for use in an application.
103: *
104: * @param handler the SAX <code>ContentHandler</code> to use to handle the
105: * <code>Resource</code> content.
106: * @exception XMLDBException with expected error codes.<br />
107: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
108: * specific errors that occur.<br />
109: * <code>ErrorCodes.INVALID_RESOURCE</code> if the
110: * <code>ContentHandler</code> provided is null.<br />
111: */
112: void getContentAsSAX(ContentHandler handler) throws XMLDBException;
113:
114: /**
115: * Sets the content of the <code>Resource</code> using a SAX
116: * <code>ContentHandler</code>.
117: *
118: * @return a SAX <code>ContentHandler</code> that can be used to add content
119: * into the <code>Resource</code>.
120: * @exception XMLDBException with expected error codes.<br />
121: * <code>ErrorCodes.VENDOR_ERROR</code> for any vendor
122: * specific errors that occur.<br />
123: */
124: ContentHandler setContentAsSAX() throws XMLDBException;
125:
126: }
|