org.w3c.dom
インタフェース NamedNodeMap

public interface NamedNodeMap

NamedNodeMap インタフェースを実装するオブジェクトは、名前を指定してアクセスできるノードの集合を表します。NamedNodeMap は NodeList を継承しません。つまり、特定の順序で管理されることがありません。NamedNodeMap を実装するオブジェクトに含まれるオブジェクトにも順序インデックスを使ってアクセスすることができますが、これは単に NamedNodeMap のコンテンツを列挙しやすくするためであって、DOM がこれらの Node の順序を指定するということではありません。

DOM 内の NamedNodeMap オブジェクトはライブオブジェクトです。

『Document Object Model (DOM) Level 2 Core Specification』を参照してください。

メソッドの概要

int	getLength() このマップ内のノード数です。
Node	getNamedItem(String name) 指定された名前のノードを取得します。
Node	getNamedItemNS(String namespaceURI, String localName) 指定されたローカル名とネームスペース URI を持つノードを取得します。
Node	item(int index) マップ内の index 番目の項目を返します。
Node	removeNamedItem(String name) 指定された名前のノードを削除します。
Node	removeNamedItemNS(String namespaceURI, String localName) 指定されたローカル名とネームスペース URI を持つノードを削除します。
Node	setNamedItem(Node arg) nodeName 属性を指定してノードを追加します。
Node	setNamedItemNS(Node arg) namespaceURI と localName を指定してノードを追加します。

メソッドの詳細

getNamedItem

public Node getNamedItem(String name)

指定された名前のノードを取得します。

パラメータ:

name - 取得するノードの nodeName

戻り値:

指定された nodeName を持つ任意の型の Node。このマップ内のノードが特定されない場合は null

setNamedItem

public Node setNamedItem(Node arg)
                  throws DOMException

nodeName 属性を指定してノードを追加します。その名前のノードがすでにマップ内に存在する場合、新しいノードで置き換えられます。
nodeName 属性はノードの格納名を取得するので、特殊な文字列値を持つ特定の型のノードを複数個格納することはできません。これは、名前の競合が起きてしまうためです。複数のノードを格納する必要がある場合は、ノードに別名を付けます。

パラメータ:

arg - このマップに格納するマップ。このノードには、あとで nodeName 属性の値を使ってアクセスできる

戻り値:

既存のノードが新しい Node で置き換えられる場合は置き換えの対象となる Node。それ以外の場合は null

例外:

DOMException - WRONG_DOCUMENT_ERR: arg がこのマップの作成元文書以外の文書で作成された場合
NO_MODIFICATION_ALLOWED_ERR: このマップが読み取り専用の場合；
INUSE_ATTRIBUTE_ERR: arg がすでに別の Element オブジェクトの Attr として使用されている場合。Attr ノードをほかの要素で再利用するには、このノードを DOM ユーザの手で明示的に複製する必要がある
HIERARCHY_REQUEST_ERR: この NamedNodeMap に所属しないノードを追加しようとした場合。たとえば、属性の Element マップに Attr ノード以外を挿入しようとした場合、あるいは DocumentType の Entity のマップに非 Entity ノードを挿入しようとした場合

removeNamedItem

public Node removeNamedItem(String name)
                     throws DOMException

指定された名前のノードを削除します。このマップに要素に追加された属性が含まれているとき、削除された属性にデフォルト値があるならば、ネームスペース URI、ローカル名、前置修飾子 (適切な場合) のほかにデフォルト値を持つ新しい属性が即座に作成されます。

パラメータ:

name - 削除するノードの nodeName

戻り値:

このマップから削除するノード (指定された名前のノードが存在する場合)

例外:

DOMException - NOT_FOUND_ERR: このマップ内に指定された name のノードが存在しない場合
NO_MODIFICATION_ALLOWED_ERR: このマップが読み取り専用の場合

item

public Node item(int index)

マップ内の index 番目の項目を返します。index がこのマップ内のノード数と同じかそれよりも大きい場合は null を返します。

パラメータ:

index - このマップのインデックス

戻り値:

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

getLength

public int getLength()

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

getNamedItemNS

public Node getNamedItemNS(String namespaceURI,
                           String localName)

指定されたローカル名とネームスペース URI を持つノードを取得します。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:

namespaceURI - 取得するノードのネームスペース URI

localName - 取得するノードのローカル名

戻り値:

指定されたローカル名とネームスペース URI を持つ任意の型の Node。子のマップ内のノードが特定されない場合は null

導入されたバージョン:

DOM Level 2

setNamedItemNS

public Node setNamedItemNS(Node arg)
                    throws DOMException

namespaceURI と localName を指定してノードを追加します。指定されたネームスペース URI およびローカル名を持つノードがすでにマップ内に存在する場合、新しいノードで置き換えられます。

パラメータ:

arg - このマップに格納するマップ。このノードには、あとで namespaceURI 属性と localName 属性の値を使ってアクセスできる

戻り値:

既存のノードが新しい Node で置き換えられる場合は置き換えの対象となる Node。それ以外の場合は null

例外:

DOMException - WRONG_DOCUMENT_ERR: arg がこのマップの作成元文書以外の文書で作成された場合
NO_MODIFICATION_ALLOWED_ERR: このマップが読み取り専用の場合
INUSE_ATTRIBUTE_ERR: arg がすでに別の Element オブジェクトの Attr として使用されている場合。Attr ノードをほかの要素で再利用するには、このノードを DOM ユーザの手で明示的に複製する必要がある
HIERARCHY_REQUEST_ERR: この NamedNodeMap に所属しないノードを追加しようとした場合。たとえば、属性の Element マップに Attr ノード以外を挿入しようとした場合、あるいは DocumentType の Entity のマップに非 Entity ノードを挿入しようとした場合
NOT_SUPPORTED_ERR: 現在の文書が "XML" をサポートしない場合 (ネームスペースは XML によって定義されている)

導入されたバージョン:

DOM Level 2

removeNamedItemNS

public Node removeNamedItemNS(String namespaceURI,
                              String localName)
                       throws DOMException

指定されたローカル名とネームスペース URI を持つノードを削除します。このマップに要素に追加された属性が含まれているとき、削除された属性が Node インタフェースの attributes 属性によって返されるデフォルト値を持つならば、対応するネームスペース URI、ローカル名、前置修飾子 (適切な場合) のほかにデフォルト値を持つ新しい属性が即座に作成されます。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:

namespaceURI - 削除するノードのネームスペース URI

localName - 削除するノードのローカル名

戻り値:

このマップから削除するノード (指定されたローカル名およびネームスペース URI を持つノードが存在する場合)

例外:

DOMException - NOT_FOUND_ERR: 指定された namespaceURI およびlocalName を持つノードがマップ内に存在しない場合
NO_MODIFICATION_ALLOWED_ERR: このマップが読み取り専用の場合

導入されたバージョン:

DOM Level 2