compact2, compact3

org.w3c.dom

Interface DOMConfiguration

public interface DOMConfiguration

DOMConfiguration接口表示文档的配置，并维护已识别参数的表。 使用上述结构，能够改变Document.normalizeDocument()行为，如更换CDATASection与节点Text节点或指定的验证时必须使用的模式的类型Document被请求。 DOMConfiguration对象也在DOMParser和DOMSerializer接口中的[ DOM Level 3 Load and Save ]中使用。

DOMConfiguration对象使用的参数名称在DOM Level 3规范中定义。 名称不区分大小写。 为了避免可能的冲突，作为惯例，引用在DOM规范之外定义的参数的名称应该是唯一的。 因为参数是公开的，因为名称中的属性建议遵循5.16标识符[Unicode]，添加字符' - '（HYPHEN-MINUS），但不被DOM实现强制执行。 DOM 3级核心实现需要识别本规范中定义的所有参数。 某些参数值也可能需要由实现支持。 参考参数的定义来知道是否必须支持一个值。

注意：参数与SAX2 [ SAX ]中使用的特征和属性相似。

DOM中定义的以下参数列表：

"canonical-form"

true

[ 可选 ]根据[ Canonical XML ]中规定的规则规范文档，例如从树中删除DocumentType节点（如果有），或从每个元素中删除多余的命名空间声明。 请注意，这仅限于DOM中可以表示的内容; 特别是没有办法在DOM中指定属性的顺序。 此外，将此参数设置为true还将设置下列参数的状态。 之后对其中一个参数的更改将会将“规范形式”恢复为false 。 参数设置为false ：“entities”，“normalize-characters”，“cdata-sections”。 参数设置为true ：“namespaces”，“namespace-declaration”，“well-formed”，“element-content-whitespace”。 除非在参数说明中明确指定，否则其他参数不会更改。

false

[ 必需 ]（ 默认 ）不要规范化文档。

"cdata-sections"

true

[ 必需 ]（ 默认 ）在文档中保留CDATASection个节点。

false

[ 需要 ]变换CDATASection的文档中的节点到Text节点。 然后将新的Text节点与任何相邻的Text节点组合。

"check-character-normalization"

true

[ 可选 ]根据[ XML 1.1 ]附录B的定义，检查文档中的字符是否为fully normalized 。 当遇到无法正常化检查的字符序列时，发出DOMError.type等于“检查字符归一化失败”的错误。

false

[ 必需 ]（ 默认 ）不检查字符是否正常化。

"comments"

true

[ 必需 ]（ 默认 ）在文档中保留Comment个节点。

false

[ required ]放弃文档中的Comment节点。

"datatype-normalization"

true

[ 可选 ]在树中公开模式归一化值，例如在XML Schema的情况下为XML Schema normalized values 。 由于此参数需要具有模式信息，因此“validate”参数也将设置为true 。 有了这个参数启动时“验证”是false没有效果，没有模式规范化会发生。

注意：由于文档包含XML 1.0处理的结果，该参数不适用于[ XML 1.0 ] 3.3.3节中定义的属性值归一化，仅适用于文档类型定义（DTD）以外的模式语言。

false

[ 必需 ]（ 默认 ）不要在树上执行模式归一化。

"element-content-whitespace"

true

[ 必需 ]（ 默认 ）将所有空格保留在文档中。

false

[ 可选 ]丢弃所有Text包含空格中元素的含量，如在描述的节点是[element content whitespace] 。 预期该实现将使用属性Text.isElementContentWhitespace来确定Text节点是否应被丢弃。

"entities"

true

[ 必需 ]（ 默认 ）在文档中保留EntityReference个节点。

false

[ 必需 ]从文档中删除所有EntityReference个节点，将实体扩展直接放在其位置。 Text节点是归一化的，如在限定的Node.normalize 。 文件中只保留unexpanded entity references 。

注意：此参数不影响Entity节点。

"error-handler"

[ 必填 ]包含一个DOMErrorHandler对象。 如果在文档中遇到错误时，实现将回调DOMErrorHandler使用此参数注册。 该实现可以提供默认的DOMErrorHandler对象。 当调用时， DOMError.relatedData将包含最接近发生错误的节点。 如果实现无法确定发生错误的节点， DOMError.relatedData将包含Document节点。 在错误处理程序内对文档的突变将导致执行依赖的行为。

"infoset"

true

[ required ]在文档中保存XML信息集[ XML Information Set ]中定义的信息。这将强制以下参数为false ：“validate-if-schema”，“entities”，“datatype-normalization”，“cdata-sections” 。这将强制以下参数为true ：“namespace-declaration”，“well-formed”，“element-content-whitespace”，“comments”，“namespaces”。其他参数不会更改，除非在参数。 请注意，仅当适当设置上述指定的参数时，使用getParameter查询此参数getParameter返回true 。

false

设置infoset到false没有任何效果。

"namespaces"

true

[ 必需 ]（ 默认 ）按照定义执行命名空间处理。

false

[ 可选 ]不要执行命名空间处理。

"namespace-declarations"

如果参数“namespaces”设置为false 。

true

[ 必需 ]（ 默认 ）在文档中包含从模式指定或默认的命名空间声明属性。 另请参见[ XML Namespaces ]和[ XML Namespaces 1.1 ]中的“声明命名空间”部分。

false

[ required ]舍弃所有命名空间声明属性。 即使该参数设置为false ，命名空间前缀（ Node.prefix ）仍保留。

"normalize-characters"

true

[ 可选 ] Fully normalized [ XML 1.1 ]附录B中定义的文件中的字符 。

false

[ 必需 ]（ 默认 ）不执行字符规范化。

"schema-location"

[ 可选 ]表示包含URI列表的一个DOMString对象，该列表由空格分隔（与第2.3节[ XML 1.0 ]中定义的nonterminal production S匹配的字符 ），表示应发生验证的模式，即当前模式。 在此列表中的必须使用指定的类型相匹配引用的架构的schema-type ，否则实现的行为不确定。 使用此属性指定的模式优先于文档本身指定的模式信息。 对于名称空间感知模式，如果使用此属性指定的模式和文档实例中指定的架构（即使用schemaLocation属性）在模式文档中（即使用模式import机制）共享相同的targetNamespace ，则由用户指定的模式使用将使用此属性。 如果使用此属性指定的两个模式共享相同的targetNamespace或没有命名空间，行为是依赖于实现的。 如果没有提供位置，则此参数为null 。

注意： "schema-location"参数被忽略，除非设置了“模式类型”参数值。 强烈建议Document.documentURI会进行设置，以便实现可以成功解析所引用的任何外部实体。

"schema-type"

[ 可选 ]表示包含绝对URI的DOMString对象，并表示用于验证文档的模式语言的类型。 请注意，绝对URI上不进行词法检查。 如果未设置此参数，则可以根据支持的模式语言和加载时使用的模式语言，由实现提供默认值。 如果没有提供值，则此参数为null 。

注意：对于XML Schema [ XML Schema Part 1 ]，应用程序必须使用值"http://www.w3.org/2001/XMLSchema" 。 对于XML DTD [ XML 1.0 ]，应用程序必须使用值"http://www.w3.org/TR/REC-xml" 。 其他模式语言不在W3C的范围之内，因此应该推荐使用绝对URI来使用此方法。

"split-cdata-sections"

true

[ 必需 ]（ 默认 ）拆分包含CDATA节终止标记']]>'的CDATA节。 当CDATA部被分割与发出警告DOMError.type等于"cdata-sections-splitted"和DOMError.relatedData等于第一CDATASection节点按文档顺序从分割得到的。

false

[ 必填 ]如果CDATASection包含无法表示的字符，则发出错误信号。

"validate"

true

[ 可选 ]需要根据[ XML 1.0 ]定义对文档进行标准化的模式（即XML模式，DTD，模式的任何其他类型或模式表示）进行验证 。 如果找到验证错误，或者没有找到模式，则会通知错误处理程序。 除非参数“datatype-normalization”为true ，否则不会根据所使用的架构公开模式归一化值。 此参数将重新评估：

• 属性节点与Attr.specified等于false ，如在的说明书中指定Attr接口;
• 所有Text节点的属性Text.isElementContentWhitespace的值;
• 所有Attr节点的属性Attr.isId的值;
• 属性Element.schemaTypeInfo和Attr.schemaTypeInfo 。

注意： “validate-if-schema”和“validate”是互斥的，将其中一个设置为true将另一个设置为false 。 在验证文档时，应用程序还应考虑将参数“well-formed”设置为true ，该选项是该选项的默认值。

false

[ 必需 ]（ 默认 ）不要完成模式处理，包括内部子集处理。 保留默认属性值信息。 请注意，如果“validate-if-schema”为true则验证可能仍会发生。

"validate-if-schema"

true

[ 可选 ]仅当在模式中找到文档元素的声明（独立于发现的位置，即XML模式，DTD或模式的任何其他类型或表示形式）时才启用验证。 如果启用验证，此参数与参数“验证”设置为true具有相同的行为。

注意： “validate-if-schema”和“validate”是互斥的，将其中一个设置为true将另一个设置为false 。

false

[ 必需 ]（ 默认 ）如果文档具有模式（包括内部子集处理），则不应执行模式处理。 保留默认属性值信息。 请注意，如果“验证”为true ，则仍必须进行验证。

"well-formed"

true

[ 需要 ]（ 默认 ）检查是否所有节点都根据所使用的XML版本中公形成XML Document.xmlVersion ：

• 检查属性Node.nodeName包含无效字符根据其节点类型，并生成一个DOMError类型的"wf-invalid-character-in-node-name" ，具有DOMError.SEVERITY_ERROR严重程度，如果必要的话;
• 检查中的文本内容Attr ， Element ， Comment ， Text ， CDATASection的无效字符节点，并生成一个DOMError类型的"wf-invalid-character" ，具有DOMError.SEVERITY_ERROR严重程度，如果必要的话;
• 检查里面的数据ProcessingInstruction的无效字符节点，并生成一个DOMError类型的"wf-invalid-character" ，具有DOMError.SEVERITY_ERROR严重程度，如果必要的话;

false

[ 可选 ]不要检查XML的良好状态。

与实体相关联的系统标识符的分辨率使用Document.documentURI完成。 然而，当DOM实现支持[ DOM Level 3 Load and Save ]中定义的功能“LS”时，参数“resource-resolver”也可以在Document节点附加的DOMConfiguration对象上使用。 如果设置了此参数， Document.normalizeDocument()将调用资源解析器，而不是使用Document.documentURI 。

另见Document Object Model (DOM) Level 3 Core Specification 。

从以下版本开始：

DOM 3级

方法摘要

Modifier and Type	Method and Description
boolean	canSetParameter(String name, Object value) 检查是否将参数设置为特定值。
Object	getParameter(String name) 如果已知，返回参数的值。
DOMStringList	getParameterNames() 此 DOMConfiguration对象支持的参数列表，并且应用程序可以 DOMConfiguration至少设置一个值。
void	setParameter(String name, Object value) 设置参数的值。

方法详细信息

setParameter

void setParameter(String name,
                  Object value)
           throws DOMException

设置参数的值。

参数

name - 要设置的参数的名称。

value -新值，或null如果用户希望取消设置该参数。 虽然value参数的类型定义为DOMUserData ，但对象类型必须与参数定义所定义的类型相匹配。 例如，如果参数为“error-handler”，则该值必须为DOMErrorHandler 。

异常

DOMException - NOT_FOUND_ERR：无法识别参数名时引发。
NOT_SUPPORTED_ERR：在识别参数名称但不能设置请求的值时引发。
TYPE_MISMATCH_ERR：如果此参数名称的值类型与预期值类型不兼容，则引发。

getParameter

Object getParameter(String name)
             throws DOMException

如果已知，返回参数的值。

参数

name - 参数的名称。

结果

与指定参数相关联的当前对象或 null如果没有对象已关联）或参数不受支持。

异常

DOMException - NOT_FOUND_ERR：无法识别参数名称时引发。

canSetParameter

boolean canSetParameter(String name,
                        Object value)

检查是否将参数设置为特定值。

参数

name - 要检查的参数的名称。

value - 一个对象。 如果null ，则返回值为true 。

结果

true如果该参数可以成功设置为指定的值，或false如果该参数不认可或不支持请求的值。 这不会改变参数本身的当前值。

getParameterNames

DOMStringList getParameterNames()

The list of the parameters supported by this DOMConfiguration 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.