Класс IIOMetadataNode

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.

Краткое описание конструкторов

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 - String, который игнорируется.

version - String, который игнорируется.

Возвращает:

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 - String, который игнорируется.

См. также:

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)

setAttribute

public void setAttribute(String name,
                         String value)

Описание скопировано из интерфейса: Element

Добавляет новый атрибут. Если атрибут с таким именем уже присутствует в элементе, его значение изменяется на значение параметра value. Это значение является простой строкой; оно не анализируется при установке. Таким образом, любой разметка (например, синтаксис, который должен распознаваться как ссылка на сущность) обрабатывается как буквальный текст, и реализация должна соответствующим образом экранировать его при выводе. Чтобы назначить значение атрибута, содержащее ссылки на сущности, пользователь должен создать узел Attr, а также любые узлы Text и EntityReference, построить соответствующее поддерево и использовать setAttributeNode для назначения его в качестве значения атрибута.
Для установки атрибута с квалифицированным именем и URI пространства имен используйте метод setAttributeNS.

Указано:

setAttribute в интерфейсе Element

Параметры:

name - Имя атрибута для создания или изменения.

value - Значение для установки в виде строки.

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)

removeAttribute

public void removeAttribute(String name)

Описание скопировано из интерфейса: Element

Удаляет атрибут по имени. Если для удалённого атрибута определено значение по умолчанию в DTD, новый атрибут сразу же появляется со значением по умолчанию, а также соответствующим URI пространства имен, локальным именем и префиксом, если применимо. Реализация может аналогично обрабатывать значения по умолчанию из других схем, но приложения должны использовать Document.normalizeDocument() для гарантирования актуальности этой информации.
Если атрибут с этим именем не найден, этот метод не оказывает никакого влияния.
Для удаления атрибута по локальному имени и URI пространства имён используйте метод removeAttributeNS.

Указано:

removeAttribute в интерфейсе Element

Параметры:

name - Имя атрибута для удаления.

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

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

Указано:

removeAttributeNS в интерфейсе Element

Параметры:

namespaceURI - URI пространства имен атрибута для удаления.

localName - Локальное имя атрибута для удаления.

getAttributeNode

public Attr getAttributeNode(String name)

Описание скопировано из интерфейса: Element

Извлекает узел атрибута по имени.
Для извлечения узла атрибута по квалифицированному имени и URI пространства имен используйте метод getAttributeNodeNS.

Указано:

getAttributeNode в интерфейсе Element

Параметры:

name - Имя (nodeName) атрибута для извлечения.

Возвращает:

Узел Attr с указанным именем (nodeName) или null, если такого атрибута нет.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)

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

Указано:

getAttributeNodeNS в интерфейсе Element

Параметры:

namespaceURI - URI пространства имен атрибута для извлечения.

localName - Локальное имя атрибута для извлечения.

Возвращает:

Узел Attr с указанным локальным именем атрибута и URI пространства имён или null, если такого атрибута нет.

См. также:

setAttributeNodeNS(org.w3c.dom.Attr)

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException

Описание скопировано из интерфейса: Element

Добавляет новый узел атрибута. Если атрибут с таким именем (nodeName) уже присутствует в элементе, он заменяется новым. Замена узла атрибута на него самого не оказывает никакого эффекта.
Для добавления нового узла атрибута с квалифицированным именем и URI пространства имен используйте метод setAttributeNodeNS.

Указано:

setAttributeNode в интерфейсе Element

Параметры:

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).

Указано:

setAttributeNodeNS в интерфейсе Element

Параметры:

newAttr - Узел Attr для добавления в список атрибутов.

Возвращает:

Если атрибут newAttr заменяет существующий атрибут с тем же локальным именем и URI пространства имен, возвращается заменённый узел Attr, в противном случае возвращается null.

См. также:

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

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)

Описание скопировано из интерфейса: Element

Удаляет указанный узел атрибута. Если для удалённого узла Attr определено значение по умолчанию в DTD, новый узел сразу же появляется со значением по умолчанию, а также соответствующим URI пространства имён, локальным именем и префиксом, если применимо. Реализация может аналогично обрабатывать значения по умолчанию из других схем, но приложения должны использовать Document.normalizeDocument() для гарантирования актуальности этой информации.

Указано:

removeAttributeNode в интерфейсе Element

Параметры:

oldAttr - Узел Attr для удаления из списка атрибутов.

Возвращает:

Узел Attr узла, который был удалён.

getElementsByTagName

public NodeList getElementsByTagName(String name)

Описание скопировано из интерфейса: Element

Возвращает список всех дочерних Elements с заданным именем тега в порядке документа.

Указано:

getElementsByTagName в интерфейсе Element

Параметры:

name - Имя тега для сопоставления. Специальное значение "*" сопоставляет все теги.

Возвращает:

Список узлов Element.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)

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

Указано:

getElementsByTagNameNS в интерфейсе Element

Параметры:

namespaceURI - URI пространства имен элементов для сопоставления. Специальное значение "*" сопоставляет все пространства имён.

localName - Локальное имя элементов для сопоставления. Специальное значение "*" сопоставляет все локальные имена.

Возвращает:

Новый объект NodeList, содержащий все соответствующие узлы Elements.

hasAttributes

public boolean hasAttributes()

Описание скопировано из интерфейса: Node

Возвращает, имеет ли этот узел (если он является элементом) какие-либо атрибуты.

Указано:

hasAttributes в интерфейсе Node

Возвращает:

Возвращает true если у этого узла есть какие-либо атрибуты, false в противном случае.

hasAttribute

public boolean hasAttribute(String name)

Описание скопировано из интерфейса: Element

Возвращает true если атрибут с данным именем указан в этом элементе или имеет значение по умолчанию, false в противном случае.

Указано:

hasAttribute в интерфейсе Element

Параметры:

name - Имя атрибута для поиска.

Возвращает:

true если атрибут с данным именем указан в этом элементе или имеет значение по умолчанию, false в противном случае.

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)

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

Указано в:

hasAttributeNS в интерфейсе Element

Параметры:

namespaceURI - URI пространства имён атрибута, который нужно найти.

localName - Локальное имя атрибута, который нужно найти.

Возвращает:

true если атрибут с указанным локальным именем и URI пространства имён определён или имеет значение по умолчанию в этом элементе, false в противном случае.

getLength

public int getLength()

Описание скопировано из интерфейса: NodeList

Количество узлов в списке. Диапазон допустимых индексов узлов-потомков — от 0 до length-1 включительно.

Указано в:

getLength в интерфейсе NodeList

item

public Node item(int index)

Описание скопировано из интерфейса: NodeList

Возвращает index-й элемент в коллекции. Если index больше или равно количеству узлов в списке, возвращает null.

Указано в:

item в интерфейсе NodeList

Параметры:

index - Индекс в коллекции.

Возвращает:

Узел в index-й позиции в NodeList, или 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

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

setIdAttribute в интерфейсе Element

Параметры:

name - Название атрибута.

isId - Является ли атрибут идентификатором.

Выбрасывает:

DOMException - - всегда.

setIdAttributeNS

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

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

setIdAttributeNS в интерфейсе Element

Параметры:

namespaceURI - URI пространства имён атрибута.

localName - Локальное имя атрибута.

isId - Является ли атрибут идентификатором.

Выбрасывает:

DOMException - - всегда.

setIdAttributeNode

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

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

setIdAttributeNode в интерфейсе Element

Параметры:

idAttr - Узел атрибута.

isId - Является ли атрибут идентификатором.

Выбрасывает:

DOMException - - всегда.

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()
                           throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

getSchemaTypeInfo в интерфейсе Element

Выбрасывает:

DOMException - - всегда.

setUserData

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

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

setUserData в интерфейсе Node

Параметры:

key - Ключ для связывания объекта.

data - Объект для связывания с заданным ключом, или null для удаления существующей связи с этим ключом.

handler - Обработчик для связывания с этим ключом, или null.

Возвращает:

Возвращает DOMUserData , ранее связанный с заданным ключом в этом узле, или null если такого не было.

Выбрасывает:

DOMException - - всегда.

getUserData

public Object getUserData(String key)
                   throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

getUserData в интерфейсе Node

Параметры:

key - Ключ, к которому связан объект.

Возвращает:

Возвращает DOMUserData , связанный с заданным ключом в этом узле, или null если такого не было.

Выбрасывает:

DOMException - - всегда.

getFeature

public Object getFeature(String feature,
                         String version)
                  throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

getFeature в интерфейсе Node

Параметры:

feature - Имя запрашиваемого функционального расширения. Обратите внимание, что любой знак «плюс» «+», добавленный перед именем функционального расширения, будет проигнорирован, поскольку он не имеет значения в контексте этого метода.

version - Номер версии функционального расширения.

Возвращает:

Возвращает объект, который реализует специализированные API указанного функционального расширения и версии, если таковые имеются, или null если нет объекта, который реализует интерфейсы, связанные с этим функциональным расширением. Если возвращённый DOMObject объект реализует интерфейс Node, он должен делегировать запросы основному ядру Node и не возвращать результаты, не соответствующие основному ядру Node, такие как атрибуты, childNodes и т. д.

Выбрасывает:

DOMException - - всегда.

isSameNode

public boolean isSameNode(Node node)
                   throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

isSameNode в интерфейсе Node

Параметры:

node - Узел для сравнения.

Возвращает:

Возвращает true если узлы одинаковые, false в противном случае.

Выбрасывает:

DOMException - - всегда.

isEqualNode

public boolean isEqualNode(Node node)
                    throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

isEqualNode в интерфейсе Node

Параметры:

node - Узел для сравнения на равенство.

Возвращает:

Возвращает true если узлы равны, false в противном случае.

Выбрасывает:

DOMException - - всегда.

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)
                          throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

lookupNamespaceURI в интерфейсе Node

Параметры:

prefix - Префикс для поиска. Если этот параметр null, метод вернёт URI по умолчанию, если таковой имеется.

Возвращает:

Возвращает связанный URI пространства имён или null если не найдено.

Выбрасывает:

DOMException - - всегда.

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)
                           throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

isDefaultNamespace в интерфейсе Node

Параметры:

namespaceURI - URI пространства имён для поиска.

Возвращает:

Возвращает true если указанное namespaceURI является пространством имён по умолчанию, false в противном случае.

Выбрасывает:

DOMException - - всегда.

lookupPrefix

public String lookupPrefix(String namespaceURI)
                    throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

lookupPrefix в интерфейсе Node

Параметры:

namespaceURI - URI пространства имён для поиска.

Возвращает:

Возвращает связанный префикс пространства имён, если найден, или null если не найден. Если к пространству имён привязано несколько префиксов, возвращаемый префикс зависит от реализации.

Выбрасывает:

DOMException - - всегда.

getTextContent

public String getTextContent()
                      throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

getTextContent в интерфейсе Node

Выбрасывает:

DOMException - - всегда.

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

setTextContent в интерфейсе Node

Выбрасывает:

DOMException - - всегда.

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Этот метод DOM Level 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Указано в:

compareDocumentPosition в интерфейсе Node

Параметры:

other - Узел для сравнения с эталонным узлом.

Возвращает:

Возвращает информацию о расположении узла относительно эталонного узла.

Выбрасывает:

DOMException - - всегда.

getBaseURI

public String getBaseURI()
                  throws DOMException

Этот метод DOM уровня 3 не поддерживается для IIOMetadataNode и вызовет DOMException.

Определено в:

getBaseURI в интерфейсе Node

Исключения:

DOMException - всегда.