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

Объект XmlDocument

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

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

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

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlDocument|new XmlDocument()|inputEncoding;xmlStandalone;xmlVersion;doctype;documentElement;head;title;body|load();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName();createElement();createElementNS();createTextNode();createComment();createCDATASection();createProcessingInstruction()] [object] <:- [XmlNode] [XmlNode] <:- [XmlDocument] XmlDocument new XmlDocument() inputEncoding xmlStandalone xmlVersion doctype documentElement head title body load() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() createElement() createElementNS() createTextNode() createComment() createCDATASection() createProcessingInstruction() XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() object toString() toJSON()

Конструктор

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 возвращается null. Этот атрибут может предоставить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;

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


nodeName

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

1
readonly String XmlDocument.nodeName;

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


nodeValue

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

1
String XmlDocument.nodeValue;

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


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, Возвращает узел, следующий сразу за элементом (на том же уровне дерева), если такого узла нет, свойство возвращает null

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, С указанной отметкой в ​​дереве документа XmlElement Узловой XmlNodeListсобирать. Порядок возвращаемых узлов элементов - это порядок, в котором они появляются в исходном документе.

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


getElementsByTagNameNS

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

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

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

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

Результат возврата:

  • XmlNodeList, С указанной отметкой в ​​дереве документа XmlElement Узловой XmlNodeListсобирать. Порядок возвращаемых узлов элементов - это порядок, в котором они появляются в исходном документе.

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


getElementById

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

1
XmlElement XmlDocument.getElementById(String id);

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

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

Результат возврата:

  • XmlElement, Дерево узлов с указанным атрибутом id XmlElement узел

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


getElementsByClassName

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

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

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

  • className: String, имя извлекаемого класса

Результат возврата:

  • XmlNodeList, С указанным именем класса в дереве документа XmlElement Узловой XmlNodeListсобирать. Порядок возвращаемых узлов элементов - это порядок, в котором они появляются в исходном документе.

Этот метод вернет 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, Верните истину, если есть дочерние узлы, в противном случае верните ложь

normalize

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

1
XmlDocument.normalize();

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


cloneNode

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

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

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

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

Результат возврата:

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

Этот метод скопирует и вернет копию вызвавшего его узла. Если переданный ему параметр истинен, он также рекурсивно скопирует всех потомков текущего узла. В противном случае копируется только текущий узел. Возвращенный узел не принадлежит дереву документа, а его свойство 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, укажите соответствующий префикс

Результат возврата:

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

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, Если замена прошла успешно, этот метод может вернуть замененный узел, если замена не удалась, он возвращает ноль

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


removeChild

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

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

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

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

Результат возврата:

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

toString

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

1
String XmlDocument.toString();

Результат возврата:

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

toJSON

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

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

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

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

Результат возврата:

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