Framework JavaScript ACube V2.10.0
 

technique/fw_xml.js

Résumé

Ce fichier Javascript correspond au framework de gestion des flux XML. Cette description consiste à présenter les prototypes des fonctions, des exemples d'appel et les précisions techniques nécessaires à la mise en oeuvre de ce framework.
NOTA : Seuls les éléments XML sont concernés, les attributs XML ne sont pas gérés.
Le framework client XML propose les classes utilitaires suivantes :

Un certain nombre de méthodes et de propriétés sont communes aux trois classes et des notions de polymorphisme sont abordées pour que les classes XMLObjectCookie et XMLOjectSauvegarde bénéficient d'un code mutualisé présent dans la classe XMLObject.

Date: 30/05/2006

Version: 2.0

Auteur: Ministère des Affaires Etrangères, Aubay SA, Steve Péguet


Sommaire des Classes
XMLObject La classe «XMLObject» est la classe permettant de gérer un flux XML dans un DOM à partir d'une URL ou d'un emplacement sur disque.
XMLObjectSauvegarde La classe «XMLObjectSauvegarde» est la classe permettant de gérer en mémoire un flux XML dans un DOM, à partir de la création d'un DOM, ou de l'utilisation en entier ou en partie d'un autre DOM.
XMLObjectCookie La classe «XMLObjectCookie» est la classe permettant de gérer un flux XML dans un DOM à partir d'un cookie sur disque.

Sommaire des Fonctions Globales
static boolean ajoutElement(<p_XMLObject_ou_ObjectNodeList_Obligatoire> listeElements,<p_ObjectNodeList_ou_Node_Obligatoire> Element)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «ajoutElement(listeElements,Element)» permet d'ajouter un élément XML (objet Node ou NodeList) à une arborescence XML (objet DOM ou NodeList).
static boolean clonerElement(<ObjectNode_Obligatoire> nodeSource, <ObjectNode_Obligatoire> nodeCible)
           La fonction globale «clonerElement(nodeSource, DOMCible)» permet de copier nodeSource dans le noeud d'un DOM DOMCible.
static boolean convertDOMtoString(<p_XMLObject_ou_ObjectNodeList_ou_ObjectNode_Obligatoire> listeElements)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «convertDOMtoString(listeElements)» permet de sérialiser dans une chaîne de caractères toute arborescence DOM ou élément XML (objet DOM, NodeList ou Node).
static DOMElement convertStringToDOM(<String_Obligatoire> chaineXML)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «convertStringToDOM(chaineXML)» permet de désérialiser à partir d'une chaîne de caractères toute l'arborescence DOM d'un flux XML sérialisé.
Elle renvoie un objet de type DOMElement correspondant au flux XML sérialisé dans la chaine de caractères passée en paramètre.
static boolean copieElement(<p_ObjectNodeList_ou_ObjectNode_Obligatoire> ElementSource, <p_ObjectNodeList_ou_ObjectNode_Obligatoire> ElementDestination)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «copieElement(ElementSource, ElementDestination)» permet de copier le contenu d'un élément XML (objet Node ou NodeList) dans un autre élément XML.
static boolean echangeDataElement(<p_ObjectNode_Obligatoire> Element1,<p_ObjectNode_Obligatoire> Element2)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «echangeDataElement(Element1,Element2)» offre la possibilité d'échanger la valeur textuelle d'un élément XML (objet Node de NodeType à 1 ou 3) de contenu de type texte avec la valeur d'un autre élément XML (objet Node de NodeType à 1 ou 3) de contenu de type texte.
static boolean echangeElement(<p_XMLObject_ou_ObjectNodeList_Obligatoire> listeElements,<int_Obligatoire> item1,<int_Obligatoire> item2)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «echangeElement(listeElements,item1,item2)» offre la possibilité d'échanger deux élements XML (objet Node ou NodeList) de type textuel situés à même profondeur d'arborescence du DOM XML.
static private  String encodeParametres(<Object_Obligatoire> params)
           La fonction utilitaire «encodeParametres(params)» est à usage interne du framework pour envoyer des données sous la forme "VAR1=valeur1&VAR2=valeur2".
static Object encoderParametrePOST(params)
           Encode les paramètres donnés avec la fonction javascript encodeURIComponent.
static boolean estVide(<p_XMLObject_Obligatoire> listeElements)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «estVide(listeElements)» permet de vérifier qu'une arborescence d'un objet DOM XML n'est pas vide.
static boolean executerActionServeur(<String_Obligatoire> url, <Array_Facultatif> params, <function_Facultatif> fonctionActionReponseOk, <boolean_Obligatoire> async, <function_Facultatif> fonctionActionErreur)
           Lance une requête POST sur le serveur.
static Array getChildElements(<XMLObject_Obligatoire> node,<String_Facultatif> tagName)
           Le framework technique fw_xml.js propose la fonction globale «getChildElements(node,tagName)»; elle permet de récupérer la liste de tous les éléments enfants direct du noeud "node", et plus spécialement ceux portant le nom "tagName" (si tagName différent de null), sous la forme d'une collection d'éléments XML.
static boolean getData(<p_ObjectNode_Obligatoire> Element)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «getData(Element)» permet d'interroger un élément XML (Objet de type Node) présent dans un objet DOM dont le contenu est de type texte (NodeType valorisé à 1 ou à 3).
static boolean getDataElement(<p_NodeList_Obligatoire> Element, <String_Obligatoire> nom<p_NodeList_Obligatoire> Element)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «getDataElement(Element, nomElement)» permet d'interroger un élément XML présent dans un objet DOM dont le contenu est de type élément (objet NodeList) pour récupérer la valeur du texte d'un de ses éléments XML (objets Node avec un NodeType valorisé à 1 ou 3) à partir de son nom.
static boolean getDataElements(<p_ObjectNodeList_Obligatoire> listeElements,<String_Obligatoire> nomElement,<int_Obligatoire> item)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «getDataElements(listeElements,nomElement,item)» permet d'interroger un élément XML (objet NodeList) présent dans un objet DOM dont le contenu est de type élément (NodeType à 1) pour récupérer la valeur du texte d'un de ses éléments (objet Node) à partir de son nom et de sa position dans l'arborescence.
static Array_DOMElement getElements(<p_ObjectNodeList_Obligatoire> listeElements,<String_Obligatoire> nomElement)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «getElements(listeElements,nomElement)» renvoie l'ensemble des éléments XML (noeuds de l'arborescence) de même nom à partir d'une arborescence DOM donnée.
static String getTextElement(<Element_Obligatoire> element)
           La fonction globale «getTextElement(element)» permet d'accéder au contenu texte d'une balise xml.
static boolean modifieDataElement(<p_ObjectNode_Obligatoire> Element,<String_Obligatoire> valeur)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «modifieDataElement(Element,valeur)» permet de modifier la valeur d'un élément XML (objet Node) de contenu de type texte avec une valeur passée en paramètre.
static void QuickSort(<p_XMLObject_Obligatoire> xml,<String_Obligatoire> nomDonnee,<int_Facultatif> first,<int_Facultatif> last,<boolean_Obligatoire> ordre,<String_Optionnel> type)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «QuickSort(xml, nomDonnee, first, last, ordre, type)» permet de trier un flux XML à partir d'un critère donné.
static void QuickSortInitialise(<String_Obligatoire> donnee,<String_Obligatoire> type,array)
           Le framework technique fw_xml.js propose la fonction globale «QuickSortInitialise(donnee,type,array)»; elle permet de préparer le tri d'un tableau Array selon un critére donné.
static void QuickSortMulti(<p_XMLObject_Obligatoire> xml,<Array_Obligatoire> listeDonnee,<Array_Obligatoire> listeType,<Array_Obligatoire> listeOrdre,<int_Facultatif> first,<int_Facultatif> last)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «QuickSortMulti(xml, listeDonnee, listeOrdre, listeType, first, last)» permet de trier un flux XML à partir de n critéres.
static Array_Obligatoire QuickSortRecursif(<Array_Obligatoire> listeDonnee,<Array_Obligatoire> listeType,<Array_Obligatoire> listeOrdre,<Array_Obligatoire> array)
           Le framework technique fw_xml.js propose la fonction globale «QuickSortRecursif(listeDonnee,listeType,listeOrdre,array)»; elle permet de gérer le tri d'un tableau Array selon plusieurs critéres.
static void QuickSortTableau(<Function_Obligatoire> getCritere,array)
           Le framework technique fw_xml.js propose la fonction globale «QuickSortTableau(getCritere,array)»; elle permet de trier le tableau Array selon l'ordre défini par getCritere.
static private  String remplacementParamErreur(<String_Obligatoire> texte,<String_Optionnel> params)
           Le framework technique fw_xml.js propose la fonction utilitaire «remplacementParamErreur(texte,params))» pour gérer les messages d'erreurs paramétrés.
static boolean suppressionElement(<ObjectNode_Obligatoire> listeElements,<int_Obligatoire> item)
           Fonction de la boîte à outils du framework client XML fw_xml.js; «suppressionElement(listeElements,item)» permet de supprimer un élément XML (objet Node ou NodeList) d'une arborescence DOM (objet DOM ou NodeList) en lui passant la position d'arborescence de l'élément à supprimer.
static private  function testReady(<XMLObject_Obligatoire> XMLDOM)
           La fonction utilitaire «testReady(XMLDOM)» est à usage interne du framework lors d'un rapatriement de flux XML en asynchrone.
static private  void testStateChange2(<XMLObject_Obligatoire> XMLDOM)
           La fonction utilitaire «testStateChange2(XMLDOM)» est à usage interne du framework.
static void XMLObject_constructor()
           Le framework technique fw_xml.js propose la fonction «XMLObject_constructor()»; elle permet la configuration des éléments de l'objet XMLObject lors de son instanciation.
static void XMLObjectCookie_constructor()
           Le framework technique fw_xml.js propose la fonction «XMLObjectCookie_constructor()»; elle permet la configuration des éléments de l'objet XMLObjectCookie lors de son instanciation.
static void XMLObjectSauvegarde_constructor()
           Le framework technique fw_xml.js propose la fonction «XMLObjectSauvegarde_constructor()»; elle permet la configuration des éléments de l'objet de gestion d'un DOM XMLObjectSauvegarde lors de son instanciation.

Framework JavaScript ACube V2.10.0
 


Version 2.10.0, / Etat : Validé
Cette création est mise à disposition selon le Contrat Paternité - Pas d'Utilisation Commerciale - Partage des Conditions Initiales à l'Identique disponible en ligne http://creativecommons.org/licenses/by-nc-sa/2.0/fr/ ou par courrier postal à Creative Commons, 559 Nathan Abbott Way, Stanford,California 94305, USA.


Documentation generated by JSDoc on Wed Jan 6 17:05:02 2010