Класс 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. В частности, узлы Element, созданные в API для обработки изображений, несовместимы с узлами, созданными стандартной реализацией API org.w3.dom от Sun. В частности, реализация оптимизирована для простых задач и может быть неэффективна для интенсивной обработки.

Пространства имён игнорируются в этой реализации. Термины "имя тега" и "имя узла" всегда считаются синонимами. Примечание: Спецификация DOM уровня 3 добавила ряд новых методов в интерфейсы Node, Element и Attr, которые не имеют значения для реализации или спецификации IIOMetadataNode. Вызов таких методов для IIOMetadataNode, или для объекта Attr, полученного из IIOMetadataNode, приведёт к возникновению исключения DOMException.

См. также:: 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)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`String`	`getAttribute(String name)`	Возвращает значение атрибута по имени.
`Attr`	`getAttributeNodeNS(String namespaceURI, String localName)`	Эквивалентно `getAttributeNode(localName)`.
`String`	`getAttributeNS(String namespaceURI, String localName)`	Эквивалентно `getAttribute(localName)`.
`NamedNodeMap`	`getAttributes()`	Возвращает `NamedNodeMap`, содержащий атрибуты этого узла.
`String`	`getBaseURI()`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`NodeList`	`getChildNodes()`	Возвращает `NodeList`, содержащий всех дочерних узлов этого узла.
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`	Эквивалентно `getElementsByTagName(localName)`.
`Object`	`getFeature(String feature, String version)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`Node`	`getFirstChild()`	Возвращает первого дочернего узла этого узла, или `null`, если узел не имеет дочерних узлов.
`Node`	`getLastChild()`	Возвращает последний дочерний узел этого узла, или `null`, если узел не имеет дочерних узлов.
`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()`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`String`	`getTagName()`	Эквивалентно `getNodeName`.
`String`	`getTextContent()`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`Object`	`getUserData(String key)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`Object`	`getUserObject()`	Возвращает значение `Object` связанное с этим узлом.
`boolean`	`hasAttributeNS(String namespaceURI, String localName)`	Эквивалентно `hasAttribute(localName)`.
`boolean`	`hasChildNodes()`	Возвращает `true` если у этого узла есть дочерние узлы.
`Node`	`insertBefore(Node newChild, Node refChild)`	Вставляет узел `newChild` перед существующим дочерним узлом `refChild`.
`boolean`	`isDefaultNamespace(String namespaceURI)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`boolean`	`isEqualNode(Node node)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`boolean`	`isSameNode(Node node)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`boolean`	`isSupported(String feature, String version)`	Возвращает `false` так как возможности DOM не поддерживаются.
`String`	`lookupNamespaceURI(String prefix)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`String`	`lookupPrefix(String namespaceURI)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`void`	`normalize()`	Ничего не делает, так как `IIOMetadataNode` не содержат дочерние узлы `Text`.
`void`	`removeAttributeNS(String namespaceURI, String localName)`	Эквивалентно `removeAttribute(localName)`.
`Node`	`removeChild(Node oldChild)`	Удаляет дочерний узел, указанный `oldChild` из списка дочерних узлов и возвращает его.
`Node`	`replaceChild(Node newChild, Node oldChild)`	Заменяет дочерний узел `oldChild` на `newChild` в списке дочерних узлов и возвращает узел `oldChild`.
`Attr`	`setAttributeNodeNS(Attr newAttr)`	Эквивалентно `setAttributeNode(newAttr)`.
`void`	`setAttributeNS(String namespaceURI, String qualifiedName, String value)`	Эквивалентно `setAttribute(qualifiedName, value)`.
`void`	`setIdAttribute(String name, boolean isId)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`void`	`setIdAttributeNode(Attr idAttr, boolean isId)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`void`	`setIdAttributeNS(String namespaceURI, String localName, boolean isId)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`void`	`setNodeValue(String nodeValue)`	Устанавливает значение `String` связанное с этим узлом.
`void`	`setPrefix(String prefix)`	Ничего не делает, так как пространства имён не поддерживаются.
`void`	`setTextContent(String textContent)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`	Этот метод DOM Level 3 не поддерживается для `IIOMetadataNode` и выбросит `DOMException`.
`void`	`setUserObject(Object userObject)`	Устанавливает значение, связанное с этим узлом.

Методы, объявленные в классе java.lang.Object

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

Методы, объявленные в интерфейсе org.w3c.dom.Element

getAttributeNode, getElementsByTagName, hasAttribute, removeAttribute, removeAttributeNode, setAttribute, setAttributeNode

Методы, объявленные в интерфейсе org.w3c.dom.Node

hasAttributes

Методы, объявленные в интерфейсе org.w3c.dom.NodeList

getLength, item

Конструкторы

IIOMetadataNode

public IIOMetadataNode()

Создаёт пустой IIOMetadataNode.

IIOMetadataNode

public IIOMetadataNode(String nodeName)

Создаёт IIOMetadataNode с заданным именем узла.

Параметры:: nodeName - имя узла в виде String.

Методы

getNodeName

public String getNodeName()

Возвращает имя узла, связанное с этим узлом.

Указано в:: getNodeName в интерфейсе Node
Возвращает:: имя узла в виде String.

getNodeValue

public String getNodeValue()

Возвращает значение, связанное с этим узлом.

Указано в:: getNodeValue в интерфейсе Node
Возвращает:: значение узла в виде String.

setNodeValue

public void setNodeValue(String nodeValue)

Устанавливает значение String для этого узла.

Указано в:: setNodeValue в интерфейсе Node

getNodeType

public short getNodeType()

Возвращает тип узла, который всегда ELEMENT_NODE.

Указано в:: getNodeType в интерфейсе Node
Возвращает:: значение short ELEMENT_NODE.

getParentNode

public Node getParentNode()

Возвращает родительский узел для этого узла. Значение null указывает, что узел является корнем собственного дерева. Для добавления узла в существующее дерево используйте один из методов insertBefore, replaceChild, или appendChild.

Указано в:: getParentNode в интерфейсе Node
Возвращает:: родителя в виде 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()

Возвращает NodeList, содержащий все дочерние узлы этого узла. Если дочерних узлов нет, возвращается NodeList без узлов.

Указано в:: getChildNodes в интерфейсе Node
Возвращает:: детей в виде NodeList

getFirstChild

public Node getFirstChild()

Возвращает первый дочерний узел этого узла или null если у узла нет дочерних узлов.

Указано в:: getFirstChild в интерфейсе Node
Возвращает:: первого дочернего узла в виде Node, или null

getLastChild

public Node getLastChild()

Возвращает последний дочерний узел этого узла, или null если у узла нет дочерних узлов.

Указано в:: getLastChild в интерфейсе Node
Возвращает:: последнего дочернего узла в виде Node, или null.

getPreviousSibling

public Node getPreviousSibling()

Возвращает предыдущего брата этого узла или null если у этого узла нет предыдущего брата.

Указано в:: getPreviousSibling в интерфейсе Node
Возвращает:: предыдущего брата в виде Node, или null.

getNextSibling

public Node getNextSibling()

Возвращает следующего брата этого узла или null если у узла нет следующего брата.

Указано в:: getNextSibling в интерфейсе Node
Возвращает:: следующего брата в виде Node, или null.

getAttributes

public NamedNodeMap getAttributes()

Возвращает NamedNodeMap, содержащий атрибуты этого узла.

Указано в:: getAttributes в интерфейсе Node
Возвращает:: NamedNodeMap содержащий атрибуты этого узла.

getOwnerDocument

public Document getOwnerDocument()

Возвращает null, так как IIOMetadataNode не принадлежат ни к какому Document.

Указано в:: getOwnerDocument в интерфейсе Node
Возвращает:: null.

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)

Вставляет узел newChild перед существующим дочерним узлом refChild. Если refChild является null, вставьте newChild в конец списка дочерних элементов.

Указано в:: insertBefore в интерфейсе Node
Параметры:: newChild - вставляемый Node.; refChild - ссылка Node.
Возвращает:: вставляемый узел.
Исключения:: IllegalArgumentException - если newChild является null.

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)

Заменяет дочерний узел oldChild на newChild в списке дочерних элементов и возвращает oldChild узел.

Указано в:: replaceChild в интерфейсе Node
Параметры:: newChild - вставляемый Node.; oldChild - заменяемый Node.
Возвращает:: заменённый узел.
Исключения:: IllegalArgumentException - если newChild является null.

removeChild

public Node removeChild(Node oldChild)

Удаляет дочерний узел, указанный в oldChild, из списка дочерних элементов и возвращает его.

Указано в:: removeChild в интерфейсе Node
Параметры:: oldChild - удаляемый Node.
Возвращает:: удаленный узел.
Исключения:: IllegalArgumentException - если oldChild является null.

appendChild

public Node appendChild(Node newChild)

Добавляет узел newChild в конец списка дочерних элементов этого узла.

Указано в:: appendChild в интерфейсе Node
Параметры:: newChild - вставляемый Node.
Возвращает:: добавляемый узел.
Исключения:: IllegalArgumentException - если newChild является null.

hasChildNodes

public boolean hasChildNodes()

Возвращает true если у этого узла есть дочерние узлы.

Указано в:: hasChildNodes в интерфейсе Node
Возвращает:: true если у этого узла есть дочерние элементы.

cloneNode

public Node cloneNode(boolean deep)

Возвращает дубликат этого узла. Дублирующий узел не имеет родителя (getParentNode возвращает null). Если выполняется создание поверхностной копии (deep равно false), новый узел не будет иметь дочерних узлов или братьев. Если выполняется создание глубокой копии, новый узел будет корнем полной клонированной поддерева.

Указано в:: cloneNode в интерфейсе Node
Параметры:: deep - если true, рекурсивно клонировать поддерево под указанным узлом; если false, клонировать только сам узел.
Возвращает:: дублирующий узел.

normalize

public void normalize()

Не делает ничего, так как IIOMetadataNode не содержат Text дочерних узлов.

Указано в:: normalize в интерфейсе Node

isSupported

public boolean isSupported(String feature,
                           String version)

Возвращает false, так как функции DOM не поддерживаются.

Указано в:: isSupported в интерфейсе Node
Параметры:: feature - строка, которая игнорируется.; version - строка, которая игнорируется.
Возвращает:: false.

getNamespaceURI

public String getNamespaceURI()
                       throws DOMException

Возвращает null, так как пространства имён не поддерживаются.

Указано в:: getNamespaceURI в интерфейсе Node
Исключения:: DOMException

getPrefix

public String getPrefix()

Возвращает null, так как пространства имён не поддерживаются.

Указано в:: getPrefix в интерфейсе Node
Возвращает:: null.
См. также:: setPrefix(java.lang.String)

setPrefix

public void setPrefix(String prefix)

Не делает ничего, так как пространства имён не поддерживаются.

Указано в:: setPrefix в интерфейсе Node
Параметры:: prefix - строка, которая игнорируется.
См. также:: getPrefix()

getLocalName

public String getLocalName()

Эквивалентно getNodeName.

Указано в:: getLocalName в интерфейсе Node
Возвращает:: имя узла в виде String.

getTagName

public String getTagName()

Эквивалентно getNodeName.

Указано в:: getTagName в интерфейсе Element
Возвращает:: имя узла в виде String

getAttribute

public String getAttribute(String name)

Извлекает значение атрибута по имени.

Указано в:: getAttribute в интерфейсе Element
Параметры:: name - Имя атрибута для извлечения.
Возвращает:: Значение Attr в виде строки, или пустую строку, если у этого атрибута нет заданного или по умолчанию значения.

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)

Эквивалентно getAttribute(localName).

Указано в:: getAttributeNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён атрибута для извлечения.; localName - Локальное имя атрибута для извлечения.
Возвращает:: Значение атрибута Attr в виде строки или пустую строку, если у этого атрибута нет заданного или по умолчанию значения.
См. также:: setAttributeNS(java.lang.String, java.lang.String, java.lang.String)

setAttributeNS

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

Эквивалентно setAttribute(qualifiedName, value).

Указано в:: setAttributeNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён атрибута для создания или изменения.; qualifiedName - Полное имя атрибута для создания или изменения.; value - Значение для установки в строковом формате.
См. также:: getAttributeNS(java.lang.String, java.lang.String)

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

Эквивалентно removeAttribute(localName).

Указано в:: removeAttributeNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён удаляемого атрибута.; localName - Локальное имя удаляемого атрибута.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

Эквивалентно getAttributeNode(localName).

Указано в:: getAttributeNodeNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён извлекаемого атрибута.; localName - Локальное имя извлекаемого атрибута.
Возвращает:: Узел Attr с указанным локальным именем атрибута и URI пространства имён, или null, если такого атрибута нет.
См. также:: setAttributeNodeNS(org.w3c.dom.Attr)

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)

Эквивалентно setAttributeNode(newAttr).

Указано в:: setAttributeNodeNS в интерфейсе Element
Параметры:: newAttr - Узел Attr для добавления в список атрибутов.
Возвращает:: Если атрибут newAttr заменяет существующий атрибут с тем же локальным именем и URI пространства имён, возвращается заменённый Attr узел, в противном случае возвращается null.
См. также:: getAttributeNodeNS(java.lang.String, java.lang.String)

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

Эквивалентно getElementsByTagName(localName).

Указано в:: getElementsByTagNameNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён для сопоставления элементов. Специальное значение "*" соответствует всем пространствам имён.; localName - Локальное имя для сопоставления элементов. Специальное значение "*" соответствует всем локальным именам.
Возвращает:: Новый объект NodeList, содержащий все соответствующие Elements.

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)

Эквивалентно hasAttribute(localName).

Указано в:: hasAttributeNS в интерфейсе Element
Параметры:: namespaceURI - URI пространства имён искомого атрибута.; localName - Локальное имя искомого атрибута.
Возвращает:: true если атрибут с заданным локальным именем и URI пространства имён указан или имеет значение по умолчанию в этом элементе, false в противном случае.

getUserObject

public Object getUserObject()

Возвращает значение Object ассоциированное с этим узлом.

Возвращает:: пользовательское Object.
См. также:: setUserObject(java.lang.Object)

setUserObject

public void setUserObject(Object userObject)

Устанавливает значение, ассоциированное с этим узлом.

Параметры:: userObject - пользовательское Object.
См. также:: getUserObject()