# VXmlReader

Es un parseador rápido de archivos well-formed XML 1.0 para lectura de manera secuencial. Una vez construído el objeto VXmlReader hay que indicarle uno de los siguientes orígenes:

* Disco con la funcion setFile
* Memoria añadiendo uno o varios buffers o strings con las funciones addDataBuffer y addDataString.

## Indice de funciones

### **Constructor**

[VXmlReader](#vxmlreader)()

### **Datos de entrada**

void [addDataBuffer](#adddatabuffer)( VByteArray data )

void [addDataString](#adddatastring)( String data )

void [setFile](#setfile)( VFile file )

### **Generales**

Boolean [atEnd](#atend)()

String [attributeValue](#attributevalue)( String qualifiedName )

Number [characterOffset](#characteroffset)()

void [clear](#clear)()

Number [columnNumber](#columnnumber)()

String [documentEncoding](#documentencoding)()

String [documentVersion](#documentversion)()

String [dtdName](#dtdname)()

String [dtdPublicId](#dtdpublicid)()

String [dtdSystemId](#dtdsystemid)()

Number [error](#error)()

String [errorString](#errorstring)()

Boolean  [hasError](#haserror)()

Boolean [isCDATA](#iscdata)()

Boolean [isCharacters](#ischaracters)()

Boolean [isComment](#iscomment)()

Boolean [isDTD](#isdtd)()

Boolean [isEndDocument](#isenddocument)()

Boolean [isEndElement](#isendelement)()

Boolean [isEntityReference](#isentityreference)()

Boolean [isProcessingInstruction](#isprocessinginstruction)()

Boolean [isStandaloneDocument](#isstandalonedocument)()

Boolean [isStartDocument](#isstartdocument)()

Boolean [isStartElement](#isstartelement)()

Boolean [isWhitespace](#iswhitespace)()

Number [lineNumber](#linenumber)()

String [name](#name)()

String [namespaceUri](#namespaceuri)()

String [prefix](#prefix)()

String [processingInstructionData](#processinginstructiondata)()

String [processingInstructionTarget](#processinginstructiontarget)()

String [qualifiedName](#qualifiedname)()

void [raiseError](#raiseerror)( String message = String )

String [readElementText](#readelementtext)( Number behaviour )

String [readElementText](#string-readelementtext)()

Number [readNext](#readnext)()

Boolean [readNextStartElement](#readnextstartelement)()

void [skipCurrentElement](#skipcurrentelement)()

String [text](#text)()

String [tokenString](#tokenstring)()

Number [tokenType](#tokentype)()

## Enumeraciones

**Error**

* NoError = 0
* UnexpectedElementError = 1
* CustomError = 2
* NotWellFormedError = 3
* PrematureEndOfDocumentError = 4

**ReadElementTextBehaviour**

* ErrorOnUnexpectedElement = 0
* IncludeChildElements = 1
* SkipChildElements = 2

**TokenType**

* NoToken = 0
* Invalid = 1
* StartDocument = 2
* EndDocument = 3
* StartElement = 4
* EndElement = 5
* Characters = 6
* Comment = 7
* DTD = 8
* EntityReference = 9
* ProcessingInstruction = 10

## Documentación de funciones

### Constructor

#### VXmlReader() <a href="#vxmlreader" id="vxmlreader"></a>

Crea un objeto de la clase VXmlReader.

Requiere importar la clase previamente: importClass("VXmlReader").

Ejemplo:

var rss = new VXmlReader();

### Datos de entrada <a href="#dat-ent" id="dat-ent"></a>

#### void addDataBuffer( VByteArray data ) <a href="#adddatabuffer" id="adddatabuffer"></a>

Añade una buffer contenido en un objeto de la clase [VByteArray](vbytearray) al objeto de la clase VXmlReader.

#### void addDataString( String data ) <a href="#adddatastring" id="adddatastring"></a>

Añade una cadena de texto al objeto de la clase VXmlReader.

#### void setFile( VFile file ) <a href="#setfile" id="setfile"></a>

Asigna un fichero (objeto de la clase [VFile](vfile)) al objeto de la clase VXmlReader para procesar su contenido.

### Funciones generales

#### Boolean atEnd() <a href="#atend" id="atend"></a>

Devuelve true si el lector ha llegado al fin del documento XML, o si se ha producido un error y la lectura ha sido abortada, en caso contrario se devuelve false.

#### String attributeValue( String qualifiedName ) <a href="#attributevalue" id="attributevalue"></a>

#### Number characterOffset() <a href="#characteroffset" id="characteroffset"></a>

Devuelve el desplazamiento del carácter en curso, comenzando por la posición 0.

#### void clear() <a href="#clear" id="clear"></a>

Borra cualquier dispositivo o dato del lector y resetea su estado interno al estado inicial.

#### Number columnNumber() <a href="#columnnumber" id="columnnumber"></a>

Devuelve el número de columna en curso, la primera columna ocupa la posición 0.

#### String documentEncoding() <a href="#documentencoding" id="documentencoding"></a>

Si el estado del documento, función tokenType(), es StartDocument la función devuelve una cadena con el valor de su codificación especificada como una declaración XML. En el resto de caso devuelve una cadena vacía.

#### String documentVersion() <a href="#documentversion" id="documentversion"></a>

Si el estado del documento, función tokenType(), es StartDocument la función devuelve una cadena con la versión del documento especificada como una declaración XML, en caso contrario devuelve una cadena vacía.

#### String dtdName() <a href="#dtdname" id="dtdname"></a>

Si el estado del documento, función tokenType(), es DTD la función retorna el nombre del DTD, en caso contrario devuelve una cadena vacía.

#### String dtdPublicId() <a href="#dtdpublicid" id="dtdpublicid"></a>

Si el estado del documento, función tokenType(), es DTD la función retorna el identificador público del DTD, en caso contrario devuelve una cadena vacía.

#### String dtdSystemId() <a href="#dtdsystemid" id="dtdsystemid"></a>

Si el estado del documento, función tokenType(), es DTD la función retorna el identificador del sistema DTD, en caso contrario devuelve una cadena vacía.

#### Number error() <a href="#error" id="error"></a>

Devuelve el tipo del error en curso o NoError (ver enum Error) si no se ha producido ningún error.

#### String errorString() <a href="#errorstring" id="errorstring"></a>

Devuelve el mensaje de error por defecto o el que estaba fijado con la función raiseError().

#### Boolean hasError() <a href="#haserror" id="haserror"></a>

Devuelve true si se ha producido un error, en caso contrario devuelve false.

#### Boolean isCDATA() <a href="#iscdata" id="iscdata"></a>

Devuelve true si el lector retorna caracteres que proceden de una sección CDATA, en caso contrario devuelve false.

#### Boolean isCharacters() <a href="#ischaracters" id="ischaracters"></a>

Devuelve true si tokenType() devuelve el valor "Characters", en caso contrario devuelve false.

#### Boolean isComment() <a href="#iscomment" id="iscomment"></a>

Devuelve true si tokenType() devuelve el valor "Comment", en caso contrario devuelve false.

#### Boolean isDTD() <a href="#isdtd" id="isdtd"></a>

Devuelve true si tokenType() devuelve el valor "DTD", en caso contrario devuelve false.

#### Boolean isEndDocument() <a href="#isenddocument" id="isenddocument"></a>

Devuelve true si tokenType() devuelve el valor "EndDocument", en caso contrario devuelve false.

#### Boolean isEndElement() <a href="#isendelement" id="isendelement"></a>

Devuelve true si tokenType() devuelve el valor "EndElement", en caso contrario devuelve false.

#### Boolean isEntityReference() <a href="#isentityreference" id="isentityreference"></a>

Devuelve true si tokenType() devuelve el valor "EntityReference", en caso contrario devuelve false.

#### Boolean isProcessingInstruction() <a href="#isprocessinginstruction" id="isprocessinginstruction"></a>

Devuelve true si tokenType() devuelve el valor "ProcessingInstruction", en caso contrario devuelve false.

#### Boolean isStandaloneDocument() <a href="#isstandalonedocument" id="isstandalonedocument"></a>

Devuelve true si el documento ha sido declarado como único en la declaración XML, en caso contrario devuelve false. Si no ha sido parseada una declaración XML, la función devuelve false.

#### Boolean isStartDocument() <a href="#isstartdocument" id="isstartdocument"></a>

Devuelve true si tokenType() devuelve el valor "StartDocument", en caso contrario devuelve false.

#### Boolean isStartElement() <a href="#isstartelement" id="isstartelement"></a>

Devuelve true si tokenType() devuelve el valor "StartElement", en caso contrario devuelve false.

#### Boolean isWhitespace() <a href="#iswhitespace" id="iswhitespace"></a>

Devuelve true si los caracteres retornados por el lector solo contienen espacios en blanco, en caso contrario devuelve false.

#### Number lineNumber() <a href="#linenumber" id="linenumber"></a>

Devuelve la línea en curso, las numeración comienza por la línea 1.

#### String name() <a href="#name" id="name"></a>

Devuelve el nombre local de un StartElement, EndElement, or an EntityReference.

#### String namespaceUri() <a href="#namespaceuri" id="namespaceuri"></a>

Devuelve el namespaceUri de a StartElement or EndElement.

#### String prefix() <a href="#prefix" id="prefix"></a>

Devuelve el prefijo de un StartElement or EndElement.

#### String processingInstructionData() <a href="#processinginstructiondata" id="processinginstructiondata"></a>

Devuelve el dato de un ProcessingInstruction.

#### String processingInstructionTarget() <a href="#processinginstructiontarget" id="processinginstructiontarget"></a>

Devuelve el target de un ProcessingInstruction.

#### String qualifiedName() <a href="#qualifiedname" id="qualifiedname"></a>

Devuelve el nombre cualificado de un StartElement o EndElement.

Un nombre calificado es el nombre en bruto de un elemento en los datos XML. Está compuesto por el prefijo del namespace, seguido de dos puntos, seguido por el nombre local del elemento. El prefijo de namespace no es único (el mismo prefijo puede apuntar a diferentes namespaces y diferentes prefijos puede apuntar al mismo namespace).

#### void raiseError( String message = String ) <a href="#raiseerror" id="raiseerror"></a>

Levanta un mensaje de error con una texto personalizado.

Parámetros:

* message: texto del mensaje personalizado para el error.

#### String readElementText( Number behaviour ) <a href="#readelementtext" id="readelementtext"></a>

Esta función se llamada cuando se lee un startElement, lee hasta llegar al EndElement correspondiente y devuelve todo el texto en el medio. En caso de error, el token actual (ver TokenType()) después de haber llamado a esta función es EndElement.

La función concatena text() cuando lee o bien caracteres o fichas EntityReference, pero se salta ProcessingInstruction y comentario. Si el token actual no es startElement, se devuelve una cadena vacía.

El comportamiento define lo que sucede en caso de que cualquier otra cosa que se lea antes de llegar EndElement. La función puede incluir el texto desde elementos hijos (útil por ejemplo para HTML), ignorar elementos secundarios, o lanzar una UnexpectedElementError y devolver lo que se ha leído hasta ahora.

Parámetros:

* behaviour: ver enum ReadElementTextBehaviour

#### String readElementText()

Esta función se llamada cuando se lee un startElement, lee hasta llegar al EndElement correspondiente y devuelve todo el texto en el medio. En caso de error, el token actual (ver TokenType()) después de haber llamado a esta función es EndElement.

La función concatena text() cuando lee o bien caracteres o fichas EntityReference, pero se salta ProcessingInstruction y comentario. Si el token actual no es startElement, se devuelve una cadena vacía.

#### Number readNext() <a href="#readnext" id="readnext"></a>

Lee el siguiente token y devuelve su tipo. Ver enum TokenType.

Si se dispara una excepción que devuelve el error() al ejecutar readNext() produce que la lectura adicional del stream XML ya no sea posible, en ese punto atEnd() devuelve true, hasError() devuelve verdadero, y esta función devuelve QXmlStreamReader válida.

La excepción que devuelve el error() PrematureEndOfDocumentError se notifica cuando se alcanza el final del documento XML, pero realmente no se ha alcanzado el final del documento XML completo. En ese caso, el análisis se puede reanudar llamando addData() para agregar el siguiente fragmento de XML, cuando el stream está siendo leído desde un QByteArray, o esperando más datos que se recibirán a través de un stream.

#### Boolean readNextStartElement() <a href="#readnextstartelement" id="readnextstartelement"></a>

Lee hasta el inicio del siguiente elemento dentro del elemento en curso. Devuelve true cuando alcanza un elemento de inicio. Devuelve false cuando alcanza un elemento final o cuando se produce un error.

El elemento en curso es el elemento que coincida con el elemento de inicio más recientemente analizado del que aún no se haya alcanzado el final. Cuando el analizador haya alcanzado el elemento final, el elemento principal se convierte en el elemento actual.

Es posible recorrer un documento llamando repetidamente a esta función garantizando al mismo tiempo que el lector no haya alcanzado el final del documento.

#### void skipCurrentElement() <a href="#skipcurrentelement" id="skipcurrentelement"></a>

Lee hasta el final del elemento en curso, omitiendo cualquier nodo hijo. Esta función es útil para saltarse elementos desconocidos.

El elemento en curso es el elemento que coincida con el elemento de inicio más recientemente analizado del que aún no se haya alcanzado un elemento final coincidente. Cuando el analizador alcanza el elemento final, el elemento padre se convierte en el elemento en curso.

#### String text() <a href="#text" id="text"></a>

Devuelve el texto de los elementos de tipo Characters, Comment, DTD, o EntityReference.

#### String tokenString() <a href="#tokenstring" id="tokenstring"></a>

Devuelve una cadena con el valor del token en curso.

#### Number tokenType() <a href="#tokentype" id="tokentype"></a>

Devuelve el estado del documento. Ver enum TokenType.

El tocken en curso también puede ser consultado con las funciones isStartDocument(), isEndDocument(), isStartElement(), isEndElement(), isCharacters(), isComment(), isDTD(), isEntityReference(), and isProcessingInstruction().

## Ejemplos

### 1 Ejemplo de bucle típico con VXmlReader

```javascript
// Abrimos el fichero
var inFile = new VFile( senda );
inFile.open(VFile.OpenModeReadOnly);

// Preparamos el objeto para parsear el XML
var xml = new VXmlReader();
xml.setFile(inFile);
VXmlReader xml;
xml.setFile( myVFile );

while (!xml.atEnd())
{
xml.readNext();
… // procesar
};
if (xml.hasError())
{
… // manejar el error
};
```

### 2 Procesar un fichero xml con formato xbel 1.0 y mostrar el resultado un control del tipo [treeWidget](../../../../proyectos-objetos-y-editores/proyecto-de-aplicacion/formulario/tree-widget)

```javascript
importClass("VXmlReader");
importClass("VFile");

// -------------------------------------------------------
// Parseador de ficheros XML en formato xbel 1.0
// -------------------------------------------------------

// Preparamos el control treewidget
var treeWidget = theRoot.dataView().control("TREE_WIDGET");
treeWidget.clear();

// Leemos el fichero desde la senda del control
var fileEdit = theRoot.dataView().control("FILE");
var inFile = new VFile( fileEdit.text );
inFile.open(VFile.OpenModeReadOnly);

// Preparamos el objeto para parsear el XML
var xml = new VXmlReader();
xml.setFile(inFile);

// Leemos el primer elemento del fichero para comprobar que es de tipo xbel versión 1.0
if (xml.readNextStartElement()) 
{
    if (xml.name() == "xbel" && xml.attributeValue("version") == "1.0")
    {
        // XBEL read
        while (xml.readNextStartElement()) 
        {
            if (xml.name() == "folder")
                readFolder(treeWidget, 0, xml);
            else if (xml.name() == "bookmark")
                readBookmark(treeWidget, 0, xml);
            else if (xml.name() == "separator")
                readSeparator(treeWidget, 0, xml);
            else
                xml.skipCurrentElement();
        };
    }
    else
        xml.raiseError("Este fichero no es un XBEL 1.0");
};

// Ajusta las columnas al contenido
treeWidget.resizeColumnToContents(0);
treeWidget.setFocus();

// --------------------------
// Lectura de la carpeta
// --------------------------
function readFolder(tree, item, xml)
{
    var itemFolder;
    if (item)
        itemFolder = item.addChild();
    else
        itemFolder = tree.addTopLevelItem();
    var folded = (xml.attributeValue("folded") != "no");
    itemFolder.setExpanded(!folded);

    while (xml.readNextStartElement()) 
    {
        if (xml.name() == "title")
            readTitle(itemFolder, xml);
        else if (xml.name() == "folder")
            readFolder(tree, itemFolder, xml);
        else if (xml.name() == "bookmark")
            readBookmark(tree, itemFolder, xml);
        else if (xml.name() == "separator")
            readSeparator(tree, itemFolder, xml);
        else
            xml.skipCurrentElement();
    };
};

// ----------------------
// Lectura del  título
// ----------------------
function readTitle( item, xml )
{
    var title = xml.readElementText();
    item.setText(0, title);
};

// ---------------------------
// Lectura del  bookmark
// ---------------------------
function readBookmark(tree, item, xml)
{
    var itemBookmark;
    if (item)
        itemBookmark = item.addChild();
    else
        itemBookmark = tree.addTopLevelItem();

    itemBookmark.setFlags(0 | itemBookmark.flags() | VTreeItem.ItemIsEditable);
    itemBookmark.setText(0, "Título desconocido");
    itemBookmark.setText(1, xml.attributeValue("href"));

    while (xml.readNextStartElement()) 
    {
        if (xml.name() == "title")
            readTitle(itemBookmark, xml);
        else
            xml.skipCurrentElement();
    };
};

// --------------------------
// Lectura del separador
// --------------------------
function readSeparator(tree, item, xml)
{
    var itemSeparator;
    if (item)
        itemSeparator = item.addChild();
    else
        itemSeparator = tree.addTopLevelItem();

    itemSeparator.setText(0, "...............................................................................");
    xml.skipCurrentElement();
};
```
