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.

Esta clase se ha incorporado al API en la versión 7.16.

Funciones

Constructor

Función

VXmlReader()

Datos de entrada

Retorno	Función
void	addDataBuffer( VByteArray data )
void	addDataString( String data )
void	setFile( VFile file )

Generales

Retorno	Función
Boolean	atEnd()
String	attributeValue( String qualifiedName )
Number	characterOffset()
void	clear()
Number	columnNumber()
String	documentEncoding()
String	documentVersion()
String	dtdName()
String	dtdPublicId()
String	dtdSystemId()
Number	error()
String	errorString()
Boolean	hasError()
Boolean	isCDATA()
Boolean	isCharacters()
Boolean	isComment()
Boolean	isDTD()
Boolean	isEndDocument()
Boolean	isEndElement()
Boolean	isEntityReference()
Boolean	isProcessingInstruction()
Boolean	isStandaloneDocument()
Boolean	isStartDocument()
Boolean	isStartElement()
Boolean	isWhitespace()
Number	lineNumber()
String	name()
String	namespaceUri()
String	prefix()
String	processingInstructionData()
String	processingInstructionTarget()
String	qualifiedName()
void	raiseError( String message = String )
String	readElementText( Number behaviour )
String	readElementText()
Number	readNext()
Boolean	readNextStartElement()
void	skipCurrentElement()
String	text()
String	tokenString()
Number	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()

Crea un objeto de la clase VXmlReader.

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

Ejemplo:

var rss = new VXmlReader();

Datos de entrada

void addDataBuffer( VByteArray data )

Añade una buffer contenido en un objeto de la clase VByteArray al objeto de la clase VXmlReader.

void addDataString( String data )

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

void setFile( VFile file )

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

Funciones generales

Boolean atEnd()

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 )

Number characterOffset()

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

void clear()

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

Number columnNumber()

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

String documentEncoding()

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

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

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

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

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

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

String errorString()

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

Boolean hasError()

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

Boolean isCDATA()

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

Boolean isCharacters()

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

Boolean isComment()

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

Boolean isDTD()

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

Boolean isEndDocument()

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

Boolean isEndElement()

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

Boolean isEntityReference()

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

Boolean isProcessingInstruction()

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

Boolean isStandaloneDocument()

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

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

Boolean isStartElement()

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

Boolean isWhitespace()

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

Number lineNumber()

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

String name()

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

String namespaceUri()

Devuelve el namespaceUri de a StartElement or EndElement.

String prefix()

Devuelve el prefijo de un StartElement or EndElement.

String processingInstructionData()

Devuelve el dato de un ProcessingInstruction.

String processingInstructionTarget()

Devuelve el target de un ProcessingInstruction.

String qualifiedName()

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 )

Levanta un mensaje de error con una texto personalizado.

Parámetros:

• message: texto del mensaje personalizado para el error.

String readElementText( Number behaviour )

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

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

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

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

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

String tokenString()

Devuelve una cadena con el valor del token en curso.

Number tokenType()

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

Ejemplo de bucle típico con VXmlReader

// 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
};