Объект встроенный объект

Объект XmlDocument

Объект XmlDocument представляет весь документ XML

Объект XmlDocument является корнем дерева документа и предоставляет нам начальный (или верхний уровень) доступ к данным документа. Используемые для узлов элементов, текстовых узлов, комментариев, инструкций по обработке и т. Д. Не могут существовать вне XmlDocument, объект XmlDocument также предоставляет метод для создания этих объектов. XmlNode предоставляет свойство ownerDocument, которое связывает их с XmlDocument, в котором они созданы.

наследование

Конструктор

XmlDocument

Создайте объект XmlDocument

1
new XmlDocument(String type = "text/xml");

Параметры вызова:

  • type : String, указывает тип объекта документа, по умолчанию это «text / xml », если вам нужно обработать html, вам нужно указать «text / html»

Атрибут члена

inputEncoding

String, возвращает кодировку, используемую для документа (при разборе)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Boolean, установить или вернуть, является ли документ автономным

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

Строка, установка или возврат XML-версии документа

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType , возвращает объявление типа документа, связанного с документом (Объявление типа документа)

1
readonly XmlDocumentType XmlDocument.doctype;

Для документов XML без DTD возвращается ноль. Это свойство обеспечивает прямой доступ к объекту XmlDocumentType (дочернему узлу XmlDocument).


documentElement

XmlElement , возвращает корневой узел документа

1
readonly XmlElement XmlDocument.documentElement;

XmlElement , возвращает головной узел документа HTML, допустимый только в режиме HTML

1
readonly XmlElement XmlDocument.head;

title

String, возвращает содержимое узла заголовка документа HTML, допустимо только в режиме HTML

1
readonly String XmlDocument.title;

body

XmlElement , возвращает узел тела документа HTML, допустимый только в режиме HTML

1
readonly XmlElement XmlDocument.body;

nodeType

Целое число, возвращает тип узла

1
readonly Integer XmlDocument.nodeType;

NodeType разных объектов будет возвращать разные значения:


nodeName

String, возвращает имя узла в соответствии с его типом

1
readonly String XmlDocument.nodeName;

Имя узла разных объектов будет возвращать разные значения:


nodeValue

String, возвращает имя узла в соответствии с его типом

1
String XmlDocument.nodeValue;

Имя узла разных объектов будет возвращать разные значения:


ownerDocument

XmlDocument, возвращает корневой элемент узла (объект XmlDocument)

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode , может вернуть родительский узел узла

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList , возвращает список узлов дочерних узлов указанного узла

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode , возвращает первый дочерний узел узла

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode , возвращает последний дочерний узел узла

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode , возвращает узел непосредственно перед узлом (на том же уровне дерева), если такого узла нет, тогда это свойство возвращает нуль

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode , возвращает узел сразу после элемента (на том же уровне дерева), если такого узла нет, атрибут возвращает ноль

1
readonly XmlNode XmlDocument.nextSibling;

Функция-член

load

Документ составлен путем анализа строки XML / HTML, которая не поддерживает несколько языков

1
XmlDocument.load(String source);

Параметры вызова:

  • source : String, текст XML / HTML для анализа, зависит от типа созданного документа

Документ составляется путем анализа двоичной строки XML / HTML и автоматически конвертируется в соответствии с языком

1
XmlDocument.load(Buffer source);

Параметры вызова:

  • source : Buffer , текст XML / HTML, который нужно проанализировать, зависит от типа создаваемого документа.

getElementsByTagName

Вернуть список узлов со всеми элементами с указанным именем

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

Параметры вызова:

  • tagName : String, имя тега для извлечения. Значение "*" соответствует всем тегам

Вернуть результат:

  • XmlNodeList , коллекция XmlNodeList узлов XmlElement с указанными тегами в дереве документа. Порядок возвращаемых узлов элементов соответствует порядку их появления в исходном документе.

Этот метод возвращает объект XmlNodeList (который может обрабатываться как массив только для чтения), в котором хранятся все узлы XmlElement с указанным именем тега в документе, и порядок их хранения соответствует порядку их появления в исходном документе. XmlNodeList является «живым», то есть, если элемент с указанным именем тега добавляется или удаляется в документе, его содержимое будет автоматически обновляться по мере необходимости.


getElementsByTagNameNS

Возврат списка узлов со всеми элементами указанного пространства имен и имени

1 2
XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI, String localName);

Параметры вызова:

  • namespaceURI : String, указывает URI пространства имен для извлечения. Значение "*" соответствует всем тегам
  • localName : String, имя тега для извлечения. Значение "*" соответствует всем тегам

Вернуть результат:

  • XmlNodeList , коллекция XmlNodeList узлов XmlElement с указанными тегами в дереве документа. Порядок возвращаемых узлов элементов соответствует порядку их появления в исходном документе.

Этот метод похож на метод getElementsByTagName (), за исключением того, что он извлекает элементы на основе пространства имен и имени.


getElementById

Возвращает элемент с указанным атрибутом id

1
XmlElement XmlDocument.getElementById(String id);

Параметры вызова:

  • id : строка, идентификатор для получения

Вернуть результат:

Этот метод будет проходить по узлам-потомкам документа и возвращать объект узла XmlElement , представляющий первый элемент документа с указанным атрибутом id. ,


getElementsByClassName

Возвращает список узлов со всеми элементами указанного имени класса

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

Параметры вызова:

  • className : String, имя класса для извлечения

Вернуть результат:

  • XmlNodeList , коллекция XmlNodeList с узлами XmlElement с указанным именем класса в дереве документа. Порядок возвращаемых узлов элементов соответствует порядку их появления в исходном документе.

Этот метод возвращает объект XmlNodeList (который может обрабатываться как массив только для чтения), в котором все узлы XmlElement хранятся с указанным именем класса в документе в порядке их появления в исходном документе. XmlNodeList является «живым», то есть, если элемент с указанным именем тега добавляется или удаляется в документе, его содержимое будет автоматически обновляться по мере необходимости.


createElement

Создать узел элемента

1
XmlElement XmlDocument.createElement(String tagName);

Параметры вызова:

  • tagName : String, указанный узел элемента, указанное имя

Вернуть результат:

  • XmlElement , возвращает вновь созданный узел XmlElement с указанным именем тега

createElementNS

Создать узел элемента с указанным пространством имен

1 2
XmlElement XmlDocument.createElementNS(String namespaceURI, String qualifiedName);

Параметры вызова:

  • namespaceURI : String, указанный URI пространства имен узла элемента
  • qualifiedName : String, указанный узел элемента, указанное имя

Вернуть результат:

  • XmlElement , возвращает вновь созданный узел XmlElement с указанным именем тега

createTextNode

Создать текстовый узел

1
XmlText XmlDocument.createTextNode(String data);

Параметры вызова:

  • data : String, указать текст этого узла

Вернуть результат:

  • XmlText , возвращает вновь созданный узел XmlText , представляющий указанную строку данных

createComment

Создать узел комментариев

1
XmlComment XmlDocument.createComment(String data);

Параметры вызова:

  • data : String, укажите текст комментария для этого узла

Вернуть результат:

  • XmlComment , возвращает вновь созданный узел XmlComment , текст комментария - указанные данные

createCDATASection

Создать узел XmlCDATASection

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Параметры вызова:

  • data : String, указывает, что этот узел определяет данные CDATA

Вернуть результат:

  • XmlCDATASection , возвращает вновь созданный узел XmlCDATASection , содержимое - указанные данные

createProcessingInstruction

Создать узел XmlProcessingInstruction

1 2
XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target, String data);

Параметры вызова:

  • target : String, указывает цель для инструкций по обработке
  • data : String, указывает текст содержимого инструкции обработки

Вернуть результат:


hasChildNodes

Проверьте, есть ли дочерний узел

1
Boolean XmlDocument.hasChildNodes();

Вернуть результат:

  • Boolean , возвращает true, если есть дочерние узлы, в противном случае возвращает false

normalize

Объединить смежные текстовые узлы и удалить пустые текстовые узлы

1
XmlDocument.normalize();

Этот метод будет перебирать всех потомков текущего узла, удаляя пустой текстовый узел, объединив все смежные текстовые узлы для нормализации документа. Этот метод полезен для упрощения структуры дерева документа после вставки или удаления узлов.


cloneNode

Создать точную копию указанного узла

1
XmlNode XmlDocument.cloneNode(Boolean deep = true);

Параметры вызова:

  • deep : Boolean, следует ли выполнять глубокое копирование, если true, клонированный узел будет клонировать все дочерние узлы исходного узла

Вернуть результат:

  • XmlNode , вернуть скопированный узел

Этот метод будет копировать и возвращать копию узла, который его вызвал. Если переданный ему параметр имеет значение true, он также будет рекурсивно копировать всех потомков текущего узла. В противном случае он только копирует текущий узел. Возвращенный узел не принадлежит дереву документа, а его атрибут parentNode имеет значение null. При копировании узла Element будут скопированы все его атрибуты.


lookupPrefix

Возвращает префикс, соответствующий указанному URI пространства имен на текущем узле

1
String XmlDocument.lookupPrefix(String namespaceURI);

Параметры вызова:

  • namespaceURI : String, задает соответствующий URI пространства имен

Вернуть результат:

  • String , возвращает совпадающий префикс, если не совпадает, возвращает ноль

lookupNamespaceURI

Возвращает URI пространства имен, соответствующий указанному префиксу на текущем узле

1
String XmlDocument.lookupNamespaceURI(String prefix);

Параметры вызова:

  • prefix : строка, укажите соответствующий префикс

Вернуть результат:

  • String , возвращает соответствующий URI пространства имен, возвращает NULL, если он не совпадает

insertBefore

Вставить новый дочерний узел перед существующим дочерним узлом

1 2
XmlNode XmlDocument.insertBefore(XmlNode newChild, XmlNode refChild);

Параметры вызова:

  • newChild : XmlNode , вставить новый узел
  • refChild : XmlNode , вставьте новый узел перед этим узлом

Вернуть результат:

  • XmlNode , вернуть новый дочерний узел

Если newChild уже существует в дереве документа, он будет удален из дерева документа и затем повторно вставлен в его новое местоположение. Узлы из одного документа (или узлы, созданные одним документом) не могут быть вставлены в другой документ. Другими словами, свойство ownerDocument объекта newChild должно совпадать со свойством ownerDocument текущего узла.


insertAfter

Вставить новый дочерний узел после существующего дочернего узла

1 2
XmlNode XmlDocument.insertAfter(XmlNode newChild, XmlNode refChild);

Параметры вызова:

  • newChild : XmlNode , вставить новый узел
  • refChild : XmlNode , вставьте новый узел после этого узла

Вернуть результат:

  • XmlNode , вернуть новый дочерний узел

Если newChild уже существует в дереве документа, он будет удален из дерева документа и затем повторно вставлен в его новое местоположение. Узлы из одного документа (или узлы, созданные одним документом) не могут быть вставлены в другой документ. Другими словами, свойство ownerDocument объекта newChild должно совпадать со свойством ownerDocument текущего узла.


appendChild

Добавить новый дочерний узел в конец списка дочерних узлов узла

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

Параметры вызова:

  • newChild : XmlNode , укажите добавленный узел

Вернуть результат:

  • XmlNode , верните этот новый дочерний узел

Если newChild уже существует в дереве документа, он будет удален из дерева документа и затем повторно вставлен в его новое местоположение. Узлы из одного документа (или узлы, созданные одним документом) не могут быть вставлены в другой документ. Другими словами, свойство ownerDocument объекта newChild должно совпадать со свойством ownerDocument текущего узла.


replaceChild

Заменить один дочерний узел другим

1 2
XmlNode XmlDocument.replaceChild(XmlNode newChild, XmlNode oldChild);

Параметры вызова:

  • newChild : XmlNode , укажите новый узел
  • oldChild : XmlNode , укажите XmlNode узел

Вернуть результат:

  • XmlNode , если замена прошла успешно, этот метод может вернуть замененный узел, если замена не удалась, он возвращает ноль

Если newChild уже существует в дереве документа, он будет удален из дерева документа и затем повторно вставлен в его новое местоположение. Узлы из одного документа (или узлы, созданные одним документом) не могут быть вставлены в другой документ. Другими словами, свойство ownerDocument объекта newChild должно совпадать со свойством ownerDocument текущего узла.


removeChild

Удалить узел из списка дочерних узлов

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

Параметры вызова:

  • oldChild : XmlNode , укажите узел, который нужно удалить

Вернуть результат:

  • XmlNode , если удаление XmlNode успешно, этот метод может вернуть удаленный узел, в случае сбоя он возвращает ноль

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть переопределён согласно его собственным характеристикам

1
String XmlDocument.toString();

Вернуть результат:

  • String , возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает коллекцию читаемых атрибутов, определенных объектом

1
Value XmlDocument.toJSON(String key = "");

Параметры вызова:

  • key : строка, не используется

Вернуть результат:

  • Value , возвращает значение, содержащее сериализуемый JSON