JsLib 1.4

Script xml.js


Le script xml.js permet de charger un fichier XML puis d'accéder aux données qu'il contient, à la manière d'un parser XML.

Une fonction permet de charger en mémoire un fichier XML. Selon le navigateur utilisé, l'accès au DOM (Document Object Model) du document XML s'effectue avec :

Une fonction permet de vérifier que le fichier XML est totalement chargé en mémoire.

Des fonctions de consultation permettent :

Enfin, des fonctions de recherche permettent :

Depuis :
JsLib 1.4

 
Résumé des fonctions
 booléen accepteXML()
           Indique si le navigateur accepte le XML.
 booléen chargerFichierXML(chaîne url)
           Charge en mémoire le fichier XML d'URL spécifiée.
 entier compterNoeuds(chaîne nomNoeud)
           Compte le nombre de noeuds XML de nom spécifié.
 chaîne obtenirCommentaires()
           Retourne les commentaires du document XML.
 objet obtenirNoeud(chaîne nomNoeud, chaîne valeurNoeud)
           Retourne le premier noeud XML de nom et de valeur spécifiés.
 objet obtenirNoeudFils(objet noeud, chaîne nomFils)
           Retourne le noeud fils de nom spécifié du noeud XML passé en paramètre.
 objet obtenirNoeudPere(objet noeud)
           Retourne le noeud père du noeud XML passé en paramètre.
 objet obtenirNoeudRacine()
           Retourne le noeud XML racine du document XML.
 chaîne obtenirNomNoeud(objet noeud)
           Retourne le nom du noeud XML passé en paramètre.
 chaîne obtenirValeurAttribut(objet noeud, chaîne attribut)
           Retourne la valeur de l'attribut spécifié du noeud XML passé en paramètre.
 chaîne obtenirValeurNoeud(objet noeud)
           Retourne la valeur du noeud XML passé en paramètre.
 objet rechercherNoeud(chaîne nomNoeud, chaîne valeurNoeud)
           Retourne le premier noeud XML dont la valeur contient la chaîne specifiée.
 objet rechercherNoeudParAttribut(chaîne nomNoeud, chaîne attribut, chaîne valeurAttribut)
           Retourne le premier noeud XML dont l'attribut spécifié contient la chaîne spécifiée.
 booléen verifierChargementXML()
           Vérifie que le fichier XML est totalement chargé en mémoire.
 
Détail des fonctions

accepteXML

booléen accepteXML()
Indique si le navigateur accepte le XML. Cette fonction renvoie true si le navigateur utilisé fournit un moyen connu d'accéder au DOM (Document Object Model) d'un document XML avec JavaScript. Trois méthodes sont testées :
Retourne :
true si le navigateur accepte le XML, false sinon.

chargerFichierXML

booléen chargerFichierXML(chaîne url)
Charge en mémoire le fichier XML d'URL spécifiée. L'URL du document XML peut être relative ou absolue.
Paramètres :
url - l'URL (absolue ou relative) du fichier XML à charger en mémoire.
Retourne :
true si le chargement a été réalisé, false sinon.

compterNoeuds

entier compterNoeuds(chaîne nomNoeud)
Compte le nombre de noeuds XML de nom spécifié. Retourne 0 si aucun noeud ne correspond au nom spécifié.
Paramètres :
nomNoeud - le nom du noeud XML dont on veut compter le nombre d'occurences.
Retourne :
le nombre de noeuds XML de nom spécifié dans le document XML.

obtenirCommentaires

chaîne obtenirCommentaires()
Retourne les commentaires du document XML. Concatène l'ensemble des commentaires du document XML (délimités par <!-- et -->) et retourne la chaîne résultat. Retourne une chaîne vide si aucun commentaire n'est trouvé.
Retourne :
une chaîne contenant les commentaires du document XML.

obtenirNoeud

objet obtenirNoeud(chaîne nomNoeud, chaîne valeurNoeud)
Retourne une référence sur le premier noeud XML du document dont le nom et la valeur sont identiques à ceux spécifiés. Si valeurNoeud n'est pas spécifié, retourne une référence sur le premier noeud XML du document dont le nom est identique à celui spécifié.
Paramètres :
nomNoeud - le nom du noeud XML que l'on veut obtenir.
valeurNoeud - la valeur du noeud XML que l'on veut obtenir.
Retourne :
une référence sur le premier noeud XML correspondant.

obtenirNoeudFils

objet obtenirNoeudFils(objet noeud, chaîne nomFils)
Retourne une référence sur le premier noeud fils du noeud XML passé en paramètre dont le nom est identique à celui spécifié.
Paramètres :
noeud - le noeud père du noeud XML que l'on veut obtenir.
nomFils - le nom du noeud XML fils que l'on veut obtenir.
Retourne :
une référence sur le premier noeud XML correspondant.

obtenirNoeudPere

objet obtenirNoeudPere(objet noeud)
Retourne une référence sur le noeud père du noeud XML passé en paramètre.
Paramètres :
noeud - un noeud fils du noeud XML que l'on veut obtenir.
Retourne :
une référence sur le premier noeud XML correspondant.

obtenirNoeudRacine

objet obtenirNoeudRacine()
Retourne une référence sur le noeud XML racine du document XML.
Retourne :
une référence sur le noeud XML racine du document XML.

obtenirNomNoeud

chaîne obtenirNomNoeud(objet noeud)
Retourne le nom du noeud XML passé en paramètre. Si le noeud XML n'existe pas, retourne une chaîne vide.
Paramètres :
noeud - le noeud XML dont on veut obtenir le nom.
Retourne :
une chaîne contenant le nom du noeud XML.

obtenirValeurAttribut

chaîne obtenirValeurAttribut(objet noeud, chaîne attribut)
Retourne la valeur de l'attribut spécifié du noeud XML passé en paramètre. Si le noeud XML n'existe pas, retourne une chaîne vide. Si l'attribut n'existe pas, retourne une chaîne vide.
Paramètres :
noeud - le noeud XML concerné.
attribut - le nom de l'attribut dont on veut obtenir la valeur.
Retourne :
une chaîne contenant la valeur de l'attribut spécifié.

obtenirValeurNoeud

chaîne obtenirValeurNoeud(objet noeud)
Retourne la valeur du noeud XML passé en paramètre. Si le noeud XML n'existe pas, retourne une chaîne vide.
Paramètres :
noeud - le noeud XML dont on veut obtenir la valeur.
Retourne :
une chaîne contenant la valeur du noeud XML.

rechercherNoeud

objet rechercherNoeud(chaîne nomNoeud, chaîne valeurNoeud)
Recherche le premier noeud XML du document dont le nom est identique à celui spécifié, et dont la valeur contient la chaîne specifiée. La fonction ne tient pas compte de la casse pour réaliser la recherche. Si valeurNoeud n'est pas spécifié, recherche le premier noeud XML correspondant dont la valeur est vide.
Paramètres :
nomNoeud - le nom du noeud XML recherché.
valeurNoeud - la valeur du noeud XML recherché.
Retourne :
une référence sur le premier noeud XML résultat de la recherche.

rechercherNoeudParAttribut

objet rechercherNoeudParAttribut(chaîne nomNoeud, chaîne attribut, chaîne valeurAttribut)
Recherche le premier noeud XML du document dont le nom est identique à celui spécifié, et dont l'attribut spécifié contient la chaîne spécifiée. La fonction ne tient pas compte de la casse pour réaliser la recherche. Si valeurAttribut n'est pas spécifié, recherche le premier noeud XML correspondant dont l'attribut spécifié a une valeur vide.
Paramètres :
nomNoeud - le nom du noeud XML recherché.
attribut - le nom de l'attribut objet de la recherche.
valeurAttribut - la valeur de l'attribut objet de la recherche.
Retourne :
une référence sur le premier noeud XML résultat de la recherche.

verifierChargementXML

booléen verifierChargementXML()
Vérifie que le fichier XML est totalement chargé en mémoire. Permet de s'assurer qu'un fichier XML volumineux est intégralement chargé, avant d'accéder aux données qu'il contient.
Retourne :
true si le fichier XML est totalement chargé en mémoire, false sinon.

JsLib 1.4

Erreurs, critiques, améliorations, questions : écrivez à l'auteur.
 
JsLib version 1.4 - bibliothèque JavaScript distribuée sous licence GNU LGPL
Auteur : Etienne CHEVILLARD
Mise à jour : 12/12/2007