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_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) このノードの複製を返します。
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 です。
NodeList	getChildNodes() このノードの子をすべて含む NodeList です。
NodeList	getElementsByTagName(String name) 所定のタグ名とともに、すべての子孫 Elements の NodeList を返します。
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) getElementsByTagName(localName) と同じです。
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() このノードの前の兄弟ウィジェットを返します。
String	getTagName() 要素の名前です。
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	isSupported(String feature, String version) DOM 機能はサポートされていないので、false を返します。
Node	item(int index) 集合内の index 番目の項目を返します。
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	setNodeValue(String nodeValue) このノードの値です。
void	setPrefix(String prefix) 名前空間はサポートされないので、何も実行しません。
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 になるように定義した場合は、このノードを設定しても変化はありません。

定義:

インタフェース Node 内の getNodeValue

例外:

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

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

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

このノードの値です。この値は型によって異なります。上記の表を参照してください。null になるように定義した場合は、このノードを設定しても変化はありません。

定義:

インタフェース Node 内の setNodeValue

例外:

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

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 の記述:

要素の名前です。以下の例を参照してください。

 <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 の記述:

新しい属性を追加します。要素内にその名前の属性がすでに存在する場合、その値は値パラメータの値に変更されます。この値は単純な文字列であり、設定時に解析は行われません。その結果、あらゆるマークアップ (エンティティ参照として認識される構文を含む) が文字テキストと見なされます。実装は、書き出しを行う際、これを適切な方法でエスケープする必要があります。エンティティ参照を含む属性値を割り当てるには、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 の記述:

名前を指定して属性を削除します。削除される属性がデフォルト値を持つ属性である場合、対応するネームスペース URI、ローカル名、前置修飾子 (適切な場合) とデフォルト値を持つ属性が即座に作成されます。
ローカル名とネームスペース 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 を指定して属性ノードを取得するには、getAttributeNS メソッドを使用します。

定義:

インタフェース 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 にデフォルト値がある場合、ただちに別の属性で置き換えられます。置き換え後の属性も、元のものと同じネームスペース URI、ローカル名、前置修飾子 (適切な場合) を備えています。

定義:

インタフェース Element 内の removeAttributeNode

パラメータ:

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

戻り値:

削除された Attr ノード

getElementsByTagName

public NodeList getElementsByTagName(String name)

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

所定のタグ名とともに、すべての子孫 Elements の NodeList を返します。返される順番は、この Element ツリーの先行順 (preorder traversal) で検出された順番になります。

定義:

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