モジュール java.xml

パッケージ org.w3c.dom

インタフェースDOMConfiguration

public interface DOMConfiguration

DOMConfigurationインタフェースは文書の構成を表し、認められているパラメータのテーブルを保持します。 この構成を使用すると、CDATASectionノードのTextノードへの置き換えや、Documentの検証が要求されたときに使用する必要のあるスキーマの型の指定などのDocument.normalizeDocument()の動作を変更できます。 DOMConfigurationオブジェクトはまた、DOMParserインタフェースやDOMSerializerインタフェース内の「DOM Level 3 Load and Save」でも使用されます。

DOMConfigurationオブジェクトによって使用されるパラメータ名は、DOM Level 3仕様全体にわたって定義されています。 名前は大文字と小文字が区別されます。 コンフリクトを避けるため、規則として、DOM仕様の範囲外で定義されたパラメータを参照する名前は一意にする必要があります。 パラメータはプロパティとして公開されるので、名前は、追加の文字「-」(HYPHEN-MINUS)を含む「Unicode」のセクション5.16「識別子」に従うことをお勧めしますが、DOM実装により強制はされません。 DOMレベル3コア実装では、この仕様で定義されているすべてのパラメータを認識する必要があります。 一部のパラメータ値も、この実装でサポートされる必要があります。 値がサポートされているかどうかについては、パラメータの定義を参照してください。

ノート: パラメータは、SAX2「SAX」で使用される機能およびプロパティと同様です。

次のパラメータ・リストはDOMで定義されています。

"canonical-form"

true

[オプション]ツリーからDocumentTypeノード(存在する場合)を削除したり、各要素から余分な名前空間宣言を削除したりするなど、「正規XML」で指定されている規則に従って文書を正規化します。 これはDOMで表現できるコンテンツに制限されます。特に、DOMで属性の順序を指定する方法はありません。 さらに、このパラメータをtrueに設定すると、次のパラメータの状態も設定されます。 後で、これらのいずれかのパラメータの状態を変更すると、「canonical-form」がfalseに戻ります。 falseに設定されるパラメータには、entities、normalize-characters、cdata-sectionsがあります。 trueに設定されるパラメータには、namespaces、namespace-declarations、well-formed、element-content-whitespaceがあります。 それ以外のパラメータは、パラメータの説明に明示的に指定されていないかぎり、変更されません。

false

[必須] (デフォルト)文書を正規化しません。

"cdata-sections"

true

[必須] (デフォルト)文書のCDATASectionノードを維持します。

false

[必須]文書内のCDATASectionノードをTextノードに変換します。 これにより、新しいTextノードが、隣接するすべてのTextノードと結合されます。

"check-character-normalization"

true

[オプション]文書内の文字が、「XML 1.1」の付録Bで定義されているように、完全に正規化されているかどうかを確認します。 正規化チェックに失敗した文字シーケンスが検出された場合は、DOMError.typeが「check-character-normalization-failure」に等しいエラーが発行されます。

false

[必須] (デフォルト)文字が正規化されているかどうかを確認しません。

"comments"

true

[必須] (デフォルト)文書のCommentノードを維持します。

false

[必須]文書内のCommentノードを破棄します。

"datatype-normalization"

true

[オプション] XMLスキーマの場合のXMLスキーマ正規化値などの、ツリー内のスキーマ正規化値を公開します。 このパラメータにはスキーマ情報が含まれている必要があるため、「validate」パラメータもtrueに設定されます。 「validate」がfalseのときにこのパラメータをアクティブにしても効果はなく、スキーマの正規化は行われません。

ノート: 文書はXML 1.0処理の結果を含んでいるので、このパラメータは、「XML 1.0」のセクション3.3.3で定義されている属性値正規化には適用されず、文書型定義(DTD)以外のスキーマ言語だけを対象にしています。

false

[必須] (デフォルト)ツリー上でスキーマの正規化を実行しません。

"element-content-whitespace"

true

[必須] (デフォルト)文書内のすべての空白文字を維持します。

false

[オプション]「要素コンテンツの空白文字」で説明されている、要素コンテンツ内に空白文字を含むすべてのTextノードを破棄します。 実装では、Text.isElementContentWhitespace属性を使用して、Textノードを破棄する必要があるかどうかを判定することが求められます。

"entities"

true

[必須] (デフォルト)文書のEntityReferenceノードを維持します。

false

[必須]文書からすべてのEntityReferenceノードを削除し、その場所で直接エンティティ拡張を行います。 Textノードは、Node.normalizeで定義されているように正規化されます。 拡張されていないエンティティ参照だけが文書内に保持されます。

ノート: このパラメータはEntityノードには影響しません。

"error-handler"

[必須] DOMErrorHandlerオブジェクトを含みます。 文書内でエラーが検出された場合、実装ではこのパラメータを使用して、登録されたDOMErrorHandlerを呼び出します。 実装では、デフォルトのDOMErrorHandlerオブジェクトが提供される場合があります。 呼び出された場合、DOMError.relatedDataには、エラーが発生した場所にもっとも近いノードが含まれます。 エラーが発生したノードを実装が特定できない場合、DOMError.relatedDataにはDocumentノードが含まれます。 エラー・ハンドラ内から文書に対して変更を加えると、実装に依存した動作になります。

"infoset"

true

[必須] XML情報セット「XML Information Set」で定義された情報を文書内に維持します。これにより、「validate-if-schema」、「entities」、「datatype-normalization」、「cdata-sections」の各パラメータが強制的にfalseに設定されます。これにより、「namespace-declarations」、「well-formed」、「element-content-whitespace」、「comments」、「namespaces」の各パラメータが強制的にtrueに設定されます。その他のパラメータは、パラメータの説明で明示的に指定されていないかぎり変更されません。 getParameterでこのパラメータを照会すると、上記で指定された個々のパラメータが適切に設定されている場合にのみtrueが返されます。

false

infosetをfalseに設定しても効果はありません。

"namespaces"

true

[必須] (デフォルト)定義に従って、名前空間処理を実行します。

false

[オプション]名前空間処理を実行しません。

"namespace-declarations"

「namespaces」パラメータがfalseに設定されている場合、このパラメータは効果がありません。

true

[必須] (デフォルト)スキーマから指定またはデフォルト設定されている名前空間宣言属性を文書内に含めます。 「XML名前空間」と「XML名前空間1.1」の「名前空間の宣言」セクションも参照してください。

false

[必須]すべての名前空間宣言属性を破棄します。 このパラメータがfalseに設定されていても、名前空間接頭辞(Node.prefix)は保持されます。

"normalize-characters"

true

[オプション]「XML 1.1」の付録Bで定義されているように、文書内の文字を完全に正規化します。

false

[必須] (デフォルト)文字の正規化を実行しません。

"schema-location"

[オプション]空白文字(「XML 1.0」のセクション2.3で定義されている非終端生成Sに一致する文字)で区切られたURIのリストを含むDOMStringオブジェクトを表します。このオブジェクトは、検証が行われるスキーマ(現在のスキーマ)を表します。 このリストで参照されるスキーマの型は、schema-typeで指定された型に一致しなければいけません。一致しない場合、実装の動作は保証されません。 このプロパティを使用して指定されたスキーマは、文書で独自に指定されたスキーマ情報より優先されます。 名前空間認識スキーマの場合、このプロパティで指定されたスキーマと、スキーマ・ドキュメント(スキーマimportメカニズムを使用)のドキュメント・インスタンス(schemaLocation属性を使用)で指定されたスキーマが同じtargetNamespaceを共有するとき、ユーザーがこのプロパティを使用して指定したスキーマが使用されます。 このプロパティを使用して指定された2つのスキーマが、同じtargetNamespaceを共有するか、名前空間を持たない場合、動作は実装に依存して決まります。 場所を指定しなかった場合、このパラメータはnullになります。

ノート: 「schema-type」パラメータ値が設定されていないかぎり、"schema-location"パラメータは無視されます。 参照されたすべての外部エンティティを実装で正常に解決できるように、Document.documentURIを設定することを強くお勧めします。

"schema-type"

[オプション]絶対URIを含み、文書の検証に使用されるスキーマ言語の型を表すDOMStringオブジェクトを表します。 絶対URIで、字句チェックは行われないことに注意。 このパラメータが設定されない場合、実装では、サポートされているスキーマ言語やロード時に使用されたスキーマ言語に応じて、デフォルトの値を指定できます。 値が指定されない場合、このパラメータはnullになります。

ノート: XMLスキーマ「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インタフェースの説明で指定されているように、Attr.specifiedがfalseに等しい属性ノード。
• すべての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、またはスキーマのその他の任意の型または表現のどこで見つかったかには関係なく)検証を有効にします。 検証が有効になっている場合、このパラメータは、「validate」パラメータがtrueに設定されている場合と同じ動作を行います。

ノート: 「validate-if-schema」と「validate」は相互に排他的です。一方をtrueに設定すると、他方はfalseに設定されます。

false

[必須] (デフォルト)文書にスキーマが含まれている場合は、内部サブセット処理も含め、スキーマ処理を実行しません。 デフォルトの属性値情報は維持されます。 「validate」がtrueである場合は、引き続き検証が行われます。

"well-formed"

true

[必須] (デフォルト)すべてのノードが、Document.xmlVersionで使用中のXMLバージョンに従う整形式のXMLであるかどうかを確認します。

• Node.nodeName属性にそのノード型に応じた無効な文字が含まれているかどうかを確認し、必要に応じて、重要度がDOMError.SEVERITY_ERRORで、型が"wf-invalid-character-in-node-name"のDOMErrorを生成します。
• Attr、Element、Comment、Text、CDATASectionの各ノード内のテキスト・コンテンツに無効な文字が含まれているかどうかを確認し、必要に応じて、重要度がDOMError.SEVERITY_ERRORで、型が"wf-invalid-character"のDOMErrorを生成します。
• ProcessingInstructionノード内のデータに無効な文字が含まれているかどうかを確認し、必要に応じて、重要度がDOMError.SEVERITY_ERRORで、型が"wf-invalid-character"のDOMErrorを生成します。

false

[オプション] XMLの整形式をチェックしません。

エンティティに関連付けられシステム識別子の解決は、Document.documentURIを使用して実行されます。 ただし、「DOM Level 3 Load and Save」で定義されている「LS」機能がDOM実装でサポートされている場合は、Documentノードに接続されたDOMConfigurationオブジェクト上で「resource-resolver」パラメータを使用することもできます。 このパラメータが設定されている場合、Document.normalizeDocument()はDocument.documentURIを使用する代わりにリソース・リゾルバを呼び出します。

「Document Object Model (DOM) Level 3 Core Specification」も参照してください。

導入されたバージョン:

1.5、DOMレベル3

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	canSetParameter(String name, Object value)	特定の値に対してパラメータを設定することがサポートされているかどうかをチェックします。
Object	getParameter(String name)	既知の場合は、パラメータの値を返します。
DOMStringList	getParameterNames()	DOMConfigurationオブジェクトがサポートしているパラメータのリスト。アプリケーションでは少なくとも1つの値をこれらのパラメータに対して設定できます。
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()

DOMConfigurationオブジェクトがサポートしているパラメータのリスト。アプリケーションでは少なくとも1つの値をこれらのパラメータに対して設定できます。 このリストには、この仕様の外部で定義されたパラメータ名も含まれる可能性があります。