DOMConfiguration.java revision 286
3261N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1686N/A * This code is free software; you can redistribute it and/or modify it 1686N/A * under the terms of the GNU General Public License version 2 only, as 1686N/A * published by the Free Software Foundation. Oracle designates this 2362N/A * particular file as subject to the "Classpath" exception as provided 1686N/A * by Oracle in the LICENSE file that accompanied this code. 1686N/A * This code is distributed in the hope that it will be useful, but WITHOUT 1686N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1686N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1686N/A * version 2 for more details (a copy is included in the LICENSE file that 1686N/A * You should have received a copy of the GNU General Public License version 1686N/A * 2 along with this work; if not, write to the Free Software Foundation, 1686N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1686N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 1686N/A * This file is available under and governed by the GNU General Public 1686N/A * License version 2 only, as published by the Free Software Foundation. 1686N/A * However, the following notice accompanied the original version of this 1686N/A * file and, per its terms, should not be removed: 1686N/A * Copyright (c) 2004 World Wide Web Consortium, 1686N/A * (Massachusetts Institute of Technology, European Research Consortium for 1686N/A * Informatics and Mathematics, Keio University). All Rights Reserved. This 1686N/A * work is distributed under the W3C(r) Software License [1] in the hope that 1686N/A * it will be useful, but WITHOUT ANY WARRANTY; without even the implied 1686N/A * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 1686N/A * The <code>DOMConfiguration</code> interface represents the configuration 1686N/A * of a document and maintains a table of recognized parameters. Using the 1686N/A * configuration, it is possible to change 1686N/A * <code>Document.normalizeDocument()</code> behavior, such as replacing the 1686N/A * <code>CDATASection</code> nodes with <code>Text</code> nodes or 1686N/A * specifying the type of the schema that must be used when the validation 1686N/A * of the <code>Document</code> is requested. <code>DOMConfiguration</code> 1686N/A * in the <code>DOMParser</code> and <code>DOMSerializer</code> interfaces. 1686N/A * <p> The parameter names used by the <code>DOMConfiguration</code> object 1686N/A * are defined throughout the DOM Level 3 specifications. Names are 1686N/A * case-insensitive. To avoid possible conflicts, as a convention, names 1686N/A * referring to parameters defined outside the DOM specification should be 1686N/A * made unique. Because parameters are exposed as properties in names 1686N/A * are recommended to follow the section 5.16 Identifiers of [Unicode] with the addition of the character '-' (HYPHEN-MINUS) but it is not 1686N/A * enforced by the DOM implementation. DOM Level 3 Core Implementations are 1686N/A * required to recognize all parameters defined in this specification. Some 1686N/A * parameter values may also be required to be supported by the 1686N/A * implementation. Refer to the definition of the parameter to know if a 1686N/A * value must be supported or not. 1686N/A * <p ><b>Note:</b> Parameters are similar to features and properties used in 1686N/A * <p> The following list of parameters defined in the DOM: 1686N/A * <code>"canonical-form"</code></dt> 1686N/A * <dt><code>true</code></dt> 1686N/A * such as removing the <code>DocumentType</code> node (if any) from the 1686N/A * tree, or removing superfluous namespace declarations from each element. 1686N/A * Note that this is limited to what can be represented in the DOM; in 1686N/A * particular, there is no way to specify the order of the attributes in the 1686N/A * DOM. In addition, Setting this parameter to <code>true</code> will also 1686N/A * set the state of the parameters listed below. Later changes to the state 1686N/A * of one of those parameters will revert "canonical-form" back to 1686N/A * <code>false</code>. Parameters set to <code>false</code>: "entities", " 1686N/A * normalize-characters", "cdata-sections". Parameters set to 1686N/A * <code>true</code>: "namespaces", "namespace-declarations", "well-formed", 1686N/A * "element-content-whitespace". Other parameters are not changed unless 1686N/A * explicitly specified in the description of the parameters.</dd> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Do not canonicalize the document.</dd> 1686N/A * <dt><code>"cdata-sections"</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>CDATASection</code> nodes in the document.</dd> 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>required</em>]Transform <code>CDATASection</code> nodes in the document into 1686N/A * <code>Text</code> nodes. The new <code>Text</code> node is then combined 1686N/A * with any adjacent <code>Text</code> node.</dd> 1686N/A * <code>"check-character-normalization"</code></dt> 1686N/A * <dt><code>true</code></dt> 1686N/A * sequence of characters is encountered that fails normalization checking, 1686N/A * an error with the <code>DOMError.type</code> equals to 1686N/A * "check-character-normalization-failure" is issued. </dd> 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Do not check if characters are normalized.</dd> 1686N/A * <dt><code>"comments"</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>Comment</code> nodes in the document.</dd> 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>required</em>]Discard <code>Comment</code> nodes in the document.</dd> 1686N/A * <code>"datatype-normalization"</code></dt> 1686N/A * <dt><code>true</code></dt> 1686N/A * Schema normalized values</a> in the case of XML Schema. Since this parameter requires to have schema 1686N/A * information, the "validate" parameter will also be set to 1686N/A * <code>true</code>. Having this parameter activated when "validate" is 1686N/A * <code>false</code> has no effect and no schema-normalization will happen. 1686N/A * <p ><b>Note:</b> Since the document contains the result of the XML 1.0 1686N/A * processing, this parameter does not apply to attribute value 1686N/A * meant for schema languages other than Document Type Definition (DTD). </dd> 1686N/A * <dd>[<em>required</em>] (<em>default</em>) Do not perform schema normalization on the tree. </dd> 1686N/A * <code>"element-content-whitespace"</code></dt> 1686N/A * <dt><code>true</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Keep all whitespaces in the document.</dd> 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>optional</em>] Discard all <code>Text</code> nodes that contain whitespaces in element 1686N/A * [element content whitespace]</a>. The implementation is expected to use the attribute 1686N/A * <code>Text.isElementContentWhitespace</code> to determine if a 1686N/A * <code>Text</code> node should be discarded or not.</dd> 1686N/A * <dt><code>"entities"</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>EntityReference</code> nodes in the document.</dd> 1686N/A * <dd>[<em>required</em>] Remove all <code>EntityReference</code> nodes from the document, 1686N/A * putting the entity expansions directly in their place. <code>Text</code> 1686N/A * unexpanded entity references</a> are kept in the document. </dd> 1686N/A * <p ><b>Note:</b> This parameter does not affect <code>Entity</code> nodes. </dd> 1686N/A * <code>"error-handler"</code></dt> 1686N/A * <dd>[<em>required</em>] Contains a <code>DOMErrorHandler</code> object. If an error is 1686N/A * encountered in the document, the implementation will call back the 1686N/A * <code>DOMErrorHandler</code> registered using this parameter. The 1686N/A * implementation may provide a default <code>DOMErrorHandler</code> object. 1686N/A * When called, <code>DOMError.relatedData</code> will contain the closest 1686N/A * node to where the error occurred. If the implementation is unable to 1686N/A * determine the node where the error occurs, 1686N/A * <code>DOMError.relatedData</code> will contain the <code>Document</code> 1686N/A * node. Mutations to the document from within an error handler will result 1686N/A * in implementation dependent behavior. </dd> 1686N/A * <dt><code>"infoset"</code></dt> 1686N/A * .This forces the following parameters to <code>false</code>: " 1686N/A * validate-if-schema", "entities", "datatype-normalization", "cdata-sections 1686N/A * ".This forces the following parameters to <code>true</code>: " 1686N/A * namespace-declarations", "well-formed", "element-content-whitespace", " 1686N/A * comments", "namespaces".Other parameters are not changed unless 1686N/A * explicitly specified in the description of the parameters. Note that 1686N/A * querying this parameter with <code>getParameter</code> returns 1686N/A * <code>true</code> only if the individual parameters specified above are 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>Setting <code>infoset</code> to 1686N/A * <code>false</code> has no effect.</dd> 1686N/A * <dt><code>"namespaces"</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>) Perform the namespace processing as defined in . </dd> 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>optional</em>] Do not perform the namespace processing. </dd> 1686N/A * <code>"namespace-declarations"</code></dt> 1686N/A * <dd> This parameter has no effect if the 1686N/A * parameter "namespaces" is set to <code>false</code>. 1686N/A * <dt><code>true</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>) Include namespace declaration attributes, specified or defaulted from 1686N/A * the schema, in the document. See also the sections "Declaring Namespaces" 1686N/A * <dt><code>false</code></dt> 1686N/A * <dd>[<em>required</em>]Discard all namespace declaration attributes. The namespace prefixes ( 1686N/A * <code>Node.prefix</code>) are retained even if this parameter is set to 1686N/A * <dt><code>"normalize-characters"</code></dt> 1686N/A * <dt><code>true</code></dt> 1686N/A * <dd>[<em>required</em>] (<em>default</em>)Do not perform character normalization.</dd> 1686N/A * <dt><code>"schema-location"</code></dt> 1686N/A * <dd>[<em>optional</em>] Represent a <code>DOMString</code> object containing a list of URIs, 1686N/A * represents the schemas against which validation should occur, i.e. the 1686N/A * current schema. The types of schemas referenced in this list must match 1686N/A * the type specified with <code>schema-type</code>, otherwise the behavior 1686N/A * of an implementation is undefined. The schemas specified using this 1686N/A * property take precedence to the schema information specified in the 1686N/A * document itself. For namespace aware schema, if a schema specified using 1686N/A * this property and a schema specified in the document instance (i.e. using 1686N/A * the <code>schemaLocation</code> attribute) in a schema document (i.e. 1686N/A * using schema <code>import</code> mechanisms) share the same 1686N/A * <code>targetNamespace</code>, the schema specified by the user using this 1686N/A * property will be used. If two schemas specified using this property share 1686N/A * the same <code>targetNamespace</code> or have no namespace, the behavior 1686N/A * is implementation dependent. If no location has been provided, this 1686N/A * parameter is <code>null</code>. * <p ><b>Note:</b> The <code>"schema-location"</code> parameter is ignored * unless the "schema-type" parameter value is set. It is strongly * recommended that <code>Document.documentURI</code> will be set so that an * implementation can successfully resolve any external entities referenced. </dd> * <code>"schema-type"</code></dt> * <dd>[<em>optional</em>] Represent a <code>DOMString</code> object containing an absolute URI * and representing the type of the schema language used to validate a * document against. Note that no lexical checking is done on the absolute * URI. If this parameter is not set, a default value may be provided by * the implementation, based on the schema languages supported and on the * schema language used at load time. If no value is provided, this * parameter is <code>null</code>. * , applications must use the value * applications must use the value * outside the scope of the W3C and therefore should recommend an absolute * URI in order to use this method. </dd> * <dt><code>"split-cdata-sections"</code></dt> * <dd>[<em>required</em>] (<em>default</em>)Split CDATA sections containing the CDATA section termination marker * ']]>'. When a CDATA section is split a warning is issued with a * <code>DOMError.type</code> equals to * <code>"cdata-sections-splitted"</code> and * <code>DOMError.relatedData</code> equals to the first * <code>CDATASection</code> node in document order resulting from the split.</dd> * <code>false</code></dt> * <dd>[<em>required</em>]Signal an error if a <code>CDATASection</code> contains an * unrepresentable character.</dd> * <dt><code>"validate"</code></dt> * <dt><code>true</code></dt> * <dd>[<em>optional</em>] Require the validation against a schema (i.e. XML schema, DTD, any * other type or representation of schema) of the document as it is being * validation errors are found, or no schema was found, the error handler is * notified. Schema-normalized values will not be exposed according to the * schema in used unless the parameter "datatype-normalization" is * <code>true</code>. This parameter will reevaluate: * <li> Attribute nodes with * <code>Attr.specified</code> equals to <code>false</code>, as specified in * the description of the <code>Attr</code> interface; * attribute <code>Text.isElementContentWhitespace</code> for all * <code>Text</code> nodes; * <li> The value of the attribute * <code>Attr.isId</code> for all <code>Attr</code> nodes; * <code>Element.schemaTypeInfo</code> and <code>Attr.schemaTypeInfo</code>. * <p ><b>Note:</b> "validate-if-schema" and "validate" are mutually * exclusive, setting one of them to <code>true</code> will set the other * one to <code>false</code>. Applications should also consider setting the * parameter "well-formed" to <code>true</code>, which is the default for * that option, when validating the document. </dd> * <dt><code>false</code></dt> * <dd>[<em>required</em>] (<em>default</em>) Do not accomplish schema processing, including the internal subset * processing. Default attribute values information are kept. Note that * validation might still happen if "validate-if-schema" is <code>true</code> * <dt><code>"validate-if-schema"</code></dt> * <dt><code>true</code></dt> * <dd>[<em>optional</em>]Enable validation only if a declaration for the document element can be * found in a schema (independently of where it is found, i.e. XML schema, * DTD, or any other type or representation of schema). If validation is * enabled, this parameter has the same behavior as the parameter "validate" * set to <code>true</code>. * <p ><b>Note:</b> "validate-if-schema" and "validate" are mutually * exclusive, setting one of them to <code>true</code> will set the other * one to <code>false</code>. </dd> * <dt><code>false</code></dt> * <dd>[<em>required</em>] (<em>default</em>) No schema processing should be performed if the document has a schema, * including internal subset processing. Default attribute values * information are kept. Note that validation must still happen if "validate * " is <code>true</code>. </dd> * <dt><code>"well-formed"</code></dt> * <dt><code>true</code></dt> * <dd>[<em>required</em>] (<em>default</em>) Check if all nodes are XML well formed according to the XML version in * <li> check if the attribute * <code>Node.nodeName</code> contains invalid characters according to its * node type and generate a <code>DOMError</code> of type * <code>"wf-invalid-character-in-node-name"</code>, with a * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; * the text content inside <code>Attr</code>, <code>Element</code>, * <code>Comment</code>, <code>Text</code>, <code>CDATASection</code> nodes * for invalid characters and generate a <code>DOMError</code> of type * <code>"wf-invalid-character"</code>, with a * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; * the data inside <code>ProcessingInstruction</code> nodes for invalid * characters and generate a <code>DOMError</code> of type * <code>"wf-invalid-character"</code>, with a * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; * <code>false</code></dt> * <dd>[<em>optional</em>] Do not check for XML well-formedness. </dd> * <p> The resolution of the system identifiers associated with entities is * done using <code>Document.documentURI</code>. However, when the feature * is supported by the DOM implementation, the parameter * "resource-resolver" can also be used on <code>DOMConfiguration</code> * objects attached to <code>Document</code> nodes. If this parameter is * set, <code>Document.normalizeDocument()</code> will invoke the resource * resolver instead of using <code>Document.documentURI</code>. * Set the value of a parameter. * @param name The name of the parameter to set. * @param value The new value or <code>null</code> if the user wishes to * unset the parameter. While the type of the value parameter is * defined as <code>DOMUserData</code>, the object type must match the * type defined by the definition of the parameter. For example, if * the parameter is "error-handler", the value must be of type * <code>DOMErrorHandler</code>. * @exception DOMException * NOT_FOUND_ERR: Raised when the parameter name is not recognized. * <br> NOT_SUPPORTED_ERR: Raised when the parameter name is recognized * but the requested value cannot be set. * <br> TYPE_MISMATCH_ERR: Raised if the value type for this parameter * name is incompatible with the expected value type. * Return the value of a parameter if known. * @param name The name of the parameter. * @return The current object associated with the specified parameter or * <code>null</code> if no object has been associated or if the * parameter is not supported. * @exception DOMException * NOT_FOUND_ERR: Raised when the parameter name is not recognized. * Check if setting a parameter to a specific value is supported. * @param name The name of the parameter to check. * @param value An object. if <code>null</code>, the returned value is * @return <code>true</code> if the parameter could be successfully set * to the specified value, or <code>false</code> if the parameter is * not recognized or the requested value is not supported. This does * not change the current value of the parameter itself. * The list of the parameters supported by this * <code>DOMConfiguration</code> object and for which at least one value * can be set by the application. Note that this list can also contain * parameter names defined outside this specification.