La libreria Atom è ampiamente suddivisa in tre categorie: funzioni di utilità, modello dati Atom e oggetto AtomIO.
Riepilogo funzioni | |
---|---|
Stringa | createDate(nodo DOMNode) Crea una data dal contenuto del testo del nodo di un DOM |
Stringa | escapeHtml(str String) Ignora i caratteri speciali XML in una stringa HTML |
Stringa | unEscapeHtml(str String) Non ignora i caratteri speciali XML in una stringa HTML |
Date | getIso8601Date(String iso8601String) Converte una stringa di data ISO-8610 in un oggetto di data |
Stringa | dateToIso8601String(dati Data, offset String) Converte un oggetto data in una stringa ISO-8610 |
Stringa | getNodename(nodo DOMNode) Acquisisce un nome nodo |
Dettagli della funzione |
---|
Per un riferimento a qualsiasi elemento Atom, consultare le specifiche Atom, sul sito here.
Panoramica dei componenti | |
---|---|
ibm_atom.io.atom.AtomItem | Elemento Atom generico. Classe base per Entry e Feed. |
ibm_atom.io.atom.Category | Elemento categoria Atom |
ibm_atom.io.atom.Content | Elemento di contenuto Atom. Gestisce tipi multipli (testo, html, ecc.) a seconda delle specifiche Atom. Utilizzato per contenuto, riepiloghi e titoli. |
ibm_atom.io.atom.Link | Elemento di collegamento Atom. Gestisce tipi di collegamento multipli (modifica, alt, ecc.) |
ibm_atom.io.atom.Person | Elemento di persona Atom. Utilizzato per rappresentare autori e sostenitori. |
ibm_atom.io.atom.Generator | Elemento di generazione Atom |
ibm_atom.io.atom.Entry | Elemento voce Atom. Rappresenta una voce Atom, inclusa l'archiviazione di autori, sostenitori, titolo, contenuto e così via. |
ibm_atom.io.atom.Feed | Elemento feed Atom. Rappresenta un feed Atom, inclusi gli elementi feed quali il titolo e l'autore e rappresenta anche l'elenco delle voci. |
ibm_atom.io.atom.Service | Elemento di servizio Atom |
ibm_atom.io.atom.Workspace | Elemento area di lavoro Atom |
ibm_atom.io.atom.Collection | Elemento di raccolta Atom |
Dettagli dei componenti |
---|
In genere non usata in modo indipendente, la classe AtomItem è la cassa di base per gli oggetti feed e voci Atom, dal momento che condividono alcune componenti comuni (titolo, sottotitolo, icona, matrici di autori, sostenitori e collegamenti).
Variabili di oggetti | ||
---|---|---|
Stringa | ATOM_URI | L'URI dello spazio nome Atom |
Array | Collegamenti | Ospita più oggetti ibm_atom.io.atom.Link dei collegamenti associati a questo elemento Atom |
Array | autori | Ospita gli oggetti ibm_atom.io.atom.Person per gli autori |
Array | categorie | Ospita gli oggetti ibm_atom.io.atom.Category associati a questo elemento Atom |
Array | sostenitori | Ospita gli oggetti ibm_atom.io.atom.Person dei sostenitori |
Stringa | icona | L'URL dell'icona per questo elemento |
Stringa | id | L'ID di questo elemento |
Stringa | logo | L'URL del logo per questo elemento |
Stringa | diritti | I diritti associati per questo elemento Atom |
ibm_atom.io.atom.Content | titolo | Il titolo di questo elemento |
ibm_atom.io.atom.Content | sottotitolo | Il sottotitolo di questo elermento |
Date | aggiornati | La data in cui questo elemento è stato aggiornato |
ibm_atom.io.atom.Content | contenuto | Il contenuto di questo elemento |
Array | voci | Matrice di oggetti ibm_atom.io.atom.Entry per questo elemento |
Funzioni degli oggetti | |
---|---|
Boolean | accept(String tag) Restituisce quando questo elemento accetta il nome tag specificato. Sovrascritto dalle classi secondarie |
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
void | buildFromDom(nodo DOMNode) Crea questo AtomItem da un DOMNode specificato. |
void | addAuthor(nome String, email String, uri String) Aggiunge un autore a questo elemento con le informazioni specificate |
void | addContributor(nome String, email String, uri String) Aggiunge un sostenitore a questo elemento con le informazioni specificate |
void | addCategory(nome String, termine String, etichetta String) Aggiunge una categoria a questo elemento con le informazioni specificate |
void | addLink(href String, rel String, hrefLang String, titolo String, tipo String) Aggiunge un collegamento agli attributi specificati per questo elemento |
Number | removeLink(href String, rel String) Rimuove il collegamento specificato da questo elemento, restituendo il numero dei collegamenti rimossi |
Number | removeBasicLinks() Rimuove tutti i collegamenti di base (collegamenti con nuessun attributo rel) da questo elemento, restituendo il numero di collegamenti rimossi |
Array | getCategories(schema String) Ottiene tutte le categorie corrispondenti allo schema specificato per questo elemento e li restituisce in una matrice |
Number | removeCategories(schema String, termine String) Rimuove tutte le categorie corrispondenti allo schema specificato, restituendo il numero di categorie rimosse. |
void | setTitle(str String, tipo String) Imposta il titolo di questo elemento nella str specificata con il tipo specificato. |
void | addExtension(spazio_nome String, nome String, attributi Array, contenuto String, shortNS String) Aggiunge il nome spazio di un'estensione nell'elemento. |
Array | getExtensions(spazio_nome String, nome String) Ottiene tutte le estensioni corrispondenti allo spazio_nome e il nome specificato e restituisce le estensioni in una matrice. spazio_nome può essere lo spazio nome completo (come "http://www.w3.org/2005/Atom") oppure il nome breve specificato (come "atom") |
void | removeExtensions(spazio_nome String, nome String) Rimuove tutte le estensioni corrispondenti al nome e allo sazio_nome specificato |
void | destroy() Elimina tutte le variabili associate con questo elemento |
Questo oggetto rappresenta l'elemento Categoria della specifica Atom. Le Voci e i feed possono avere ciascuno leme nti di categorie per trasferire le informazioni sulla voce o i feed.
Variabili di oggetti | ||
---|---|---|
Stringa | Schema | Lo schema per questa categoria |
Stringa | termine | Il termine per questa categoria |
Stringa | etichetta | L'etichetta per questa categoria |
Funzioni degli oggetti | |
---|---|
Boolean | accept(String tag) Restituisce sempre false, quando le categorie non presentano elementi secondari. |
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML |
void | buildFromDom(nodo DOMNode) Crea questa categoria dal nodo XML specificato |
Questo oggetto modella un oggetto di contenuto generico utilizzato nelle specifiche Atom come titoli, sottotitoli, contenuto e riepilogo. Un oggetto di contenuto può disporre di vari tipi in aggiunta al valore.
Variabili di oggetti | ||
---|---|---|
Stringa | tagName | Il nome di questo elemento, quale contenuto, riepilogo e così via |
Stringa | value | Il valore di questo elemento |
Stringa | src | L'URL che contiene il valore di questo elemento |
Stringa | tipo | Il tipo di contenuto archiviato in questo elemento. I valori accettabili sono elencati di seguito. |
Stringa | xmlLang | La lingua del contenuto. Questa lingua è inclusa nell'output se questo elemento è inserito in una stringa. |
Stringa | HTML | Una stringa che rappresenta il tipo HTML |
Stringa | TEXT | Una stringa che rappresenta il tipo di testo |
Stringa | XHTML | Una stringa che rappresenta il tipo XHTML |
Stringa | XML | Una stringa che rappresenta il tipo XML |
Funzioni degli oggetti | |
---|---|
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
void | buildFromDom(nodo DOMNode) Crea questo contenuto da un DOMNode specificato. |
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML. |
Questo oggetto rappresenta l'elemento di collegamento Atom.
Variabili di oggetti | ||
---|---|---|
Stringa | href | L'URL per questo elemento |
Stringa | hrefLang | L'attributo hrefLang |
Stringa | rel | L'attributo rel descrive la relazione di questo collegamento all'elemento principale |
Stringa | titolo | Il titolo di questo collegamento |
Stringa | tipo | Il tipo di collegamento |
Funzioni degli oggetti | |
---|---|
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
void | buildFromDom(nodo DOMNode) Crea questo oggetto di collegamento da un DOMNode specificato. |
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML |
Questo oggetto rappresenta un oggetto persona, usato per i tipi autore e sostenitore nella specifica Atom. Un oggetto persona può avere un nome, un indirizzo e-mail, un URI o entrambi.
Variabili di oggetti | ||
---|---|---|
Stringa | personType | Il tipo di persona ch questo oggetto rappresnta, in genere un autore o un sostenitore. |
Stringa | name | Il nome dell'oggetto persona |
Stringa | L'indirizzo e-mail di questa persona | |
Stringa | uri | L'URI di questa persona |
Funzioni degli oggetti | |
---|---|
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
void | buildFromDom(nodo DOMNode) Crea questo oggetto persona da un DOMNode specificato. |
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML |
Boolean | accept(String tag) Restituisce quando questo elemento accetta il nome tag specificato; sovrascritto dalle classi secondarie |
Questo elemento Atom trasferisce le informazioni sul pacchetto che ha generato questo feed Atom. Un generatore può avere un URI e un numero di versione, in aggiunta al nome leggibile da persone.
Variabili di oggetti | ||
---|---|---|
Stringa | uri | L'URI per questo generatore |
Stringa | versione | Il numero di versione di questo generatore |
Stringa | value | Il nome leggibile da persone di questo generatore |
Funzioni degli oggetti | |
---|---|
void | _postBuild() La funzione eseguita dopo il completamento di buildFromDom. Gli oggetti secondari possono sovrascrivere questa funzione se necessaria per aggiungere funzionalità dopo il completamento della creazione. |
void | buildFromDom(nodo DOMNode) Crea questo oggetto generatore da un DOMNode specificato. |
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML. |
Questo oggetto rappresenta l'elemento voce di Atom e si estende ibm_atom.io.atom.AtomItem. Le funzioni e le variabili ereditate appropriate possono essere trovate qui.
Variabili di oggetti | ||
---|---|---|
Stringa | feedUrl | Lv'URL del feed Atom che possiede questa voce |
Funzioni degli oggetti | |
---|---|
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML |
Boolean | accept(String tag) Restituisce quando questo elemento accetta il nome tag specificato; sovrascritto dalle classi secondarie |
Stringa | getEditHref() Scopre l'URL a cui inviare le informazioni sulle voci aggiornate mediante il Protocollo di pubblicazione atom |
Questo oggetto rappresenta l'elemento feed di Atom e si estende ibm_atom.io.atom.AtomItem. Le funzioni e le variabili ereditate appropriate possono essere trovate qui.
Funzioni degli oggetti | |
---|---|
Stringa | toString() Restituisce una stringa rappresentante questa categoria come XML |
Boolean | accept(String tag) Restituisce quando questo elemento accetta il nome tag specificato; sovrascritto dalle classi secondarie |
void | addNamespace(String fullName, String shortName) Aggiunge lo spazio nome specificato a questo feed |
void | addEntry(voce ibm_atom.io.atom.Entry) Aggiunge la voce specificata in questa rappresentazione di oggetti del feed Atom. Questa funzione non invia dati al server. |
ibm_atom.io.atom.Entry | getFirstEntry() Recupera la prima voce di questo feed Atom |
ibm_atom.io.atom.Entry | getEntry(String entryId) Recupera la voce identificata dalla stringa ID specificata |
Number | removeEntry(voce ibm_atom.io.atom.Entry) Rimuove la voce specificata dal feed, restituendo il numero di voci rimosse |
void | setEntries(Array arrayOfEntry) Aggiunge le voci contenute nella matrice specificata nel feed Atom |
ibm_atom.io.atom.Entry | createEntry() Crea un nuovo oggetto voce vuoto, imposta la relativa variabile feedUrl e restituisce l'oggetto voce |
Stringa | getSelfHref() Ottiene l'URL di questo feed Atom oppure restituisce un valore null se il feed non include l'oggetto collegamento appropriato |
Un documento di servizi Atom descrive i servizi offerti da un server che implementa il Protocollo di pubblicazione atom. Questo oggetto rappresenta questo tipo di documento.
Variabili di oggetti | ||
---|---|---|
Stringa | href | L'URL per il documento del servizio |
Funzioni degli oggetti | |
---|---|
void | buildFromDom(nodo DOMNode) Crea questo documento di servizio da un DOMNode specificato. |
Array | getCollection(url String) Recupera una matrice di tutte le raccolte identificate dall'URL specificato |
Un elemento di un'area di lavoro Atom fa parte di un documento di servizi Atom, come definito dalla specifica del Protocollo di pubblicazione atom e per l'organizzazione nel documento di servizi.
Variabili di oggetti | ||
---|---|---|
Stringa | titolo | Il titolo di quest'area di lavoro |
Array | raccolte | Le raccolte ospitate da quest'area di lavoro |
Funzioni degli oggetti | |
---|---|
void | buildFromDom(nodo DOMNode) Crea questo oggetto area di lavoro da un DOMNode specificato. |
Una raccolta Atom descrive un insieme di risorse, accessibile da un URL specificate e che sono identificate da un titolo.
Variabili di oggetti | ||
---|---|---|
Stringa | href | L'URL per questa raccolta |
Stringa | titolo | Il titolo di questa raccolta |
Array | attributes | Gli attributi di questa raccolta |
Array | funzioni | Le funzioni di questa raccolta |
Array | secondario | L'elemento secondario di questa raccolta; ad esempio, gli elementi <accept> o <category> |
Stringa | memberType | Il tipo di membro di questa raccolta |
Stringa | id | La stringa ID di questa raccolta |
Funzioni degli oggetti | |
---|---|
void | buildFromDom(nodo DOMNode) Crea questo oggetto Raccolta da un DOMNode specificato |
L'oggetto AtomIO deve fornire un'interfaccia semplice per gli sviluppatori per avviare in modo rapido l'interfaccia con un feed Atom o l'implementazione del server del Protocollo di pubblicazione atom (APP). Questo oggetto non mantiene un oggetto Feed o le variabili interne tra le chiamate. Se uno sviluppatore tenta di mantenere una rappresentazione locale di un feed (vedere feed sopra) sincronizzata con la copia del server, la responsabilità viene attribuita a questo sviluppatore.
Variabili di oggetti | ||
---|---|---|
Boolean | sync | Se le richieste provenienti da questo oggetto AtomIO devono essere necessariamente sincronizzate |
Boolean | useCache | Se disattivare le informazioni di cache (nelle richieste XHR) |
Boolean | alertsEnabled | Se visualizzare le caselle di avviso negli errori IO o chiudere in modalità silenziosa |
Dettagli della funzione |
---|