XML

Este recurso utiliza o mecanismo nativo do Java para criar e interpretar XML, baseado no javax.xml e no org.w3c.dom.

// Criar ficheiro XML
const xml = _xml.create();
const document = xml.builder().newDocument();
const root = document.createElement("root");
const item = document.createElement("item");
const attItemId = document.createAttribute("id");
attItemId.setValue("1");
item.setAttributeNode(attItemId);
item.appendChild(document.createTextNode("Texto..."))
root.appendChild(item);
document.appendChild(root);
xml.output(document);

---

builder

---

_xml.create().builder() : javax.xml.parsers.DocumentBuilder

Descrição

Permite aceder o objecto que gere a construção ou interpretação de documentos XML.

Retorno

( javax.xml.parsers.DocumentBuilder )

Objeto que gere a manipulação de documentos XML.

---

create

---

_xml.create() : XML

Descrição

Cria uma nova instância para manipular XML.

Como Usar

const xml = _xml.create();

Retorno

( XML )

Nova instância do recurso XML.

---

factory

---

_xml.create().factory() : javax.xml.parsers.DocumentBuilderFactory

Descrição

Permite aceder a API da fábrica que gera os objetos de construção ou interpretação de documentos XML.

Retorno

( javax.xml.parsers.DocumentBuilderFactory )

API da fábrica que gera os objetos de manipulação de documentos XML.

---

nodeType

---

_xml.nodeType(tipo: string) : short

Descrição

Obtém o identificador para um tipo nó da estrutura do XML.

Atributos

NOME	TIPO	DESCRIÇÃO
tipo	string	Identificador do tipo de nó da estrutura do XML através do nome, suporta: element attribute text cdata-section entity-reference entity processing-instruction comment document document-type document-fragment notation

Retorno

( short )

Identificador do tipo de nó no XML.

---

output

---

_xml.output(documento: org.w3c.dom.Document) : void

Descrição

Realiza o output do XML final diretamente para o cliente e também evita o cache do browser.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.

Retorno

( void )

---

_xml.output(documento: org.w3c.dom.Document, ficheiroNome: string) : void

Descrição

Realiza o output do ficheiro XML final para o cliente realizar o download final diretamente para o cliente e também evita o cache do browser.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.
ficheiroNome	string	Nome do ficheiro que será indicado para o cliente efetuar o download.

Retorno

( void )

---

parse

---

_xml.create().parse(fluxoEntrada: InputStream) : org.w3c.dom.Document

Descrição

Através de um fluxo de entrada de dados de XML obtém o objeto de representação do documento para ser interpretado e processado.

Atributos

NOME	TIPO	DESCRIÇÃO
fluxoEntrada	InputStream	Fluxo de entrada de dados em XML.

Retorno

( org.w3c.dom.Document )

Objeto de representação do documento XML obtido.

---

_xml.create().parse(conteudo: string) : org.w3c.dom.Document

Descrição

Através de um texto XML em string obtém o objeto de representação do documento XML para ser interpretado e processado.

Atributos

NOME	TIPO	DESCRIÇÃO
conteudo	string	Conteúdo XML para ser interpretado e processado.

Retorno

( org.w3c.dom.Document )

Objeto de representação do documento XML obtido.

---

_xml.create().parse(conteudo: string, charset: string) : org.w3c.dom.Document

Descrição

Através de um texto XML em string obtém o objeto de representação do documento XML para ser interpretado e processado.

Atributos

NOME	TIPO	DESCRIÇÃO
conteudo	string	Conteúdo XML para ser interpretado e processado.
charset	string	Código do tipo de codificação de caracteres como: US-ASCII ISO-8859-1 UTF-8 UTF-16BE UTF-16LE UTF-16

Retorno

( org.w3c.dom.Document )

Objeto de representação do documento XML obtido.

---

_xml.create().parse(ficheiro: File) : org.w3c.dom.Document

Descrição

Através de um ficheiro XML obtém o objeto de representação do documento XML para ser interpretado e processado.

Atributos

NOME	TIPO	DESCRIÇÃO
ficheiro	File	Ficheiro XML para ser interpretado e processado.

Retorno

( org.w3c.dom.Document )

Objeto de representação do documento XML obtido.

---

save

---

_xml.save(documento: org.w3c.dom.Document, fluxoSaida: OutputStream) : void

Descrição

Guarda o documento em um fluxo de dados de saída.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.
fluxoSaida	OutputStream	Fluxo de dados de saída onde o documento deve ser guardado.

Retorno

( void )

---

_xml.save(documento: org.w3c.dom.Document, ficheiro: File) : void

Descrição

Guarda o documento em um ficheiro.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.
ficheiro	File	Ficheiro de destino onde o documento deve ser guardado.

Retorno

( void )

---

_xml.save(documento: org.w3c.dom.Document, storage: Storage) : void

Descrição

Guarda o documento no storage da aplicação.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.
storage	Storage	Destino no storage da aplicação onde o documento deve ser guardado.

Retorno

( void )

---

toString

---

_xml.toString() : string

Descrição

A partir da definição do documento obtém uma string com o resultado final em XML.

Retorno

( string )

Todo contéudo XML final em texto.

---

_xml.toString(documento: org.w3c.dom.Document) : string

Descrição

A partir da definição do documento obtém uma string com o resultado final em XML.

Atributos

NOME	TIPO	DESCRIÇÃO
documento	org.w3c.dom.Document	Objeto que contém a estrutura e dados do documento de XML.

Retorno

( string )

Todo contéudo XML final em texto.

---