XML
This feature uses Java's native engine for creating and interpreting XML, based on javax.xml and org.w3c.dom.
// Create XML file
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("Text..."))
root.appendChild(item);
document.appendChild(root);
xml.output(document);
builder
_xml.create().builder() : javax.xml.parsers.DocumentBuilder
Description
Permite aceder o objecto que gere a construção ou interpretação de documentos XML.
Return
( javax.xml.parsers.DocumentBuilder )
Objeto que gere a manipulação de documentos XML.
create
_xml.create() : XML
Description
Cria uma nova instância para manipular XML.
How To Use
const xml = _xml.create();
Return
( XML )
Nova instância do recurso XML.
factory
_xml.create().factory() : javax.xml.parsers.DocumentBuilderFactory
Description
Permite aceder a API da fábrica que gera os objetos de construção ou interpretação de documentos XML.
Return
( javax.xml.parsers.DocumentBuilderFactory )
API da fábrica que gera os objetos de manipulação de documentos XML.
nodeType
_xml.nodeType(tipo: string) : short
Description
Obtém o identificador para um tipo nó da estrutura do XML.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| tipo | string | Identificador do tipo de nó da estrutura do XML através do nome, suporta:
|
Return
( short )
Identificador do tipo de nó no XML.
output
_xml.output(documento: org.w3c.dom.Document) : void
Description
Realiza o output do XML final diretamente para o cliente e também evita o cache do browser.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| documento | org.w3c.dom.Document | Objeto que contém a estrutura e dados do documento de XML. |
Return
( void )
_xml.output(documento: org.w3c.dom.Document, ficheiroNome: string) : void
Description
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.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| 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. |
Return
( void )
parse
_xml.create().parse(fluxoEntrada: InputStream) : org.w3c.dom.Document
Description
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.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| fluxoEntrada | InputStream | Fluxo de entrada de dados em XML. |
Return
( org.w3c.dom.Document )
Objeto de representação do documento XML obtido.
_xml.create().parse(conteudo: string) : org.w3c.dom.Document
Description
Através de um texto XML em string obtém o objeto de representação do documento XML para ser interpretado e processado.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| conteudo | string | Conteúdo XML para ser interpretado e processado. |
Return
( org.w3c.dom.Document )
Objeto de representação do documento XML obtido.
_xml.create().parse(conteudo: string, charset: string) : org.w3c.dom.Document
Description
Através de um texto XML em string obtém o objeto de representação do documento XML para ser interpretado e processado.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| conteudo | string | Conteúdo XML para ser interpretado e processado. |
| charset | string | Código do tipo de codificação de caracteres como:
|
Return
( org.w3c.dom.Document )
Objeto de representação do documento XML obtido.
_xml.create().parse(ficheiro: File) : org.w3c.dom.Document
Description
Através de um ficheiro XML obtém o objeto de representação do documento XML para ser interpretado e processado.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ficheiro | File | Ficheiro XML para ser interpretado e processado. |
Return
( org.w3c.dom.Document )
Objeto de representação do documento XML obtido.
save
_xml.save(documento: org.w3c.dom.Document, fluxoSaida: OutputStream) : void
Description
Guarda o documento em um fluxo de dados de saída.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| 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. |
Return
( void )
_xml.save(documento: org.w3c.dom.Document, ficheiro: File) : void
Description
Guarda o documento em um ficheiro.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| 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. |
Return
( void )
_xml.save(documento: org.w3c.dom.Document, storage: Storage) : void
Description
Guarda o documento no storage da aplicação.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| 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. |
Return
( void )
toString
_xml.toString() : string
Description
A partir da definição do documento obtém uma string com o resultado final em XML.
Return
( string )
Todo contéudo XML final em texto.
_xml.toString(documento: org.w3c.dom.Document) : string
Description
A partir da definição do documento obtém uma string com o resultado final em XML.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| documento | org.w3c.dom.Document | Objeto que contém a estrutura e dados do documento de XML. |
Return
( string )
Todo contéudo XML final em texto.