モジュール java.xml
パッケージ org.w3c.dom

インタフェースEntity

すべてのスーパー・インタフェース:
Node
public interface Entity extends Node
このインタフェースは、XML文書内の解析対象または解析対象外の既知のエンティティを表します。 このインタフェースによってモデル化されるのは、エンティティ宣言ではなくエンティティ自体です。

Nodeから継承されたnodeName属性には、エンティティの名前が含まれています。

XMLプロセッサは、構造モデルがDOMに渡される前にエンティティを完全に展開することを選択できます。この場合、文書ツリー内にEntityReferenceノードは存在しなくなります。

XMLでは、外部サブセット内で作成されたエンティティ宣言、またはパラメータ・エンティティ内で宣言されたエンティティ宣言の非検証XMLプロセッサによる読取りおよび処理は義務付けられていません。 つまり、外部サブセット内に宣言された解析対象エンティティを、アプリケーション・クラスを使用して展開する必要はありません。また、エンティティの置換テキストは使用できない可能性があります。 置換テキストが使用できる場合、対応するEntityノードの子リストは、その置換値の構造を表します。 使用できない場合、子リストは空です。

DOM Level 3は、Entityノードの編集をサポートしていません。ユーザーがEntityの内容を変更する場合は、構造モデル内の関連するすべてのEntityReferenceノードをEntityの内容の複製で置き換えた後、かわりにこれらの各複製に必要な変更を加える必要があります。 Entityノードとその子孫はすべて読取り専用です。

Entityノードは親ノードを持ちません。

ノート: エンティティに、バインドされていない名前空間接頭辞が含まれている場合、Entityノードのサブツリーにある対応するノードのnamespaceURIはnullになります。 このエンティティを参照するEntityReferenceノードがDocumentインタフェースのcreateEntityReferenceメソッドを使用して作成されている場合も同様です。

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

  • メソッドの詳細

    • getPublicId

      String getPublicId()
      エンティティに関連する公開識別子(指定されている場合)。指定されていない場合はnull。

    • getSystemId

      String getSystemId()
      エンティティに関連するシステム識別子(指定されている場合)。指定されていない場合はnull。 システム識別子は、絶対URIである場合もあり、そうでない場合もあります。

    • getNotationName

      String getNotationName()
      解析対象外エンティティの場合はエンティティの表記法の名前。 解析対象エンティティの場合はnullになります。

    • getInputEncoding

      String getInputEncoding()
      エンティティが外部解析対象エンティティである場合は、解析時にこのエンティティに使用されるエンコーディングを指定する属性。 エンティティが内部サブセットのエンティティであるか、未知の場合はnullになります。
      導入されたバージョン:
      1.5、DOMレベル3

    • getXmlEncoding

      String getXmlEncoding()
      エンティティが外部解析対象エンティティである場合に、テキスト宣言の一部として、このエンティティのエンコーディングを指定する属性。 その他の場合はnull。
      導入されたバージョン:
      1.5、DOMレベル3

    • getXmlVersion

      String getXmlVersion()
      エンティティが外部解析対象エンティティである場合に、テキスト宣言の一部として、このエンティティのバージョン番号を指定する属性。 その他の場合はnull。
      導入されたバージョン:
      1.5、DOMレベル3