Toolkit Dojo - fonctionnalités ajoutées par IBM

Bibliothèque, magasin de données et widgets Atom

Référence concernant la bibliothèque Atom :

Globalement, la bibliothèque Atom est divisée en trois catégories : les fonctions d'utilitaires, le modèle de données Atom et l'objet AtomIO.


Fonction d'utilitaire
Résumé des fonctions
String (chaîne) createDate(DOMNode node)
Permet de créer une date à partir du contenu du texte de noeud d'un DOM
String (chaîne) escapeHtml(String str)
Permet d'encoder les caractères spéciaux XML dans une chaîne HTML
String (chaîne) unEscapeHtml(String str)
Permet de décoder les caractères spéciaux XML dans une chaîne HTML
Date getIso8601Date(String iso8601String)
Permet de convertir une chaîne de date ISO-8610 en objet de date
String (chaîne) dateToIso8601String(Date date, String offset)
Permet de convertir un objet de date en une chaîne ISO-8610
String (chaîne) getNodename(DOMNode node)
Permet d'obtenir le nom d'un noeud

Détails des fonctions
createDate

escapeHtml

unEscapeHtml

getIso8601Date

dateToIso8601String

getNodename

Modèle de données Atom

Pour une référence à n'importe quel élément Atom, cliquez ici pour consulter les spécifications Atom.

Présentation des composants
ibm_atom.io.atom.AtomItem Elément Atom générique. Classe de base pour les entrées et les flux.
ibm_atom.io.atom.Category Elément de catégorie Atom
ibm_atom.io.atom.Content Elément de contenu Atom. Gère plusieurs types (text, html, etc.) selon les spécifications Atom. Utilisé pour le contenu, les résumés et les titres.
ibm_atom.io.atom.Link Elément de lien Atom. Gère plusieurs types de liens (édit, alt, etc.)
ibm_atom.io.atom.Person Elément de personne Atom. Utilisé pour représenter les auteurs et les contributeurs.
ibm_atom.io.atom.Generator Elément générateur Atom
ibm_atom.io.atom.Entry Elément d'entrée Atom. Représente une entrée Atom, comprenant les auteurs, les contributeurs, les titres le contenu, etc.
ibm_atom.io.atom.Feed Elément de flux Atom. Représente un flux Atom, notamment les éléments de flux tels que le titre et l'auteur, ainsi que la liste des entrées.
ibm_atom.io.atom.Service Elément de service Atom
ibm_atom.io.atom.Workspace Elément d'espace de travail Atom
ibm_atom.io.atom.Collection Elément de collection Atom

Détails du composant
ibm_atom.io.atom.AtomItem

Généralement non utilisée de manière indépendante, la classe AtomItem représente la classe de base pour les objets de flux et d'entrée Atom, car ces derniers partagent certains composants communs (titre, sous-titre, icône, tableaux des auteurs, contributeurs et liens).

Variables d'objets
String (chaîne) ATOM_URI URI de l'espace de nom Atom
Array links Héberge plusieurs objets ibm_atom.io.atom.Link des liens associés à cet élément Atom
Array authors Héberge les objets ibm_atom.io.atom.Person des auteurs
Array categories Héberge les objets ibm_atom.io.atom.Category associés avec cet élément Atom
Array contributors Héberge les objets ibm_atom.io.atom.Person des contributeurs
String (chaîne) icon URL de l'icône de cet élément
String (chaîne) id ID de cet élément
String (chaîne) logo URL pour le logo de cet élément
String (chaîne) rights Droits associés à cet élément Atom
ibm_atom.io.atom.Content title Titre de cet élément
ibm_atom.io.atom.Content subtitle Sous-titre de cet élément
Date updated Date de mise à jour de cet élément
ibm_atom.io.atom.Content content Contenu de cet élément
Array entrées Tableau des objets ibm_atom.io.atom.Entry de cet élément

Fonctions d'objets
Booléen accept(String tag)
Vérifie si cet élément accepte le nom de balise donné. Remplacé par les classes enfant
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
void buildFromDom(DOMNode node)
Permet de générer cet élément AtomItem à partir d'un noeud DOMNode donné.
void addAuthor(String name, String email, String uri)
Ajoute un auteur à cet élément avec les informations données
void addContributor(String name, String email, String uri)
Ajoute un contributeur à cet élément à l'aide des informations données
void addCategory(String name, String term, String label)
Ajoute une catégorie à cet élément avec les informations données
void addLink(String href, String rel, String hrefLang, String title, String type)
Ajoute un lien à cet élément avec les attributs donnés
Nombre removeLink(String href, String rel)
Supprime le lien donné de cet élément et renvoie le nombre de liens supprimés
Nombre removeBasicLinks()
Supprime tous les liens basiques (liens sans attribut REL) de cet élément et renvoie le nombre de liens supprimés
Array getCategories(String scheme)
Acquiert toutes les catégories correspondant au schéma donné de cet élément et les renvoie dans un tableau
Nombre removeCategories(String scheme, String term)
Supprime toutes les catégories correspondant au schéma donné et renvoie le nombre de catégories supprimées.
void setTitle(String str, String type)
Définit le titre de cet élément dans la chaîne donné avec le type donné.
void addExtension(String name_space, String name, Array attributes, String content, String shortNS)
Ajoute un espace de nom d'extension de l'élément.
Array getExtensions(String name_space, String name)
Acquiert toutes les extensions correspondant à l'name_space et au nom donnés, puis renvoie ces extensions dans un tableau. name_space peut être l'espace de nom complet (tel que "http://www.w3.org/2005/Atom") ou le nom abrégé donné (tel que "atom")
void removeExtensions(String name_space, String name)
Supprime toutes les extensions correspondant à l'name_space et au nom donnés
void destroy()
Supprime toutes les variables associées à cet élément
ibm_atom.io.atom.Category

Cet objet représente l'élément Catégorie des spécifications Atom. Les entrées et les flux peuvent chacun posséder des éléments de catégorie pour véhiculer des informations les concernant.

Variables d'objets
String (chaîne) scheme Schéma de cette catégorie
String (chaîne) term Terme de cette catégorie
String (chaîne) label Etiquette de cette catégorie

Fonctions d'objets
Booléen accept(String tag)
Renvoie toujours false, car les catégories ne possèdent pas d'éléments enfant.
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML
void buildFromDom(DOMNode node)
Crée cette catégorie à partir du noeud XML donné
ibm_atom.io.atom.Content

Cet objet modélise un objet de contenu générique, utilisé dans les spécifications Atom en tant que titres, sous-titres, contenu et résumé. En plus de sa valeur, un objet de contenu peut contenir divers types.

Variables d'objets
String (chaîne) tagName Nom de cet élément, tel que le contenu, le résumé, etc.
String (chaîne) valeur Valeur de cet élément
String (chaîne) src URL contenant la valeur de cet élément
String (chaîne) type Type de contenu stocké dans cet élément. Les valeurs acceptables sont répertoriées ci-après.
String (chaîne) xmlLang Langage du contenu. Ce langage est inclus dans la sortie si cet élément est placé dans une chaîne.
String (chaîne) HTML Chaîne représentant le type HTML
String (chaîne) TEXT Chaîne représentant le type text
String (chaîne) XHTML Chaîne représentant le type XHTML
String (chaîne) XML Chaîne représentant le type XML

Fonctions d'objets
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
void buildFromDom(DOMNode node)
Génère l'objet de contenu à partir d'un noeud DOMNode donné.
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML.
ibm_atom.io.atom.Link

Cet objet représente l'élément de lien Atom.

Variables d'objets
String (chaîne) href URL de ce lien
String (chaîne) hrefLang Attribut hrefLang
String (chaîne) rel Attribut REL, décrivant la relation de ce lien avec l'élément parent
String (chaîne) title Titre de ce lien
String (chaîne) type Type de lien

Fonctions d'objets
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
void buildFromDom(DOMNode node)
Génère cet objet de lien à partir d'un noeud DOMNode donné
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML
ibm_atom.io.atom.Person

Cet objet représente un objet de personne, utilisé pour les types d'auteur et de contributeur dans les spécifications Atom. Un objet de personne peut avoir un nom, une adresse électronique et/ou un URI.

Variables d'objets
String (chaîne) personType Type de personne représenté par cet objet, typiquement l'auteur ou le contributeur.
String (chaîne) name Nom de l'objet de personne
String (chaîne) email Adresse électronique de cette personne
String (chaîne) uri URI de cette personne

Fonctions d'objets
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
void buildFromDom(DOMNode node)
Génère cet objet de personne à partir d'un noeud DOMNode donné
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML
Booléen accept(String tag)
Retourne un message indiquant si cet élément accepte le nom de balise donné ; remplacé par les classes enfant
ibm_atom.io.atom.Generator

Cet élément Atom véhicule des informations sur le package qui a généré ce flux Atom. Un générateur peut posséder un URI et un numéro de version, en plus du nom lisible par l'utilisateur.

Variables d'objets
String (chaîne) uri URI de ce générateur
String (chaîne) version Numéro de version de ce générateur
String (chaîne) valeur Nom de ce générateur lisible par l'utilisateur

Fonctions d'objets
void _postBuild()
La fonction s'exécute après que buildFromDom soit terminé. Si nécessaire, les objets enfant peuvent remplacer cette fonction pour ajouter une fonctionnalité à la fin de la construction.
void buildFromDom(DOMNode node)
Génère cet objet de générateur à partir d'un noeud DOMNode donné.
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML.
ibm_atom.io.atom.Entry

Elément entrée Atom, cet objet développe ibm_atom.io.atom.AtomItem. Pour trouver les variables et fonctions héritées appropriées, cliquez ici.

Variables d'objets
String (chaîne) feedUrl URL du flux Atom propriétaire de cette entrée

Fonctions d'objets
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML
Booléen accept(String tag)
Retourne un message indiquant si cet élément accepte le nom de balise donné ; remplacé par les classes enfant
String (chaîne) getEditHref()
Détecte l'URL destinataire des informations sur les entrées mises à jour à l'aide du protocole de publication de documents Atom (APP, Atom Publishing Protocol)
ibm_atom.io.atom.Feed

Elément du flux Atom, cet objet développe ibm_atom.io.atom.AtomItem. Pour trouver les variables et fonctions héritées appropriées, cliquez ici.

Fonctions d'objets
String (chaîne) toString()
Renvoie une chaîne représentant cette catégorie au format XML
Booléen accept(String tag)
Retourne un message indiquant si cet élément accepte le nom de balise donné ; remplacé par les classes enfant
void addNamespace(String fullName, String shortName)
Permet d'ajouter l'espace de nom donné à ce flux
void addEntry(ibm_atom.io.atom.Entry Entry)
Permet d'ajouter une entrée dans la représentation d'objet du flux Atom. Cette fonction n'envoie pas de données au serveur.
ibm_atom.io.atom.Entry getFirstEntry()
Permet d'extraire la première entrée du flux Atom
ibm_atom.io.atom.Entry getEntry(String entryId)
Permet d'extraire l'entrée identifiée par la chaîne ID donnée
Nombre removeEntry(ibm_atom.io.atom.Entry entry)
Supprime l'entrée donnée du flux, affichant le nombre d'entrées supprimées
void setEntries(Array arrayOfEntry)
Permet d'ajouter les entrées du tableau donné dans le flux Atom
ibm_atom.io.atom.Entry createEntry()
Crée un nouvel objet d'entrée vide, définit sa variable feedUrl et renvoie l'objet d'entrée
String (chaîne) getSelfHref()
Obtient l'URL de ce flux Atom ou renvoie une valeur null si le flux n'inclut pas l'objet de lien approprié
ibm_atom.io.atom.Service

Un document de service Atom décrit les services fournis par un serveur implémentant l'APP. Cet objet représente ce type de document.

Variables d'objets
String (chaîne) href URL du document de service

Fonctions d'objets
void buildFromDom(DOMNode node)
Permet de générer ce document de service à partir d'un noeud DOMNode donné
Array getCollection(String url)
Permet d'extraire un tableau de toutes les collections identifiées par l'URL donnée
ibm_atom.io.atom.Workspace

Un élément d'espace de travail Atom constitue le composant du document de service Atom, selon la définition dans les spécifications APP et il sert l'organisation dans le document de service.

Variables d'objets
String (chaîne) title Titre de l'espace de travail
Array collections Collections hébergées par cet espace de travail

Fonctions d'objets
void buildFromDom(DOMNode node)
Permet de générer cet objet d'espace de travail à partir d'un noeud DOMNode donné
ibm_atom.io.atom.Collection

Une collection Atom décrit un ensemble de ressources, accessibles à partir d'une URL identifiée par un titre.

Variables d'objets
String (chaîne) href URL pour cette collection
String (chaîne) title Titre de cette collection
Array attributs Attributs de cette collection
Array features Fonctions de cette collection
Array children Enfants de cette collection ; par exemple, les éléments <accept> ou <category>
String (chaîne) memberType Type de membre de cette collection
String (chaîne) id Chaîne ID de cette collection

Fonctions d'objets
void buildFromDom(DOMNode node)
Génère cet objet de collection à partir d'un noeud DOMNode donné

Objet AtomIO

L'objet AtomIO est destiné à fournir une interface facilement accessible aux développeurs interfaçant avec l'implémentation du serveur de flux Atom ou d'APP. Cet objet ne maintient pas un objet Flux ou des variables internes entre les appels. Si un développeur essaie de maintenir une représentation locale d'un flux (reportez-vous à la section flux ci-dessus) synchronisé avec la copie du serveur, cette action est de sa responsabilité.

Variables d'objets
Booléen sync Si les demandes de cet objet AtomIO sont forcées à être synchrones
Booléen useCache Si la mise en cache doit être desactivée (dans les demandes XHR)
Booléen alertsEnabled S'il faut afficher les champs d'avertissement concernant les erreurs ES ou s'il faut que la machine soit commutée en mode silencieux

Fonctions d'objets
void getFeed(String url, Function callback, Function errorCallback, Object scope)
Permet d'extraire un flux Atom spécifique à partir de l'URL donnée
void getService(String url, Function callback, Function errorCallback, Object scope)
Permet d'extraire un document de service ou d'introspection à partir de l'URL donnée
void getEntry(String url, Function callback, Function errorCallback, Object scope)
Permet d'extraire un document d'entrée Atom à partir de l'URL donnée
void updateEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean retrieveUpdated, Boolean xmethod, Object scope)
Permet de mettre à jour l'entrée distante à l'aide de l'entrée donnée, adaptant la demande en fonction des paramètres donnés
void addEntry(ibm_atom.io.atom.Entry entry, String url, Function callback, Function errorCallback, Boolean retrieveUpdated, Object scope)
Permet d'ajouter une nouvelle entrée à l'URL de collection donnée, en fonction des paramètres donnés
void deleteEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean xmethod, Object scope)
Permet de supprimer l'entrée Atom spécifiée de sa collection

Détails des fonctions
getFeed

getService

getEntry

updateEntry

addEntry

deleteEntry