compact2, compact3

org.w3c.dom

Interface DOMConfiguration

public interface DOMConfiguration

的 DOMConfiguration接口代表一个文档的配置和维护一个公认的参数表。使用配置，它可能改变 Document.normalizeDocument()行为，如更换 CDATASection节点 Text节点或特定类型的架构时必须使用的 Document验证要求。 DOMConfiguration对象也用在[ DOM Level 3 Load and Save ]在 DOMParser和 DOMSerializer接口。

由DOMConfiguration对象使用的参数名称定义整个DOM级别3规格。名字是不区分大小写的。为了避免可能的冲突，作为一个惯例，指在DOM规范定义的参数名称应该独特。因为参数为暴露属性名称建议按照5.16节标识符[UNICDOE]随着人物的加成-”（hyphen-minus）而不是通过DOM实现执行。DOM级别3核心的实现需要认识到在本规范中定义的所有参数。一些参数值也可能被需要支持的实现。参考参数的定义，以知道是否支持或不支持。

注：参数类似于SAX2 [ SAX ]特点与性质。

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

"canonical-form"

true

[可选]规范文档根据[ Canonical XML ]的规定，如去掉 DocumentType节点（如果有）从树上，或删除多余的命名空间声明的每个元素。请注意，这是限制什么可以在DOM表示；特别是，有没有办法在指定的DOM属性的顺序。此外，该参数设置为 true也将设置以下参数的状态。对其中一个参数的变化将恢复状态后的“典型”的形式回到 false。参数设置为 false：“实体”、“规范汉字”、“CDATA节”。参数设置为 true：“命名空间”，“命名空间声明”、“形成”、“元素含量空白”。其他参数没有更改，除非在参数的描述中显式指定。

false

[要求]（默认）不规范文档。

"cdata-sections"

true

[要求]（默认）保持 CDATASection文件中的节点。

false

[要求]变换 CDATASection文件中的节点到节点 Text。新 Text节点结合 Text任何相邻节点。

"check-character-normalization"

true

[可选]检查文档中的字符 fully normalized，在[ XML 1.1 ]附录B定义。当一个字符序列中未规范化检查，与 DOMError.type误差等于“检查字符归一化失败”发布。

false

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

"comments"

true

[要求]（默认）保持 Comment文件中的节点。

false

[要求]丢弃在文档 Comment节点。

"datatype-normalization"

true

[可选]揭露图式规范值的树，如XML Schema的情况 XML Schema normalized values。由于该参数需要有架构信息，“验证”的参数也将被设置为 true。在这个参数激活时，“验证”是 false没有影响任何模式规范化会发生。

注：自文件包含XML 1处理的结果，这个参数不适用于属性值标准化在[ 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

[要求]保持在文档中设置] [ XML Information Set XML信息定义的信息。这迫使以下参数：“如果 false验证图式”、“实体”、“类型化”、“CDATA节”。这迫使以下参数：“ true命名空间声明”，“合格”，“元素含量的空白”、“评论”、“命名空间”。其他参数没有改变，除非明确指定的参数描述。注意，查询参数与 getParameter返回 true只有上述各个参数的合理设置。

false

设置 infoset到 false没有影响。

"namespaces"

true

[需要]（默认）执行在定义中定义的命名空间处理。

false

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

"namespace-declarations"

如果参数“命名空间”设置为 false这个参数没有影响。

true

[要求]（默认）包括命名空间属性，指定或默认的模式，在文件。参见章节“声明命名空间”[ XML Namespaces ]和[ XML Namespaces 1.1 ]。

false

[要求]放弃所有命名空间声明属性。命名空间的前缀（ Node.prefix）甚至如果这个参数设置为 false保留。

"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 Part 1 ] 注： XML架构，应用程序必须使用价值"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 Schema，DTD，其他任何类型或图式表示）的文件是由[ ]定义 XML 1.0归一化。如果找到验证错误，或没有找到架构，则通知错误处理程序。图式规范值不会暴露根据模式中使用参数“类型化”，除非是 true。此参数将重新评估：

• 与Attr.specified属性节点等于false，在Attr接口描述；
• 所有的属性Text.isElementContentWhitespace Text节点的值；
• 所有的属性Attr.isId Attr节点的值；
• 属性Element.schemaTypeInfo和Attr.schemaTypeInfo。

“如果注：验证模式”和“验证”是互斥的，设置其中的一个true将另一个false。应用程序应考虑设置参数”形成的“true，这对这些选项的默认，在验证文件。

false

[要求]（默认）不完成模式处理，包括内部子集处理。默认属性值信息保存。请注意，如果“验证验证可能仍然如果图式”是 true发生。

"validate-if-schema"

true

[可选]验证，只有一个文档元素声明可以在模式中发现（独立的地方被发现，即XML、DTD，或任何其他类型或图式表示）。如果已启用验证，此参数作为参数“验证”设置为 true相同。

“如果注：验证模式”和“验证”是互斥的，设置其中的一个true将另一个false。

false

如果文档有一个模式，包括内部子集处理，则不需要执行模式处理（默认）。默认属性值信息保存。请注意，验证必须仍然发生如果“验证”是 true。

"well-formed"

true

[要求]（默认）检查是否所有节点的XML格式良好的根据使用的XML版本：

• 检查属性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严重程度，必要时；

Document.xmlVersion

false

[可选]不检查XML格式。

与实体的系统标识符的分辨率是通过使用Document.documentURI。然而，当特征“ls”[ DOM Level 3 Load and Save ]的定义是通过DOM实现支持，参数“资源解析器”还可以用在DOMConfiguration附着物Document节点。如果设置了这个参数，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对象，其中至少有一个值可以通过设置中的应用。
void	setParameter(String name, Object value) 设置参数的值。

方法详细信息

setParameter

void setParameter(String name,
                  Object value)
           throws DOMException

设置参数的值。

参数

name -参数的名称设置。

value -新的价值或 null如果用户希望设置参数。而价值参数的类型被定义为 DOMUserData，对象类型必须定义的参数类型匹配。例如，如果参数是“错误处理”，该值的类型必须是 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()

列表的参数支持的 DOMConfiguration对象，其中至少有一个值可以通过设置中的应用。请注意，此列表还可以包含在本规范外定义的参数名称。