javax.imageio.metadata
クラス IIOMetadataNode

java.lang.Object
  javax.imageio.metadata.IIOMetadataNode

すべての実装されたインタフェース:

Element, Node, NodeList

public class IIOMetadataNode
extends Object
implements Element, NodeList

メタデータツリーのノードを表すクラスで、org.w3c.dom.Element インタフェースを実装し、さらに getUserObject および setUserObject メソッドを使用してテキスト以外のオブジェクトを格納できるようにします。

このクラスは、一般の XML 処理に使用することを想定していません。特に、イメージ入出力 API で作成された Element ノードは、Sun の org.w3.dom API の標準実装で作成されたノードと互換性がありません。特に、実装は単純な使い方をするように調整されており、集中的な処理では十分に動作しない場合があります。

この実装では名前空間は無視されます。用語の「タグ名」と「ノード名」は、常に同義と見なされます。

関連項目:

IIOMetadata.getAsTree(java.lang.String), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node)

フィールドの概要

インタフェース 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

コンストラクタの概要

IIOMetadataNode()
空の IIOMetadataNode を構築します。

IIOMetadataNode(String nodeName)
指定されたノード名を持つ IIOMetadataNode を構築します。

メソッドの概要

Node	appendChild(Node newChild) ノード newChild をこのノードの子のリストの末尾に追加します。
Node	cloneNode(boolean deep) このノードの複製を返します。
short	compareDocumentPosition(Node other) このメソッドが呼び出されている参照ノードを、パラメータとして渡されるノードと、文書内の位置に関して文書順に比較します。
String	getAttribute(String name) 名前を指定して属性を取得します。
Attr	getAttributeNode(String name) 名前を指定して属性ノードを取得します。
Attr	getAttributeNodeNS(String namespaceURI, String localName) getAttributeNode(localName) と同じです。
String	getAttributeNS(String namespaceURI, String localName) getAttribute(localName) と同じです。
NamedNodeMap	getAttributes() このノードが Element の場合、このノードの属性を含む NamedNodeMap です。
String	getBaseURI() このノードの絶対ベース URI、実装が絶対 URI を取得できなかった場合は null になります。
NodeList	getChildNodes() このノードの子をすべて含む NodeList です。
NodeList	getElementsByTagName(String name) 所定のタグ名とともに、すべての子孫 Elements の NodeList を文書順に返します。
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) getElementsByTagName(localName) と同じです。
Object	getFeature(String feature, String version) このメソッドは、指定した機能とバージョンを持つ特殊な形式の API を指定されたとおりに実装する特殊な形式のオブジェクトを返します。
Node	getFirstChild() このノードの最初の子を返します。
Node	getLastChild() このノードの最後の子を返します。
int	getLength() リスト内のノード数です。
String	getLocalName() getNodeName と同じです。
String	getNamespaceURI() 名前空間はサポートされないので、null を返します。
Node	getNextSibling() このノードの次の兄弟ウィジェットを返します。
String	getNodeName() このノードに関連したノード名を返します。
short	getNodeType() 常に ELEMENT_NODE であるノードの型を返します。
String	getNodeValue() このノードの値です。
Document	getOwnerDocument() IIOMetadataNode はどの Document にも属していないので、null を返します。
Node	getParentNode() このノードの親を返します。
String	getPrefix() 名前空間はサポートされないので、null を返します。
Node	getPreviousSibling() このノードの前の兄弟ウィジェットを返します。
TypeInfo	getSchemaTypeInfo() この要素に関連する型情報です。
String	getTagName() 要素の名前です。
String	getTextContent() この属性は、指定されたノードとノードの子孫のテキストコンテンツを返します。
Object	getUserData(String key) このノードのキーに関連付けられたオブジェクトを取得します。
Object	getUserObject() このノードに関連した Object 値を返します。
boolean	hasAttribute(String name) この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false
boolean	hasAttributeNS(String namespaceURI, String localName) hasAttribute(localName) と同じです。
boolean	hasAttributes() このノードが要素である場合、属性を持っているかどうかを返します。
boolean	hasChildNodes() このノードに子ノードがある場合は true を返します。
Node	insertBefore(Node newChild, Node refChild) 既存の子ノード refChild の前に newChild ノードを挿入します。
boolean	isDefaultNamespace(String namespaceURI) このメソッドは、指定された namespaceURI がデフォルトの名前空間であるかどうかをチェックします。
boolean	isEqualNode(Node node) 2 つのノードが等しいかどうかをテストします。
boolean	isSameNode(Node node) このノードが指定されたノードと同じノードであるかどうかを返します。
boolean	isSupported(String feature, String version) DOM 機能はサポートされていないので、false を返します。
Node	item(int index) コレクション内の index 番目の項目を返します。
String	lookupNamespaceURI(String prefix) 指定したノードから開始して、所定の接頭辞に関連する名前空間 URI を検索します。
String	lookupPrefix(String namespaceURI) 指定されたノードから開始して、所定の名前空間 URI に関連する接頭辞を検索します。
void	normalize() IIOMetadataNode には子 Text が格納されないので、何も実行しません。
void	removeAttribute(String name) 名前を指定して属性を削除します。
Attr	removeAttributeNode(Attr oldAttr) 指定された属性ノードを削除します。
void	removeAttributeNS(String namespaceURI, String localName) removeAttribute(localName) と同じです。
Node	removeChild(Node oldChild) 子リストから oldChild で示される子ノードを削除し、この子ノードを返します。
Node	replaceChild(Node newChild, Node oldChild) 子リストの中の子ノード oldChild を newChild で置き換え、oldChild ノードを返します。
void	setAttribute(String name, String value) 新しい属性を追加します。
Attr	setAttributeNode(Attr newAttr) 新しい属性を追加します。
Attr	setAttributeNodeNS(Attr newAttr) setAttributeNode(newAttr) と同じです。
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) setAttribute(qualifiedName, value) と同じです。
void	setIdAttribute(String name, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性が ユーザ決定 ID 属性であることを宣言します。
void	setIdAttributeNode(Attr idAttr, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。
void	setNodeValue(String nodeValue) このノードの値です。
void	setPrefix(String prefix) 名前空間はサポートされないので、何も実行しません。
void	setTextContent(String textContent) この属性は、指定されたノードとノードの子孫のテキストコンテンツを返します。
Object	setUserData(String key, Object data, UserDataHandler handler) このノードのキーにオブジェクトを関連付けます。
void	setUserObject(Object userObject) このノードに関連した値を設定します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

IIOMetadataNode

public IIOMetadataNode()

空の IIOMetadataNode を構築します。

IIOMetadataNode

public IIOMetadataNode(String nodeName)

指定されたノード名を持つ IIOMetadataNode を構築します。

パラメータ:

nodeName - String としての、ノードの名前

メソッドの詳細

getNodeName

public String getNodeName()

このノードに関連したノード名を返します。

定義:

インタフェース Node 内の getNodeName

戻り値:

String としてのノード名

getNodeValue

public String getNodeValue()
                    throws DOMException

インタフェース Node の記述:

このノードの値です。この値は型によって異なります。前述の表を参照してください。null になるように定義した場合は、ノードが読み取り専用であるかどうかを含めて、この null を設定しても影響はありません。

定義:

インタフェース Node 内の getNodeValue

例外:

DOMException - DOMSTRING_SIZE_ERR: 返される文字数が多すぎて実装プラットフォーム上の DOMString 変数に収まらない場合

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

インタフェース Node の記述:

このノードの値です。この値は型によって異なります。前述の表を参照してください。null になるように定義した場合は、ノードが読み取り専用であるかどうかを含めて、この null を設定しても影響はありません。

定義:

インタフェース Node 内の setNodeValue

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: ノードが読み取り専用の場合、および null であると定義されていない場合

getNodeType

public short getNodeType()

常に ELEMENT_NODE であるノードの型を返します。

定義:

インタフェース Node 内の getNodeType

戻り値:

short 値の ELEMENT_NODE

getParentNode

public Node getParentNode()

このノードの親を返します。null 値は、ノードが独自のツリーのルートであることを示します。ノードを既存のツリーに追加するには、insertBefore、replaceChild、または appendChild メソッドの 1 つを使用します。

定義:

インタフェース Node 内の getParentNode

戻り値:

Node としての親

関連項目:

insertBefore(org.w3c.dom.Node, org.w3c.dom.Node), replaceChild(org.w3c.dom.Node, org.w3c.dom.Node), appendChild(org.w3c.dom.Node)

getChildNodes

public NodeList getChildNodes()

インタフェース Node の記述:

このノードの子をすべて含む NodeList です。子が存在しない場合、ノードを持たない NodeList が返されます。

定義:

インタフェース Node 内の getChildNodes

getFirstChild

public Node getFirstChild()

このノードの最初の子を返します。ノードに子がない場合は null を返します。

定義:

インタフェース Node 内の getFirstChild

戻り値:

Node としての最初の子、または null

getLastChild

public Node getLastChild()

このノードの最後の子を返します。ノードに子がない場合は null を返します。

定義:

インタフェース Node 内の getLastChild

戻り値:

Node としての最後の子、または null

getPreviousSibling

public Node getPreviousSibling()

このノードの前の兄弟ウィジェットを返します。このノードに前の兄弟ウィジェットがない場合は null を返します。

定義:

インタフェース Node 内の getPreviousSibling

戻り値:

Node としての前の兄弟ウィジェット、または null

getNextSibling

public Node getNextSibling()

このノードの次の兄弟ウィジェットを返します。このノードに次の兄弟ウィジェットがない場合は null を返します。

定義:

インタフェース Node 内の getNextSibling

戻り値:

Node としての次の兄弟ウィジェット、または null

getAttributes

public NamedNodeMap getAttributes()

インタフェース Node の記述:

このノードが Element の場合、このノードの属性を含む NamedNodeMap です。それ以外の場合は null です。

定義:

インタフェース Node 内の getAttributes

getOwnerDocument

public Document getOwnerDocument()

IIOMetadataNode はどの Document にも属していないので、null を返します。

定義:

インタフェース Node 内の getOwnerDocument

戻り値:

null

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)

既存の子ノード refChild の前に newChild ノードを挿入します。refChild が null の場合、newChild は子リストの末尾に挿入されます。

定義:

インタフェース Node 内の insertBefore

パラメータ:

newChild - 挿入する Node

refChild - 参照 Node

戻り値:

挿入されるノード

例外:

IllegalArgumentException - newChild が null の場合

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)

子リストの中の子ノード oldChild を newChild で置き換え、oldChild ノードを返します。

定義:

インタフェース Node 内の replaceChild

パラメータ:

newChild - 挿入する Node

oldChild - 置換される Node

戻り値:

置換されたノード

例外:

IllegalArgumentException - newChild が null の場合

removeChild

public Node removeChild(Node oldChild)

子リストから oldChild で示される子ノードを削除し、この子ノードを返します。

定義:

インタフェース Node 内の removeChild

パラメータ:

oldChild - 削除される Node

戻り値:

削除されたノード

例外:

IllegalArgumentException - oldChild が null の場合

appendChild

public Node appendChild(Node newChild)

ノード newChild をこのノードの子のリストの末尾に追加します。

定義:

インタフェース Node 内の appendChild

パラメータ:

newChild - 挿入する Node

戻り値:

追加されたノード

例外:

IllegalArgumentException - newChild が null の場合

hasChildNodes

public boolean hasChildNodes()

このノードに子ノードがある場合は true を返します。

定義:

インタフェース Node 内の hasChildNodes

戻り値:

このノードに子がある場合は true

cloneNode

public Node cloneNode(boolean deep)

このノードの複製を返します。複製ノードには親がありません (getParentNode は null を返します)。シャロー複製を実行すると (deep は false)、新しいノードには子や兄弟ウィジェットがありません。ディープ複製を実行すると、新しいノードは完全に複製されたサブツリーのルートを形成します。

定義:

インタフェース Node 内の cloneNode

パラメータ:

deep - true の場合は、指定されたノードの下にサブツリーを再帰的に複製し、false の場合は、ノード自体だけを複製する

戻り値:

複製されたノード

normalize

public void normalize()

IIOMetadataNode には子 Text が格納されないので、何も実行しません。

定義:

インタフェース Node 内の normalize

isSupported

public boolean isSupported(String feature,
                           String version)

DOM 機能はサポートされていないので、false を返します。

定義:

インタフェース Node 内の isSupported

パラメータ:

feature - String。無視される

version - String。無視される

戻り値:

false

getNamespaceURI

public String getNamespaceURI()
                       throws DOMException

名前空間はサポートされないので、null を返します。

定義:

インタフェース Node 内の getNamespaceURI

例外:

DOMException

getPrefix

public String getPrefix()

名前空間はサポートされないので、null を返します。

定義:

インタフェース Node 内の getPrefix

戻り値:

null

関連項目:

setPrefix(java.lang.String)

setPrefix

public void setPrefix(String prefix)

名前空間はサポートされないので、何も実行しません。

定義:

インタフェース Node 内の setPrefix

パラメータ:

prefix - String。無視される

関連項目:

getPrefix()

getLocalName

public String getLocalName()

getNodeName と同じです。

定義:

インタフェース Node 内の getLocalName

戻り値:

String としてのノード名

getTagName

public String getTagName()

インタフェース Element の記述:

要素の名前です。Node.localName が null ではない場合、この属性は修飾名です。次に例を示します。

 <elementExample id="demo">
 ... 
</elementExample> , 

tagName の値は「elementExample」です。XML では、DOM の操作と同様にアルファベットの大文字と小文字の区別が保存されます。HTML DOM は、ソースとなる HTML 文書で大文字と小文字のどちらが使用されていても、HTML 要素の tagName を標準の大文字で返します。

定義:

インタフェース Element 内の getTagName

getAttribute

public String getAttribute(String name)

インタフェース Element の記述:

名前を指定して属性を取得します。

定義:

インタフェース Element 内の getAttribute

パラメータ:

name - 取得する属性の名前

戻り値:

文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

getAttribute(localName) と同じです。

定義:

インタフェース Element 内の getAttributeNS

パラメータ:

namespaceURI - 取得する属性の名前空間 URI

localName - 取得する属性のローカル名

戻り値:

文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列

関連項目:

setAttributeNS(java.lang.String, java.lang.String, java.lang.String)

setAttribute

public void setAttribute(String name,
                         String value)

インタフェース Element の記述:

新しい属性を追加します。要素内にその名前の属性がすでに存在する場合、その値は value パラメータの値に変更されます。この値は単純な文字列であり、設定時に解析は行われません。その結果、あらゆるマークアップ (実体参照として認識される構文を含む) が文字テキストと見なされます。実装は、書き出しを行う際、これを適切な方法でエスケープする必要があります。実体参照を含む属性値を割り当てるには、Attr ノードのほかに Text ノードと EntityReference ノードを作成する必要があります。次に、適切なサブツリーを構築し、setAttributeNode を使用して、これを属性値として割り当てます。
修飾名と名前空間 URI を持つ属性を設定するには、setAttributeNS メソッドを使用します。

定義:

インタフェース Element 内の setAttribute

パラメータ:

name - 作成または変更する属性の名前

value - 設定する値を表す文字列

setAttributeNS

public void setAttributeNS(String namespaceURI,
                           String qualifiedName,
                           String value)

setAttribute(qualifiedName, value) と同じです。

定義:

インタフェース Element 内の setAttributeNS

パラメータ:

namespaceURI - 作成または変更する属性の名前空間 URI

qualifiedName - 作成または変更する属性の修飾名

value - 設定する値を表す文字列形式

関連項目:

getAttributeNS(java.lang.String, java.lang.String)

removeAttribute

public void removeAttribute(String name)

インタフェース Element の記述:

名前を指定して属性を削除します。削除される属性のデフォルト値が DTD で定義されていると、デフォルト値ばかりでなく、該当する場合は対応する名前空間 URI、ローカル名、接頭辞とともに新しい属性がすぐに表示されます。実装では、ほかのスキーマのデフォルト値を同様に処理できますが、アプリケーションでは Document.normalizeDocument() を使用して、情報が最新の情報であることを保証する必要があります。
この名前を持つ属性が見つからない場合には、このメソッドは効果がありません。
ローカル名と名前空間 URI で属性を削除するには、removeAttributeNS メソッドを使用します。

定義:

インタフェース Element 内の removeAttribute

パラメータ:

name - 削除する属性の名前

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

removeAttribute(localName) と同じです。

定義:

インタフェース Element 内の removeAttributeNS

パラメータ:

namespaceURI - 削除する属性の名前空間 URI

localName - 削除する属性のローカル名

getAttributeNode

public Attr getAttributeNode(String name)

インタフェース Element の記述:

名前を指定して属性ノードを取得します。
修飾名と名前空間 URI を指定して属性ノードを取得するには、getAttributeNodeNS メソッドを使用します。

定義:

インタフェース Element 内の getAttributeNode

パラメータ:

name - 取得する属性の名前 (nodeName)

戻り値:

指定された名前 ( nodeName) の Attr ノード。該当する属性が存在しない場合は null

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

getAttributeNode(localName) と同じです。

定義:

インタフェース Element 内の getAttributeNodeNS

パラメータ:

namespaceURI - 取得する属性の名前空間 URI

localName - 取得する属性のローカル名

戻り値:

指定された属性ローカル名と名前空間 URI を持つ Attr ノード。該当する属性が存在しない場合は null

関連項目:

setAttributeNodeNS(org.w3c.dom.Attr)

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException

インタフェース Element の記述:

新しい属性を追加します。指定した名前 (nodeName) を持つ属性がすでに要素内に存在する場合は、新しい属性に置き換えられます。属性ノードをその属性ノード自体に置き換えても影響はまったくありません。
修飾名と名前空間 URI を持つ属性ノードを新しく追加するには、setAttributeNodeNS メソッドを使用します。

定義:

インタフェース Element 内の setAttributeNode

パラメータ:

newAttr - 属性リストに追加する Attr ノード

戻り値:

既存の属性が newAttr 属性で置き換えられる場合は置き換えの対象となる Attr ノード。それ以外の場合は null

例外:

DOMException - WRONG_DOCUMENT_ERR: 要素を作成した文書とは異なる文書から newAttr が作成された場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
INUSE_ATTRIBUTE_ERR: newAttr が別の Element オブジェクトの属性である場合。Attr ノードをほかの要素で再利用するには、このノードを DOM ユーザの手で明示的に複製する必要がある

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)

setAttributeNode(newAttr) と同じです。

定義:

インタフェース Element 内の setAttributeNodeNS

パラメータ:

newAttr - 属性リストに追加する Attr ノード

戻り値:

指定と同じローカル名および名前空間 URI を持つ既存の属性が newAttr 属性で置き換えられる場合は置き換えの対象となる Attr ノード。それ以外の場合は null

関連項目:

getAttributeNodeNS(java.lang.String, java.lang.String)

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)

インタフェース Element の記述:

指定された属性ノードを削除します。削除される Attr ノードのデフォルト値が DTD で定義されていると、デフォルト値ばかりでなく、該当する場合は対応する名前空間 URI、ローカル名、接頭辞とともに新しいノードがすぐに表示されます。実装では、同様にほかのスキーマからのデフォルト値を処理できますが、アプリケーションでは Document.normalizeDocument() を使用して、情報が最新の情報であることを保証する必要があります。

定義:

インタフェース Element 内の removeAttributeNode

パラメータ:

oldAttr - 属性リストから削除する Attr ノード

戻り値:

削除された Attr ノード

getElementsByTagName

public NodeList getElementsByTagName(String name)

インタフェース Element の記述:

所定のタグ名とともに、すべての子孫 Elements の NodeList を文書順に返します。

定義:

インタフェース Element 内の getElementsByTagName

パラメータ:

name - 一致するタグの名前。特殊な値「*」はすべてのタグに一致する

戻り値:

一致する Element ノードのリスト

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

getElementsByTagName(localName) と同じです。

定義:

インタフェース Element 内の getElementsByTagNameNS

パラメータ:

namespaceURI - 一致する要素の名前空間 URI。特殊な値「*」はすべての名前空間に一致する

localName - 一致する要素のローカル名。特殊な値「*」はすべてのローカル名に一致する

戻り値:

一致するすべての Elements を含む新しい NodeList オブジェクト

hasAttributes

public boolean hasAttributes()

インタフェース Node の記述:

このノードが要素である場合、属性を持っているかどうかを返します。

定義:

インタフェース Node 内の hasAttributes

戻り値:

このノードが属性を持っている場合は true、そうでない場合は false

hasAttribute

public boolean hasAttribute(String name)

インタフェース Element の記述:

この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

定義:

インタフェース Element 内の hasAttribute

パラメータ:

name - 検索する属性の名前

戻り値:

この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)

hasAttribute(localName) と同じです。

定義:

インタフェース Element 内の hasAttributeNS

パラメータ:

namespaceURI - 検索する属性の名前空間 URI

localName - 検索する属性のローカル名

戻り値:

この要素上に所定のローカル名と名前空間 URI を持つ属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

getLength

public int getLength()

インタフェース NodeList の記述:

リスト内のノード数です。有効な子ノードインデックスの範囲は 0 以上 length-1 以下です。

定義:

インタフェース NodeList 内の getLength

item

public Node item(int index)

インタフェース NodeList の記述:

コレクション内の index 番目の項目を返します。index がリスト内のノード数と同じかそれよりも大きい場合は null を返します。

定義:

インタフェース NodeList 内の item

パラメータ:

index - コレクションのインデックス

戻り値:

NodeList 内の index 番目のノード。インデックスが有効でない場合は null

getUserObject

public Object getUserObject()

このノードに関連した Object 値を返します。

戻り値:

ユーザ Object

関連項目:

setUserObject(java.lang.Object)

setUserObject

public void setUserObject(Object userObject)

このノードに関連した値を設定します。

パラメータ:

userObject - ユーザ Object

関連項目:

getUserObject()

setIdAttribute

public void setIdAttribute(String name,
                           boolean isId)
                    throws DOMException

インタフェース Element の記述:

isId パラメータが true の場合、このメソッドは指定された属性が ユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。
ローカル名と名前空間 URI で属性を指定するには、setIdAttributeNS メソッドを使用します。

定義:

インタフェース Element 内の setIdAttribute

パラメータ:

name - 属性の名前

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI,
                             String localName,
                             boolean isId)
                      throws DOMException

インタフェース Element の記述:

isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。

定義:

インタフェース Element 内の setIdAttributeNS

パラメータ:

namespaceURI - 属性の名前空間 URI

localName - 属性のローカル名

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)
                        throws DOMException

インタフェース Element の記述:

isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。

定義:

インタフェース Element 内の setIdAttributeNode

パラメータ:

idAttr - 属性ノード

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

インタフェース Element の記述:

この要素に関連する型情報です。

定義:

インタフェース Element 内の getSchemaTypeInfo

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

インタフェース Node の記述:

このノードのキーにオブジェクトを関連付けます。これ以降、オブジェクトは、同じキーで getUserData を呼び出して取得できます。

定義:

インタフェース Node 内の setUserData

パラメータ:

key - オブジェクトを関連付けるキー

data - 所定のキーに関連付けるオブジェクト。所定のキーに対する既存の関連を削除するには null

handler - 所定のキーに関連付けるハンドラ、または null

戻り値:

このノードの所定のキーに以前関連付けられていた DOMUserData。DOMUserData がなかった場合は null

getUserData

public Object getUserData(String key)

インタフェース Node の記述:

このノードのキーに関連付けられたオブジェクトを取得します。オブジェクトは、まず同じキーで setUserData を呼び出して、このノードに対してすでに設定されている必要があります。

定義:

インタフェース Node 内の getUserData

パラメータ:

key - オブジェクトが関連付けられているキー

戻り値:

このノードの所定のキーに関連付けられた DOMUserData。DOMUserData がなかった場合は null

getFeature

public Object getFeature(String feature,
                         String version)

インタフェース Node の記述:

このメソッドは、指定した機能とバージョンを持つ特殊な形式の API を指定されたとおりに実装する特殊な形式のオブジェクトを返します。特殊な形式のオブジェクトは、バインディング固有のキャスティングメソッドを使用して取得することもできますが、必ずしも説明されているようにはいきません。このメソッドを使用すると、実装では Node インタフェースをサポートしていない特殊な形式のオブジェクトを利用できます。

定義:

インタフェース Node 内の getFeature

パラメータ:

feature - 要求された機能の名前。機能名の前に追加されるプラス記号「+」は、このメソッドのコンテキストでは有意ではないので無視される

version - テストする機能のバージョン番号

戻り値:

指定された機能とバージョンの特殊な形式の API を実装するオブジェクト (存在する場合)。指定された機能に関連するインタフェースを実装するオブジェクトが存在しない場合は null。このメソッドによって返される DOMObject が Node インタフェースを実装する場合、このインタフェースを主要コア Node に委譲し、attributes、childNodes といった主要コア Node と整合しない結果を返すことがないようにする必要がある

isSameNode

public boolean isSameNode(Node node)

インタフェース Node の記述:

このノードが指定されたノードと同じノードであるかどうかを返します。
このメソッドを使用すると、実装で返された 2 つの Node 参照が同じオブジェクトを参照するかどうかを判定できます。2 つの Node 参照が同じオブジェクトを参照する場合は、プロキシを通じた参照の場合でも、すべての属性が同じ値を持ち、どちらかの参照の同じ DOM メソッドの呼び出しが常にまったく同じ効果を発揮するように、参照を完全に交互に使用できます。

定義:

インタフェース Node 内の isSameNode

パラメータ:

node - テスト対象のノード

戻り値:

ノードが同じである場合は true、そうでない場合は false

isEqualNode

public boolean isEqualNode(Node node)

インタフェース Node の記述:

2 つのノードが等しいかどうかをテストします。
このメソッドは、Node.isSameNode() を使用してテストできるノードの同一性 (2 つのノードが同じオブジェクトを参照するかどうか) ではなく同等性をテストします。同じであるすべてのノードは同等でもありますが、その逆は必ずしも当てはまりません。　
2 つのノードが同等であるのは、次の条件が満たされる場合のみです。

• 2 つのノードが同じ型のノードである
• 文字列属性の nodeName、localName、namespaceURI、prefix、nodeValue が等しい。つまり、2 つのノードが null であるか、同じ長さを持ち、同一文字の文字である
• attributes NamedNodeMaps が等しい。つまり、2 つのノードが両方とも null であるか、または同じ長さを持ち、1 つのマップに存在する各ノードに対して他のマップに存在するノードがあり、等しいが、必ずしも同じインデックスにはない
• childNodes NodeLists が等しい。つまり、両方とも null であるか、または同じ長さを持ち、同じインデックスに等しいノードを持つ。正規化は、同等性に影響を及ぼす可能性があることに注意が必要。この影響を避けるには、ノードを正規化してから比較を行う必要がある

2 つの DocumentType ノードが等しいためには、次の条件が満たされる必要があります。

• 文字列属性の publicId、systemId、internalSubset が等しい
• entities NamedNodeMaps が等しい
• notations NamedNodeMaps が等しい

一方、次は同等性に影響を与えません。ownerDocument、baseURI、および parentNode 属性、Attr ノードの specified 属性、Attr ノードと Element ノードの schemaTypeInfo 属性、Text ノードの Text.isElementContentWhitespace 属性、およびノードに登録されているユーザデータまたはイベントリスナー

注:一般に、上の説明で取り上げられていないものは、同一性チェックの面で有意ではありません。この仕様の将来バージョンでは、より多くの属性を考慮し、この仕様に準拠する実装を適宜更新する予定です。

定義:

インタフェース Node 内の isEqualNode

パラメータ:

node - 同一性を比較する対象のノード

戻り値:

ノードが同一である場合は true、そうでない場合は false

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

インタフェース Node の記述:

指定したノードから開始して、所定の接頭辞に関連する名前空間 URI を検索します。
詳細は、このメソッドで使用されるアルゴリズムを参照してください。

定義:

インタフェース Node 内の lookupNamespaceURI

パラメータ:

prefix - 検索する接頭辞。このパラメータが null の場合、メソッドはデフォルトの名前空間 URＩ を返す (存在する場合)

戻り値:

関連する名前空間 URI、見つからなかった場合は null

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

インタフェース Node の記述:

このメソッドは、指定された namespaceURI がデフォルトの名前空間であるかどうかをチェックします。

定義:

インタフェース Node 内の isDefaultNamespace

パラメータ:

namespaceURI - 検索する名前空間 URI

戻り値:

指定された namespaceURI がデフォルトの名前空間である場合は true、そうでない場合は false

lookupPrefix

public String lookupPrefix(String namespaceURI)

インタフェース Node の記述:

指定されたノードから開始して、所定の名前空間 URI に関連する接頭辞を検索します。このメソッドは、デフォルトの名前空間宣言を無視します。
詳細は、このメソッドで使用されるアルゴリズムを参照してください。

定義:

インタフェース Node 内の lookupPrefix

パラメータ:

namespaceURI - 検索する名前空間 URI

戻り値:

見つかった場合は、関連する名前空間接頭辞、見つからなかった場合は null。複数の接頭辞が名前空間接頭辞に関連する場合、返される名前空間接頭辞は実装に応じて異なる

getTextContent

public String getTextContent()
                      throws DOMException

インタフェース Node の記述:

この属性は、指定されたノードとノードの子孫のテキストコンテンツを返します。この属性を null に定義した場合、設定による影響はありません。設定では、このノードが持つことができる考えられる子はすべて削除され、新しい文字列が空または null である場合、この属性が設定されている文字列を含む単一の Text ノードに置き換えられます。
取得では、直列化は行われず、返される文字列はマークアップを含みません。空白文字の正規化は行われず、返される文字列は要素コンテンツに空白文字を含みません (Text.isElementContentWhitespace 属性を参照)。同様に、設定では、解析も行われません。入力文字列は純粋なテキスト形式のコンテンツとして取得されます。
返される文字列は、次に示すようにノードの型に応じて、ノードのテキストコンテンツで構成されています。

ノード型	コンテンツ
ELEMENT_NODE、ATTRIBUTE_NODE、ENTITY_NODE、ENTITY_REFERENCE_NODE、DOCUMENT_FRAGMENT_NODE	COMMENT_NODE ノードと PROCESSING_INSTRUCTION_NODE ノードを除く、すべての子ノードの textContent 属性値の連結。ノードが子を持たない場合は、空の文字列
TEXT_NODE、CDATA_SECTION_NODE、COMMENT_NODE、PROCESSING_INSTRUCTION_NODE	nodeValue
DOCUMENT_NODE、DOCUMENT_TYPE_NODE、NOTATION_NODE	null

定義:

インタフェース Node 内の getTextContent

例外:

DOMException - DOMSTRING_SIZE_ERR: 返される文字数が多すぎて実装プラットフォーム上の DOMString 変数に収まらない場合

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

インタフェース Node の記述:

この属性は、指定されたノードとノードの子孫のテキストコンテンツを返します。この属性を null に定義した場合、設定による影響はありません。設定では、このノードが持つことができる考えられる子はすべて削除され、新しい文字列が空または null である場合、この属性が設定されている文字列を含む単一の Text ノードに置き換えられます。
取得では、直列化は行われず、返される文字列はマークアップを含みません。空白文字の正規化は行われず、返される文字列は要素コンテンツに空白文字を含みません (Text.isElementContentWhitespace 属性を参照)。同様に、設定では、解析も行われません。入力文字列は純粋なテキスト形式のコンテンツとして取得されます。
返される文字列は、次に示すようにノードの型に応じて、ノードのテキストコンテンツで構成されています。

ノード型	コンテンツ
ELEMENT_NODE、ATTRIBUTE_NODE、ENTITY_NODE、ENTITY_REFERENCE_NODE、DOCUMENT_FRAGMENT_NODE	COMMENT_NODE ノードと PROCESSING_INSTRUCTION_NODE ノードを除く、すべての子ノードの textContent 属性値の連結。ノードが子を持たない場合は、空の文字列
TEXT_NODE、CDATA_SECTION_NODE、COMMENT_NODE、PROCESSING_INSTRUCTION_NODE	nodeValue
DOCUMENT_NODE、DOCUMENT_TYPE_NODE、NOTATION_NODE	null

定義:

インタフェース Node 内の setTextContent

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: ノードが読み取り専用の場合

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

インタフェース Node の記述:

このメソッドが呼び出されている参照ノードを、パラメータとして渡されるノードと、文書内の位置に関して文書順に比較します。

定義:

インタフェース Node 内の compareDocumentPosition

パラメータ:

other - 参照ノードと比較するノード

戻り値:

参照ノードに対してノードの相対的な位置を決める方法

例外:

DOMException - NOT_SUPPORTED_ERR: 比較対象ノードが、一貫した実装固有の結果を返すように調整しない別の DOM 実装のノードである場合

getBaseURI

public String getBaseURI()

インタフェース Node の記述:

このノードの絶対ベース URI、実装が絶対 URI を取得できなかった場合は null になります。この値は、説明に従って計算されます。ただし、Document が「HTML」機能「DOM Level 2 HTML」をサポートする場合、ベース URI は、まず HTML BASE 要素の href 属性の値 (存在する場合) を使用して計算され、そうでない場合は Document インタフェースの documentURI 属性の値を使用して計算されます。

定義:

インタフェース Node 内の getBaseURI