JavaTM Platform
Standard Ed. 6

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 接口,还允许通过 getUserObjectsetUserObject 方法存储非文本对象。

此类不用于进行通用 XML 处理。尤其是,在 Image I/O 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()
          包含此节点的属性的 NamedNodeMap(如果它是 Element);否则为 null
 String getBaseURI()
          此节点的绝对基 URI;如果实现不能获得绝对 URI,则为 null
 NodeList getChildNodes()
          包含此节点的所有子节点的 NodeList
 NodeList getElementsByTagName(String name)
          以文档顺序返回具有给定标记名称的所有后代 ElementsNodeList
 NodeList getElementsByTagNameNS(String namespaceURI, String localName)
          等效于 getElementsByTagName(localName)
 Object getFeature(String feature, String version)
          此方法返回一个特定的对象,该对象实现指定功能或版本的特定 API,如下所述。
 Node getFirstChild()
          此节点的第一个子节点;如果该节点没有子节点,则返回 null
 Node getLastChild()
          返回此节点的最后一个子节点;如果该节点没有子节点,则返回 null
 int getLength()
          列表中的节点数。
 String getLocalName()
          等效于 getNodeName
 String getNamespaceURI()
          返回 null,因为不支持名称空间。
 Node getNextSibling()
          返回此节点的下一个兄弟节点;如果该节点没有下一个兄弟节点,则返回 null
 String getNodeName()
          返回与此节点关联的节点名称。
 short getNodeType()
          返回节点类型,其始终为 ELEMENT_NODE
 String getNodeValue()
          此节点的值,取决于其类型;参见上表。
 Document getOwnerDocument()
          返回 null,因为 IIOMetadataNode 不属于任何 Document
 Node getParentNode()
          返回此节点的父节点。
 String getPrefix()
          返回 null,因为不支持名称空间。
 Node getPreviousSibling()
          返回此节点的上一个兄弟节点;如果该节点没有上一个兄弟节点,则返回 null
 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)
          测试两个节点是否相等。
 boolean isSameNode(Node node)
          返回此节点是否是与给定节点相同的节点。
 boolean isSupported(String feature, String version)
          返回 false,因为不支持 DOM 功能。
 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)
          如果参数 isIdtrue,则此方法将指定的属性声明为用于确定用户的 ID 属性。
 void setIdAttributeNode(Attr idAttr, boolean isId)
          如果参数 isIdtrue,则此方法将指定的属性声明为用户确定的 ID 属性。
 void setIdAttributeNS(String namespaceURI, String localName, boolean isId)
          如果参数 isIdtrue,则此方法将指定的属性声明为用户确定的 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 时,设置它无效,包括节点为只读的情况。

指定者:
接口 Node 中的 getNodeValue
抛出:
DOMException - DOMSTRING_SIZE_ERR: 在它返回的字符多于实现平台上 DOMString 变量中适合的字符时引发此异常。

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException
从接口 Node 复制的描述
此节点的值,取决于其类型;参见上表。当将它定义为 null 时,设置它无效,包括节点为只读的情况。

指定者:
接口 Node 中的 setNodeValue
抛出:
DOMException - NO_MODIFICATION_ALLOWED_ERR: 当节点为只读且未将它定义为 null 时引发此异常。

getNodeType

public short getNodeType()
返回节点类型,其始终为 ELEMENT_NODE

指定者:
接口 Node 中的 getNodeType
返回:
shortELEMENT_NODE

getParentNode

public Node getParentNode()
返回此节点的父节点。 null 值指示该节点是它自己的树的根。要在现有树中添加节点,请使用 insertBeforereplaceChildappendChild 方法之一。

指定者:
接口 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 复制的描述
包含此节点的属性的 NamedNodeMap(如果它是 Element);否则为 null

指定者:
接口 Node 中的 getAttributes

getOwnerDocument

public Document getOwnerDocument()
返回 null,因为 IIOMetadataNode 不属于任何 Document

指定者:
接口 Node 中的 getOwnerDocument
返回:
null

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
在现有子节点 refChild 之前插入节点 newChild。如果 refChildnull,则将 newChild 插入到子节点列表的末尾。

指定者:
接口 Node 中的 insertBefore
参数:
newChild - 要插入的 Node
refChild - 引用 Node
返回:
要插入的节点。
抛出:
IllegalArgumentException - 如果 newChildnull

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
将子节点 oldChild 替换为子节点列表中的 newChild,并返回 oldChild 节点。

指定者:
接口 Node 中的 replaceChild
参数:
newChild - 要插入的 Node
oldChild - 要替换的 Node
返回:
替换的节点。
抛出:
IllegalArgumentException - 如果 newChildnull

removeChild

public Node removeChild(Node oldChild)
从子节点列表中移除 oldChild 所指示的子节点,并将其返回。

指定者:
接口 Node 中的 removeChild
参数:
oldChild - 要移除的 Node
返回:
移除的节点。
抛出:
IllegalArgumentException - 如果 oldChildnull

appendChild

public Node appendChild(Node newChild)
将节点 newChild 添加到此节点子节点列表的末尾。

指定者:
接口 Node 中的 appendChild
参数:
newChild - 要插入的 Node
返回:
添加的节点。
抛出:
IllegalArgumentException - 如果 newChildnull

hasChildNodes

public boolean hasChildNodes()
如果此节点有子节点,则返回 true

指定者:
接口 Node 中的 hasChildNodes
返回:
如果此节点有子节点,则返回 true

cloneNode

public Node cloneNode(boolean deep)
返回此节点的副本。副本节点没有父节点( getParentNode 返回 null)。如果正在执行浅表复制( deepfalse),则新节点将没有任何子节点或兄弟节点。如果正在执行深层复制,则新节点将形成完整复制的子树的根。

指定者:
接口 Node 中的 cloneNode
参数:
deep - 如果为 true,则在指定节点下递归式复制子树;如果为 false,则仅复制节点本身。
返回:
副本节点。

normalize

public void normalize()
不执行任何操作,因为 IIOMetadataNode 不包含 Text 子节点。

指定者:
接口 Node 中的 normalize

isSupported

public boolean isSupported(String feature,
                           String version)
返回 false,因为不支持 DOM 功能。

指定者:
接口 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.localNamenull 不同,则此属性为一个限定名称。例如,在以下示例中:
 <elementExample id="demo"> ... 
 </elementExample> , 
tagName 具有值 "elementExample"。注意,这在 XML 中是保留大小写的,DOM 中的所有操作也是这样。HTML DOM 以规范的大写形式返回 HTML 元素的 tagName,而不考虑源 HTML 文档中的大小写形式。

指定者:
接口 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 节点,加上所有 TextEntityReference 节点,构建适当的子树,并将它作为属性值,通过 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 对象的属性,则引发此异常。DOM 用户必须显式地克隆 Attr 节点,以便在其他元素中重新使用它们。

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
等效于 setAttributeNode(newAttr)

指定者:
接口 Element 中的 setAttributeNodeNS
参数:
newAttr - 要添加到属性列表的 Attr 节点。
返回:
如果用 newAttr 属性替换具有相同本地名称和名称空间 URI 的现有属性,则返回被替换的 Attr 节点;否则返回 null
另请参见:
getAttributeNodeNS(java.lang.String, java.lang.String)

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
从接口 Element 复制的描述
移除指定的属性节点。如果在 DTD 中定义了被移除 Attr 节点的默认值,则新的节点将在可用时随该默认值以及相应名称空间 URI、本地名称和前缀一起立即出现。类似地,实现可以处理其他模式的默认值,但应用程序应该使用 Document.normalizeDocument() 来保证此信息最新。

指定者:
接口 Element 中的 removeAttributeNode
参数:
oldAttr - 从属性列表中移除的 Attr 节点。
返回:
被移除的 Attr 节点。

getElementsByTagName

public NodeList getElementsByTagName(String name)
从接口 Element 复制的描述
以文档顺序返回具有给定标记名称的所有后代 ElementsNodeList

指定者:
接口 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 - 集合中的索引。
返回:
返回该 NodeListindex 位置处的节点;如果索引是无效索引,则返回 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 复制的描述
如果参数 isIdtrue,则此方法将指定的属性声明为用于确定用户的 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 复制的描述
如果参数 isIdtrue,则此方法将指定的属性声明为用户确定的 ID 属性。此方法影响 Attr.isId 的值和 Document.getElementById 的行为,但不更改可能正在使用的任何模式;需要特别指出的是,此方法不影响指定 Attr 节点的 Attr.schemaTypeInfo。使用参数 isId 的值 false 来取消将属性声明为用户确定的 ID 属性。

指定者:
接口 Element 中的 setIdAttributeNS
参数:
namespaceURI - 属性的名称空间 URI。
isId - 属性是否是 ID 类型。
抛出:
DOMException - NO_MODIFICATION_ALLOWED_ERR:如果此节点为只读的,则引发此异常。
NOT_FOUND_ERR: 如果指定的节点不是此元素的属性,则引发此异常。

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr,
                               boolean isId)
                        throws DOMException
从接口 Element 复制的描述
如果参数 isIdtrue,则此方法将指定的属性声明为用户确定的 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;如果没有,则返回 null

getUserData

public Object getUserData(String key)
从接口 Node 复制的描述
检索与此节点上的某个键相关联的对象。必须首先通过使用相同键的调用 setUserData 将该对象设置到此节点。

指定者:
接口 Node 中的 getUserData
参数:
key - 该对象所关联的键。
返回:
返回与此节点上的给定键关联的 DOMUserData;如果没有,则返回 null

getFeature

public Object getFeature(String feature,
                         String version)
从接口 Node 复制的描述
此方法返回一个特定的对象,该对象实现指定功能或版本的特定 API,如下所述。该特殊对象也可以通过使用特定于绑定的强制转换方法获得,但不是必须期望这样,如文中讨论的那样。此方法还允许实现提供不支持 Node 接口的特殊对象。

指定者:
接口 Node 中的 getFeature
参数:
feature - 所请求的功能的名称。注意,追加到功能名称的任何加号 "+" 将被忽略,因为它在此方法的上下文中无关紧要。
version - 这是要测试的功能版本号。
返回:
返回实现指定功能和版本的特定 API 的对象(如果有);如果不存在实现与该功能相关的接口的对象,则返回 null。如果此方法返回的 DOMObject 实现 Node 接口,则它必须委托给主要核心 Node 且不返回与主要核心 Node 不一致的结果,如属性、子节点,等等。

isSameNode

public boolean isSameNode(Node node)
从接口 Node 复制的描述
返回此节点是否是与给定节点相同的节点。
此方法提供一种方法来确定由实现返回的两个 Node 引用是否引用同一个对象。当两个 Node 引用引用同一个对象时,即使是通过代理,也可能完全可交换地使用这些引用,例如所有属性都有相同的值且在任何引用上调用同一个 DOM 方法总是起完全相同的作用。

指定者:
接口 Node 中的 isSameNode
参数:
node - 要测试的节点。
返回:
如果节点相同,则返回 true;否则,返回 false

isEqualNode

public boolean isEqualNode(Node node)
从接口 Node 复制的描述
测试两个节点是否相等。
此方法测试节点的相等性,不是测试是否相同(即两个节点是否为对同一对象的引用),相同性可以使用 Node.isSameNode() 测试。所有相同的节点也将相等,尽管反之则不然。
当且仅当满足以下条件时,两个节点才相等:
两个 DocumentType 节点要是相等,还必须满足以下条件:
另一方面,以下内容不影响相等性: ownerDocumentbaseURIparentNode 属性; Attr 节点的 specified 属性; AttrElement 节点的 schemaTypeInfo 属性; Text 节点的 Text.isElementContentWhitespace 属性;以及在节点上注册的任何用户数据和事件侦听器。

注:通常,在相等性检查的考虑中,上面描述中未提到的任何情况都是无关紧要的。注意,此规范的未来版本可能考虑更多属性,并且期望遵守此规范的实现进行相应的更新。

指定者:
接口 Node 中的 isEqualNode
参数:
node - 与其比较相等性的节点。
返回:
如果节点相等,则返回 true;否则,返回 false

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)
从接口 Node 复制的描述
从此节点开始,查找与给定前缀相关的名称空间 URI。
有关此方法使用的算法的详细信息,请参见。

指定者:
接口 Node 中的 lookupNamespaceURI
参数:
prefix - 要查找的前缀。如果此参数为 null,则此方法将返回默认的名称空间 URI(如果有)。
返回:
返回相关的名称空间 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 串接每个子节点的 textContent 属性值,不包括 COMMENT_NODE 和 PROCESSING_INSTRUCTION_NODE 节点。如果该节点没有子节点,则这是空字符串。
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 串接每个子节点的 textContent 属性值,不包括 COMMENT_NODE 和 PROCESSING_INSTRUCTION_NODE 节点。如果该节点没有子节点,则这是空字符串。
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 实现,未调整该 DOM 实现以返回一致的特定于实现的结果时。

getBaseURI

public String getBaseURI()
从接口 Node 复制的描述
此节点的绝对基 URI;如果实现不能获得绝对 URI,则为 null。此值如描述的那样计算。但是,当 Document 支持功能 "HTML" [ DOM Level 2 HTML] 时,首先使用 HTML BASE 元素(如果有)的 href 属性的值计算基 URI;否则,使用 Document 接口中的 documentURI 属性的值计算。

指定者:
接口 Node 中的 getBaseURI

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策