Objecte objecte incorporat

Objecte XmlDocument

L'objecte XmlDocument representa tot el document XML

L'objecte XmlDocument és l'arrel d'un arbre de documents, que ens proporciona l'accés inicial (o superior) a les dades del document. Per a nodes d'elements, nodes de text, comentaris, instruccions de processament, etc., no tots poden existir fora de XmlDocument i l'objecte XmlDocument també proporciona mètodes per crear aquests objectes.XmlNode Els objectes proporcionen una propietat ownerDocument que els associa amb el XmlDocument en què es creen.

Herència

#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()

Constructor

XmlDocument

Construeix un objecte XmlDocument

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

Paràmetres de trucada:

  • type: Cadena, especifiqueu el tipus d'objecte del document, el valor per defecte és "text /xml", si heu de processar html, heu d'especificar" text / html "

Atributs de membre

inputEncoding

Cadena, retorna la codificació utilitzada per al document (quan s’analitza)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Booleà, defineix o torna si el document és independent

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

Encadeneu, configureu o torneu la versió XML del document

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType, Retorna la declaració de tipus de document relacionada amb el document (Declaració de tipus de document)

1
readonly XmlDocumentType XmlDocument.doctype;

Per als documents XML sense DTD, es torna nul. Aquest atribut es pot proporcionarXmlDocumentType Accés directe a l'objecte (un node fill de XmlDocument).


documentElement

XmlElement, Torneu el node arrel del document

1
readonly XmlElement XmlDocument.documentElement;

XmlElement, Retorna el node principal del document HTML, només vàlid en mode html

1
readonly XmlElement XmlDocument.head;

title

Cadena, retorna el contingut del node de títol del document HTML, només vàlid en mode html

1
readonly String XmlDocument.title;

body

XmlElement, Retorna el node cos del document HTML, només vàlid en mode html

1
readonly XmlElement XmlDocument.body;

nodeType

Enter, retorna el tipus de node del node

1
readonly Integer XmlDocument.nodeType;

El nodeType de diferents objectes retornarà diferents valors:


nodeName

Cadena, retorna el nom del node, segons el seu tipus

1
readonly String XmlDocument.nodeName;

El nodeName de diferents objectes retornarà diferents valors:


nodeValue

Cadena, retorna el nom del node, segons el seu tipus

1
String XmlDocument.nodeValue;

El nodeName de diferents objectes retornarà diferents valors:


ownerDocument

XmlDocument, retorna l'element arrel del node (objecte XmlDocument)

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode, Pot retornar el node pare d'un node

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList, Retorna la llista de nodes dels nodes fills del node especificat

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode, Retorna el primer node fill del node

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode, Retorna l'últim node fill del node

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode, Retorna el node immediatament abans d’un determinat node (al mateix nivell d’arbre), si no hi ha aquest node, l’atribut torna nul

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode, Retorna el node immediatament després d'un element (al mateix nivell d'arbre), si no hi ha aquest node, la propietat torna nul

1
readonly XmlNode XmlDocument.nextSibling;

Funció de membre

load

Redactar el document analitzant una cadena XML / HTML, no admet el multilingüe

1
XmlDocument.load(String source);

Paràmetres de trucada:

  • source: Cadena, el text XML / HTML que cal analitzar, en funció del tipus de document que es va crear

El document es compon analitzant una cadena binària XML / HTML i es converteix automàticament segons el llenguatge

1
XmlDocument.load(Buffer source);

Paràmetres de trucada:

  • source: Buffer, El text XML / HTML que cal analitzar depèn del tipus de document quan es va crear

getElementsByTagName

Retorna una llista de nodes de tots els elements amb el nom especificat

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

Paràmetres de trucada:

  • tagName: String, el nom de l'etiqueta que s'ha de recuperar. El valor "*" coincideix amb totes les etiquetes

Resultat de retorn:

  • XmlNodeList, Amb la marca especificada a l'arbre del document XmlElement Nodal XmlNodeListconjunt. L'ordre dels nodes d'elements retornats és l'ordre en què apareixen al document d'origen.

Aquest mètode retornarà un fitxer XmlNodeList Objecte (es pot processar com una matriu de només lectura), l'objecte emmagatzema tots els documents amb el nom d'etiqueta especificat XmlElement Nodes, l'ordre en què s'emmagatzemen és l'ordre en què apareixen al document d'origen. XmlNodeList L'objecte és "actiu", és a dir, si s'afegeix o elimina un element amb el nom d'etiqueta especificat al document, el seu contingut s'actualitzarà automàticament segons sigui necessari.


getElementsByTagNameNS

Retorna una llista de nodes amb tots els elements de l'espai de noms i el nom especificats

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

Paràmetres de trucada:

  • namespaceURI: String, especifica l’URI de l’espai de noms a recuperar. El valor "*" pot coincidir amb totes les etiquetes
  • localName: String, el nom de l'etiqueta que s'ha de recuperar. El valor "*" coincideix amb totes les etiquetes

Resultat de retorn:

  • XmlNodeList, Amb la marca especificada a l'arbre del document XmlElement Nodal XmlNodeListconjunt. L'ordre dels nodes d'elements retornats és l'ordre en què apareixen al document d'origen.

Aquest mètode és similar al mètode getElementsByTagName (), tret que recupera elements basats en l’espai de noms i el nom.


getElementById

Retorna l'element amb l'atribut id especificat

1
XmlElement XmlDocument.getElementById(String id);

Paràmetres de trucada:

  • id: Cadena, identificador que s'ha de recuperar

Resultat de retorn:

Aquest mètode recorrerà els nodes descendents del document i retornarà un XmlElementL'objecte node representa el primer element del document amb l'atribut id especificat. .


getElementsByClassName

Retorna una llista de nodes de tots els elements amb el nom de classe especificat

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

Paràmetres de trucada:

  • className: String, el nom de la classe que es recuperarà

Resultat de retorn:

  • XmlNodeList, Amb el nom de classe especificat a l'arbre del document XmlElement Nodal XmlNodeListconjunt. L'ordre dels nodes d'elements retornats és l'ordre en què apareixen al document d'origen.

Aquest mètode retornarà un fitxer XmlNodeList Objecte (es pot processar com una matriu de només lectura), que emmagatzema tots els fitxers amb el nom de classe especificat al document XmlElement Nodes, l'ordre en què s'emmagatzemen és l'ordre en què apareixen al document d'origen. XmlNodeList L'objecte és "actiu", és a dir, si s'afegeix o elimina un element amb el nom d'etiqueta especificat al document, el seu contingut s'actualitzarà automàticament segons sigui necessari.


createElement

Crea un node d'element

1
XmlElement XmlDocument.createElement(String tagName);

Paràmetres de trucada:

  • tagName: Cadena, especifiqueu el nom especificat del node de l'element

Resultat de retorn:


createElementNS

Creeu un node d'element amb l'espai de noms especificat

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

Paràmetres de trucada:

  • namespaceURI: Cadena, especifiqueu l'URI de l'espai de noms del node de l'element
  • qualifiedName: Cadena, especifiqueu el nom especificat del node de l'element

Resultat de retorn:


createTextNode

Crea un node de text

1
XmlText XmlDocument.createTextNode(String data);

Paràmetres de trucada:

  • data: Cadena, especifiqueu el text d’aquest node

Resultat de retorn:

  • XmlText, Torneu el nou creat XmlText Node, que representa la cadena de dades especificada

createComment

Crea un node de comentaris

1
XmlComment XmlDocument.createComment(String data);

Paràmetres de trucada:

  • data: Cadena, especifiqueu el text de comentari d’aquest node

Resultat de retorn:


createCDATASection

crear XmlCDATASection node

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Paràmetres de trucada:

  • data: Cadena, especifiqueu aquest node per especificar les dades CDATA

Resultat de retorn:


createProcessingInstruction

crear XmlProcessingInstruction node

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

Paràmetres de trucada:

  • target: Cadena, especifiqueu l'objectiu de la instrucció de processament
  • data: Cadena, especifiqueu el contingut del text de la instrucció de processament

Resultat de retorn:


hasChildNodes

Consulteu si hi ha nodes secundaris

1
Boolean XmlDocument.hasChildNodes();

Resultat de retorn:

  • Boolean, Torneu a true si hi ha nodes secundaris, en cas contrari, torneu a false

normalize

Combineu els nodes de text adjacents i suprimiu els nodes de text buits

1
XmlDocument.normalize();

Aquest mètode recorrerà tots els descendents del node actual i normalitzarà el document suprimint el node de text buit i fusionant tots els nodes de text adjacents. Aquest mètode és útil per simplificar l'estructura de l'arbre del document després d'inserir o suprimir nodes.


cloneNode

Creeu una còpia exacta del node especificat

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

Paràmetres de trucada:

  • deep: Booleà, si voleu copiar en profunditat, quan és cert, el node clonat clonarà tots els nodes fills del node original

Resultat de retorn:

Aquest mètode copiarà i retornarà una còpia del node que l’ha anomenat. Si el paràmetre que se li passa és cert, també copiarà recursivament tots els descendents del node actual. En cas contrari, només copia el node actual. El node retornat no pertany a l'arbre del document i la seva propietat parentNode és nul·la. Quan es copiï el node Element, es copiaran tots els seus atributs.


lookupPrefix

Retorna el prefix que coincideix amb l'URI d'espai de noms especificat al node actual

1
String XmlDocument.lookupPrefix(String namespaceURI);

Paràmetres de trucada:

  • namespaceURI: Cadena, especifiqueu l'URI de l'espai de noms coincident

Resultat de retorn:

  • String, Retorna el prefix coincident, torna nul si no coincideix

lookupNamespaceURI

Retorna l'URI de l'espai de noms que coincideix amb el prefix especificat al node actual

1
String XmlDocument.lookupNamespaceURI(String prefix);

Paràmetres de trucada:

  • prefix: Cadena, especifiqueu el prefix coincident

Resultat de retorn:

  • String, Retorna l'URI de l'espai de noms coincident, torna nul si no coincideix

insertBefore

Inseriu un node fill nou abans del node fill existent

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

Paràmetres de trucada:

  • newChild: XmlNode, Inseriu un nou node
  • refChild: XmlNode, Inseriu un nou node abans d'aquest node

Resultat de retorn:

  • XmlNode, Retorna el nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.


insertAfter

Inseriu un node fill nou després del node fill existent

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

Paràmetres de trucada:

  • newChild: XmlNode, Inseriu un nou node
  • refChild: XmlNode, Inseriu un nou node després d’aquest node

Resultat de retorn:

  • XmlNode, Retorna el nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.


appendChild

Afegiu un node fill nou al final de la llista de nodes fills del node

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

Paràmetres de trucada:

  • newChild: XmlNode, Especifiqueu el node afegit

Resultat de retorn:

  • XmlNode, Retorna aquest nou node fill

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.


replaceChild

Substituïu un node fill per un altre

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

Paràmetres de trucada:

  • newChild: XmlNode, Especifiqueu un nou node
  • oldChild: XmlNode, Especifiqueu el node a substituir

Resultat de retorn:

  • XmlNode, Si la substitució és correcta, aquest mètode pot retornar el node substituït; si la substitució falla, torna nul

Si newChild ja existeix a l'arbre del document, se suprimirà de l'arbre del document i es reintroduirà a la seva nova posició. Els nodes d'un document (o nodes creats per un document) no es poden inserir en un altre document. En altres paraules, la propietat ownerDocument de newChild ha de ser la mateixa que la propietat ownerDocument del node actual.


removeChild

Elimineu un node de la llista de nodes secundaris

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

Paràmetres de trucada:

  • oldChild: XmlNode, Especifiqueu el node a suprimir

Resultat de retorn:

  • XmlNode, Si la supressió és correcta, aquest mètode pot retornar el node suprimit; si falla, torna nul

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String XmlDocument.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable