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」も参照してください。

フィールドのサマリー

インタフェース org.w3c.dom.Node から継承されたフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getInputEncoding() エンティティーが外部解析対象エンティティーである場合は、解析時にこのエンティティーに使用されるエンコーディングを指定する属性。
String	getNotationName() 解析対象外エンティティーの場合はエンティティーの表記法の名前。
String	getPublicId() エンティティーに関連する公開識別子 (指定されている場合)。指定されていない場合は null。
String	getSystemId() エンティティーに関連するシステム識別子 (指定されている場合)。指定されていない場合は null。
String	getXmlEncoding() エンティティーが外部解析対象エンティティーである場合に、テキスト宣言の一部として、このエンティティーのエンコーディングを指定する属性。
String	getXmlVersion() エンティティーが外部解析対象エンティティーである場合に、テキスト宣言の一部として、このエンティティーのバージョン番号を指定する属性。

インタフェース org.w3c.dom.Node から継承されたメソッド

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

メソッドの詳細

getPublicId

String getPublicId()

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

getSystemId

String getSystemId()

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

getNotationName

String getNotationName()

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

getInputEncoding

String getInputEncoding()

エンティティーが外部解析対象エンティティーである場合は、解析時にこのエンティティーに使用されるエンコーディングを指定する属性。エンティティーが内部サブセットのエンティティーであるか、未知の場合は null になります。

導入されたバージョン:

DOM Level 3

getXmlEncoding

String getXmlEncoding()

エンティティーが外部解析対象エンティティーである場合に、テキスト宣言の一部として、このエンティティーのエンコーディングを指定する属性。その他の場合は null。

導入されたバージョン:

DOM Level 3

getXmlVersion

String getXmlVersion()

エンティティーが外部解析対象エンティティーである場合に、テキスト宣言の一部として、このエンティティーのバージョン番号を指定する属性。その他の場合は null。

導入されたバージョン:

DOM Level 3