001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
003 *
004 * This code is free software; you can redistribute it and/or modify it
005 * under the terms of the GNU General Public License version 2 only, as
006 * published by the Free Software Foundation. Sun designates this
007 * particular file as subject to the "Classpath" exception as provided
008 * by Sun in the LICENSE file that accompanied this code.
009 *
010 * This code is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
013 * version 2 for more details (a copy is included in the LICENSE file that
014 * accompanied this code).
015 *
016 * You should have received a copy of the GNU General Public License version
017 * 2 along with this work; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
019 *
020 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
021 * CA 95054 USA or visit www.sun.com if you need additional information or
022 * have any questions.
023 */
024
025 /*
026 * This file is available under and governed by the GNU General Public
027 * License version 2 only, as published by the Free Software Foundation.
028 * However, the following notice accompanied the original version of this
029 * file and, per its terms, should not be removed:
030 *
031 * Copyright (c) 2004 World Wide Web Consortium,
032 *
033 * (Massachusetts Institute of Technology, European Research Consortium for
034 * Informatics and Mathematics, Keio University). All Rights Reserved. This
035 * work is distributed under the W3C(r) Software License [1] in the hope that
036 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
037 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
038 *
039 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
040 */
041
042 package org.w3c.dom.ls;
043
044 import org.w3c.dom.DOMException;
045
046 /**
047 * <code>DOMImplementationLS</code> contains the factory methods for creating
048 * Load and Save objects.
049 * <p> The expectation is that an instance of the
050 * <code>DOMImplementationLS</code> interface can be obtained by using
051 * binding-specific casting methods on an instance of the
052 * <code>DOMImplementation</code> interface or, if the <code>Document</code>
053 * supports the feature <code>"Core"</code> version <code>"3.0"</code>
054 * defined in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>DOM Level 3 Core</a>]
055 * , by using the method <code>DOMImplementation.getFeature</code> with
056 * parameter values <code>"LS"</code> (or <code>"LS-Async"</code>) and
057 * <code>"3.0"</code> (respectively).
058 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load
059 and Save Specification</a>.
060 */
061 public interface DOMImplementationLS {
062 // DOMImplementationLSMode
063 /**
064 * Create a synchronous <code>LSParser</code>.
065 */
066 public static final short MODE_SYNCHRONOUS = 1;
067 /**
068 * Create an asynchronous <code>LSParser</code>.
069 */
070 public static final short MODE_ASYNCHRONOUS = 2;
071
072 /**
073 * Create a new <code>LSParser</code>. The newly constructed parser may
074 * then be configured by means of its <code>DOMConfiguration</code>
075 * object, and used to parse documents by means of its <code>parse</code>
076 * method.
077 * @param mode The <code>mode</code> argument is either
078 * <code>MODE_SYNCHRONOUS</code> or <code>MODE_ASYNCHRONOUS</code>, if
079 * <code>mode</code> is <code>MODE_SYNCHRONOUS</code> then the
080 * <code>LSParser</code> that is created will operate in synchronous
081 * mode, if it's <code>MODE_ASYNCHRONOUS</code> then the
082 * <code>LSParser</code> that is created will operate in asynchronous
083 * mode.
084 * @param schemaType An absolute URI representing the type of the schema
085 * language used during the load of a <code>Document</code> using the
086 * newly created <code>LSParser</code>. Note that no lexical checking
087 * is done on the absolute URI. In order to create a
088 * <code>LSParser</code> for any kind of schema types (i.e. the
089 * LSParser will be free to use any schema found), use the value
090 * <code>null</code>.
091 * <p ><b>Note:</b> For W3C XML Schema [<a href='http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/'>XML Schema Part 1</a>]
092 * , applications must use the value
093 * <code>"http://www.w3.org/2001/XMLSchema"</code>. For XML DTD [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>],
094 * applications must use the value
095 * <code>"http://www.w3.org/TR/REC-xml"</code>. Other Schema languages
096 * are outside the scope of the W3C and therefore should recommend an
097 * absolute URI in order to use this method.
098 * @return The newly created <code>LSParser</code> object. This
099 * <code>LSParser</code> is either synchronous or asynchronous
100 * depending on the value of the <code>mode</code> argument.
101 * <p ><b>Note:</b> By default, the newly created <code>LSParser</code>
102 * does not contain a <code>DOMErrorHandler</code>, i.e. the value of
103 * the "<a href='http://www.w3.org/TR/DOM-Level-3-Core/core.html#parameter-error-handler'>
104 * error-handler</a>" configuration parameter is <code>null</code>. However, implementations
105 * may provide a default error handler at creation time. In that case,
106 * the initial value of the <code>"error-handler"</code> configuration
107 * parameter on the new <code>LSParser</code> object contains a
108 * reference to the default error handler.
109 * @exception DOMException
110 * NOT_SUPPORTED_ERR: Raised if the requested mode or schema type is
111 * not supported.
112 */
113 public LSParser createLSParser(short mode, String schemaType)
114 throws DOMException;
115
116 /**
117 * Create a new <code>LSSerializer</code> object.
118 * @return The newly created <code>LSSerializer</code> object.
119 * <p ><b>Note:</b> By default, the newly created
120 * <code>LSSerializer</code> has no <code>DOMErrorHandler</code>, i.e.
121 * the value of the <code>"error-handler"</code> configuration
122 * parameter is <code>null</code>. However, implementations may
123 * provide a default error handler at creation time. In that case, the
124 * initial value of the <code>"error-handler"</code> configuration
125 * parameter on the new <code>LSSerializer</code> object contains a
126 * reference to the default error handler.
127 */
128 public LSSerializer createLSSerializer();
129
130 /**
131 * Create a new empty input source object where
132 * <code>LSInput.characterStream</code>, <code>LSInput.byteStream</code>
133 * , <code>LSInput.stringData</code> <code>LSInput.systemId</code>,
134 * <code>LSInput.publicId</code>, <code>LSInput.baseURI</code>, and
135 * <code>LSInput.encoding</code> are null, and
136 * <code>LSInput.certifiedText</code> is false.
137 * @return The newly created input object.
138 */
139 public LSInput createLSInput();
140
141 /**
142 * Create a new empty output destination object where
143 * <code>LSOutput.characterStream</code>,
144 * <code>LSOutput.byteStream</code>, <code>LSOutput.systemId</code>,
145 * <code>LSOutput.encoding</code> are null.
146 * @return The newly created output object.
147 */
148 public LSOutput createLSOutput();
149
150 }
|