IBM Erweiterungen zum Dojo Toolkit

ATOM-Bibliothek, Datenspeicher und Fensterobjekte

Referenzinformationen zur ATOM-Bibliothek:

Die ATOM-Bibliothek ist im Wesentlichen in drei Kategorien gegliedert: Dienstprogrammfunktionen, das ATOM-Datenmodell und das AtomIO-Objekt.


Dienstprogrammfunktionen
Zusammenfassung der Funktionen
String createDate(DOMNode node)
Erstellt aus dem Knotentextinhalt eines DOM ein Datum
String escapeHtml(String str)
Wandelt XML-Sonderzeichen in einer HTML-Zeichenfolge um
String unEscapeHtml(String str)
Macht die Umwandlung von XML-Sonderzeichen in einer HTML-Zeichenfolge rückgängig
Date getIso8601Date(String iso8601String)
Konvertiert eine ISO-8610-Datumszeichenfolge in ein Datumsobjekt
String dateToIso8601String(Date date, String offset)
Konvertiert ein Datumsobjekt in eine ISO-8610-Zeichenfolge
String getNodename(DOMNode node)
Ruft einen Knotennamen ab

Funktionsdetails
createDate

escapeHtml

unEscapeHtml

getIso8601Date

dateToIso8601String

getNodename

ATOM-Datenmodell

Referenzinformationen zu den einzelnen ATOM-Elementen enthält die ATOM-Spezifikation, die Sie hier finden.

Komponentenübersicht
ibm_atom.io.atom.AtomItem Generisches ATOM-Element, Basisklasse für Eintrag und Feed
ibm_atom.io.atom.Category ATOM-Kategorieelement
ibm_atom.io.atom.Content ATOM-Inhaltselement, das gemäß ATOM-Spezifikation mehrere Inhaltstypen (Text, HTML usw.) handhaben kann. Wird für Inhalte, Zusammenfassungen und Titel verwendet.
ibm_atom.io.atom.Link ATOM-Link-Element. Kann mehrere Link-Typen (Edit, Alt usw.) handhaben.
ibm_atom.io.atom.Person ATOM-Personenelement. Wird für die Darstellung von Autoren und Mitwirkenden verwendet.
ibm_atom.io.atom.Generator ATOM-Generatorelement
ibm_atom.io.atom.Entry ATOM-Eintragselement. Repräsentiert einen ATOM-Eintrag, in dem auch die Autoren, die Mitwirkenden, der Titel, der Inhalt usw. gespeichert sind.
ibm_atom.io.atom.Feed ATOM-Feed-Element. Repräsentiert einen ATOM-Feed mit den zugehörigen Feed-Elementen wie title und author sowie der Liste der Einträge
ibm_atom.io.atom.Service ATOM-Serviceelement
ibm_atom.io.atom.Workspace ATOM-Arbeitsbereichselement
ibm_atom.io.atom.Collection ATOM-Datensammlungselement

Komponentendetails
ibm_atom.io.atom.AtomItem

Die Klasse AtomItem wird in der Regel nicht unabhängig verwendet und ist die Basisklasse für ATOM-Feed-Objekte und -Eintragsobjekte, die einige Komponenten gemeinsam haben (Titel, Untertitel, Symbol, Autoren-Arrays, Mitwirkende und Links).

Objektvariablen
String ATOM_URI Der URI des ATOM-Namespace
Array links Enthält mehrere ibm_atom.io.atom.Link-Objekte für die Links, die diesem ATOM-Element zugeordnet sind
Array authors Enthält die ibm_atom.io.atom.Person-Objekte für die Autoren
Array categories Enthält die ibm_atom.io.atom.Category-Objekte, die diesem ATOM-Element zugeordnet sind
Array contributors Enthält die ibm_atom.io.atom.Person-Objekte für die Mitwirkenden
String icon Der URL des Symbols für dieses Element
String id Die ID dieses Elements
String logo Der URL des Logos für dieses Element
String rights Die mit diesem ATOM-Element verbundenen Rechte
ibm_atom.io.atom.Content title Der Titel dieses Elements
ibm_atom.io.atom.Content subtitle Der Untertitel dieses Elements
Date updated Das Datum der Aktualisierung dieses Elements
ibm_atom.io.atom.Content content Der Inhalt dieses Elements
Array entries Array mit ibm_atom.io.atom.Entry-Objekten für dieses Element

Objektfunktionen
Boolean accept(String tag)
Gibt zurück, ob dieses Element den angegebenen Tag-Namen akzeptiert. Wird durch Unterklassen außer Kraft gesetzt.
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
void buildFromDom(DOMNode node)
Erstellt dieses AtomItem aus einem gegebenen DOMNode
void addAuthor(String name, String email, String uri)
Fügt zu diesem Element einen Autor mit den gegebenen Informationen hinzu
void addContributor(String name, String email, String uri)
Fügt zu diesem Element einen Mitwirkenden mit den gegebenen Informationen hinzu
void addCategory(String name, String term, String label)
Fügt zu diesem Element eine Kategorie mit den gegebenen Informationen hinzu
void addLink(String href, String rel, String hrefLang, String title, String type)
Fügt zu diesem Element einen Link mit den gegebenen Attributen hinzu
Number removeLink(String href, String rel)
Entfernt den angegebenen Link aus diesem Element und gibt die Anzahl der entfernten Links zurück
Number removeBasicLinks()
Entfernt alle Basis-Links (ohne Attribut rel) aus diesem Element und gibt die Anzahl der entfernten Links zurück
Array getCategories(String scheme)
Ruft alle Kategorien ab, die mit dem gegebenen Schema für dieses Element übereinstimmen, und gibt sie in einem Array zurück
Number removeCategories(String scheme, String term)
Entfernt alle Kategorien, die mit dem gegebenen Schema übereinstimmen, und gibt die Anzahl der entfernten Kategorien zurück
void setTitle(String str, String type)
Setzt den Titel dieses Elements auf die gegebene Zeichenfolge (str) mit dem angegebenen Typ
void addExtension(String name_space, String name, Array attributes, String content, String shortNS)
Fügt einen Erweiterungs-Namespace zum Element hinzu
Array getExtensions(String name_space, String name)
Ruft alle Erweiterungen ab, die mit dem gegebenen Namespace (name_space) und Namen (name) übereinstimmen und gibt diese in einem Array zurück. Die Angabe name_space kann ein vollständiger Namespace sein (wie 'http://www.w3.org/2005/Atom') oder ein Kurzname (wie 'atom').
void removeExtensions(String name_space, String name)
Entfernt alle Erweiterungen, die mit dem gegebenen Namespace (name_space) und Namen (name) übereinstimmen
void destroy()
Löscht alle diesem Element zugeordneten Variablen
ibm_atom.io.atom.Category

Dieses Objekt repräsentiert das Element Category der ATOM-Spezifikation. Einträge und Feeds können Kategorieelemente mit Informationen zum Eintrag oder Feed enthalten.

Objektvariablen
String scheme Das Schema für diese Kategorie
String term Der Begriff für diese Kategorie
String label Die Bezeichnung für diese Kategorie

Objektfunktionen
Boolean accept(String tag)
Gibt immer false zurück, da Kategorien keine untergeordneten Elemente haben
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
void buildFromDom(DOMNode node)
Erstellt diese Kategorie aus dem gegebenen XML-Knoten
ibm_atom.io.atom.Content

Dieses Modellobjekt enthält generischen Inhalt und wird in der ATOM-Spezifikation für Titel, Untertitel, Inhalt und Zusammenfassung verwendet. Einem Inhaltsobjekt können neben seinem Wert mehrere Typen zugeordnet sein.

Objektvariablen
String tagName Der Name dieses Elements wie content (Inhalt), summary (Zusammenfassung) usw.
String value Der Wert dieses Elements
String src Der URL, der den Wert dieses Elements enthält
String type Der Typ des in diesem Element gespeicherten Inhalts. Gültige Werte sind nachfolgend aufgelistet.
String xmlLang Die Sprache des Inhalts. Diese Sprache ist in der Ausgabe enthalten, wenn das Element an eine Zeichenfolge gesendet wird.
String HTML Eine Zeichenfolge, die den Typ HTML repräsentiert
String TEXT Eine Zeichenfolge, die den Typ Text repräsentiert
String XHTML Eine Zeichenfolge, die den Typ XHTML repräsentiert
String XML Eine Zeichenfolge, die den Typ XML repräsentiert

Objektfunktionen
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
void buildFromDom(DOMNode node)
Erstellt dieses Inhaltsobjekt aus einem gegebenen DOMNode
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
ibm_atom.io.atom.Link

Dieses Objekt repräsentiert das ATOM-Link-Element.

Objektvariablen
String href Der URL für diesen Link
String hrefLang Das Attribut hrefLang
String rel Das Attribut rel, das die Beziehung dieses Links zum übergeordneten Element beschreibt
String title Der Titel dieses Links
String type Der Typ des Links

Objektfunktionen
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
void buildFromDom(DOMNode node)
Erstellt dieses Link-Objekt aus einem gegebenen DOMNode
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
ibm_atom.io.atom.Person

Dieses Objekt repräsentiert ein Personenobjekt, das für die Typen author und contributor der ATOM-Spezifikation verwendet wird. Ein Personenobjekt kann einen Namen, eine E-Mail-Adresse und/oder einen URI haben.

Objektvariablen
String personType Der von diesem Objekt repräsentierte Personentyp; in der Regel ein Autor (author) oder ein Mitwirkender (contributor)
String name Der Name dieses Personenobjekts
String email Die E-Mail-Adresse dieser Person
String uri Der URI dieser Person

Objektfunktionen
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
void buildFromDom(DOMNode node)
Erstellt dieses Personenobjekt aus einem gegebenen DOMNode
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
Boolean accept(String tag)
Gibt zurück, ob dieses Element den angegebenen Tag-Namen akzeptiert
ibm_atom.io.atom.Generator

Dieses ATOM-Element enthält Informationen zu dem Paket, das diesen ATOM-Feed generiert hat. Ein Generator kann neben seinem lesbaren Namen einen URI und eine Versionsnummer haben.

Objektvariablen
String uri Der URI für diesen Generator
String version Die Versionsnummer für diesen Generator
String value Der lesbare Name dieses Generators

Objektfunktionen
void _postBuild()
Funktion, die nach Abschluss von buildFromDom ausgeführt wird. Untergeordnete Objekte können diese Funktion ggf. außer Kraft setzen, um nach Abschluss des Builds Funktionalität hinzuzufügen.
void buildFromDom(DOMNode node)
Erstellt dieses Generatorobjekt aus einem gegebenen DOMNode
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
ibm_atom.io.atom.Entry

Dieses Objekt repräsentiert das ATOM-Element entry und erweitert ibm_atom.io.atom.AtomItem. Die entsprechenden übernommenen Variablen und Funktionen finden Sie hier.

Objektvariablen
String feedUrl Der URL des ATOM-Feeds, der Eigner dieses Eintrags ist

Objektfunktionen
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
Boolean accept(String tag)
Gibt zurück, ob dieses Element den angegebenen Tag-Namen akzeptiert
String getEditHref()
Ermittelt den URL, an den über das ATOM Publishing Protocol aktualisierte Eintragsinformationen gesendet werden sollen
ibm_atom.io.atom.Feed

Dieses Objekt repräsentiert das ATOM-Element feed und erweitert ibm_atom.io.atom.AtomItem. Die entsprechenden übernommenen Variablen und Funktionen finden Sie hier.

Objektfunktionen
String toString()
Gibt eine Zeichenfolge zurück, die diese Kategorie als XML repräsentiert
Boolean accept(String tag)
Gibt zurück, ob dieses Element den angegebenen Tag-Namen akzeptiert
void addNamespace(String fullName, String shortName)
Fügt den angegebenen Namespace zu diesem Feed hinzu
void addEntry(ibm_atom.io.atom.Entry Entry)
Fügt den gegebenen Eintrag zu dieser Objektdarstellung des ATOM-Feed hinzu. Diese Funktion sendet keine Daten an den Server.
ibm_atom.io.atom.Entry getFirstEntry()
Ruft den ersten Eintrag dieses ATOM-Feed ab
ibm_atom.io.atom.Entry getEntry(String entryId)
Ruft den von der gegebenen ID-Zeichenfolge bezeichneten Eintrag ab
Number removeEntry(ibm_atom.io.atom.Entry entry)
Entfernt den gegebenen Eintrag aus dem Feed und gibt die Anzahl der entfernten Einträge zurück
void setEntries(Array arrayOfEntry)
Fügt die im gegebenen Array enthaltenen Einträge zu diesem ATOM-Feed hinzu
ibm_atom.io.atom.Entry createEntry()
Erstellt ein neues leeres Eintragsobjekt, legt die Variable feedUrl fest und gibt das Eintragsobjekt zurück
String getSelfHref()
Ruft den URL dieses ATOM-Feed ab oder gibt einen Nullwert zurück, wenn der Feed nicht das entsprechende Link-Objekt enthält
ibm_atom.io.atom.Service

Ein ATOM-Servicedokument beschreibt die Services, die ein Server mit Implementierung des ATOM Publishing Protocol anbietet. Dieses Objekt repräsentiert den Typ des Dokuments.

Objektvariablen
String href Der URL für das Servicedokument

Objektfunktionen
void buildFromDom(DOMNode node)
Erstellt dieses Servicedokument aus einem gegebenen DOMNode
Array getCollection(String url)
Ruft ein Array mit allen Datensammlungen ab, die vom gegebenen URL bezeichnet werden
ibm_atom.io.atom.Workspace

Ein ATOM-Element workspace ist laut APP-Spezifikation Teil eines ATOM-Servicedokuments und dient der Organisation des Servicedokuments.

Objektvariablen
String title Der Titel dieses Arbeitsbereichs
Array collections Die Datensammlungen in diesem Arbeitsbereich

Objektfunktionen
void buildFromDom(DOMNode node)
Erstellt dieses Arbeitsbereichsobjekt aus einem gegebenen DOMNode
ibm_atom.io.atom.Collection

Eine ATOM-Collection beschreibt eine Gruppe von Ressourcen, auf die unter einem gegebenen URL zugegriffen werden kann und die über einen Titel identifiziert werden können.

Objektvariablen
String href Der URL dieser Datensammlung
String title Der Titel dieser Datensammlung
Array attributes Die Attribute dieser Datensammlung
Array features Die Features dieser Datensammlung
Array children Die untergeordneten Elemente dieser Datensammlung, z. B. die Elemente <accept> und <category>
String memberType Der Member-Typ dieser Datensammlung
String id Die ID-Zeichenfolge dieser Datensammlung

Objektfunktionen
void buildFromDom(DOMNode node)
Erstellt dieses Collection-Objekt aus einem gegebenen DOMNode

AtomIO-Objekt

Das AtomIO-Objekt ist für Entwickler als erste komfortable Schnittstelle zu einer ATOM-Feed-Implementierung oder einer APP-Implementierung gedacht. Dieses Objekt verwaltet kein Feed-Objekt und keine internen Variablen zwischen Aufrufen. Entwickler, die eine lokale Darstellung eines Feed (siehe Feed) mit der Serverkopie synchron halten möchten, müssen selbst nach geeigneten Wegen suchen.

Objektvariablen
Boolean sync Gibt an, ob Anforderungen von diesem AtomIO-Objekt synchron sein müssen
Boolean useCache Gibt an, ob das Caching (in den XHR-Anforderungen) inaktiviert werden soll
Boolean alertsEnabled Gibt an, ob bei E/A-Fehlern Warnfenster angezeigt oder Prozesse ohne Warnung beendet werden sollen

Objektfunktionen
void getFeed(String url, Function callback, Function errorCallback, Object scope)
Ruft einen bestimmten ATOM-Feed vom gegebenen URL ab
void getService(String url, Function callback, Function errorCallback, Object scope)
Ruft ein Servicedokument oder ein Introspektionsdokument vom gegebenen URL ab
void getEntry(String url, Function callback, Function errorCallback, Object scope)
Ruft ein bestimmtes Dokument mit ATOM-Einträgen vom gegebenen URL ab
void updateEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean retrieveUpdated, Boolean xmethod, Object scope)
Aktualisiert den fernen Eintrag anhand des gegebenen Eintrags und passt die Anforderung entsprechend den gegebenen Parametern an
void addEntry(ibm_atom.io.atom.Entry entry, String url, Function callback, Function errorCallback, Boolean retrieveUpdated, Object scope)
Fügt ausgehend von den gegebenen Parametern einen neuen Eintrag zum gegebenen Collection-URL hinzu
void deleteEntry(ibm_atom.io.atom.Entry entry, Function callback, Function errorCallback, Boolean xmethod, Object scope)
Löscht den angegebenen ATOM-Eintrag aus der Datensammlung

Funktionsdetails
getFeed

getService

getEntry

updateEntry

addEntry

deleteEntry