Versione 7 – 21/09/2006
Come specificato in sezione 2, l’applicazione può inoltrare tre tipi di richieste al Data Source:
Nelle sottosezioni successive sono riportate le specifiche dettagliate e complete per l’inoltro delle query verso il DS.
Tale richiesta è realizzata con una GET HTTP di un documento con URL stabilito e reso pubblico da ogni DS al momento della registrazione (nella sezione 8 sono riportate le regole per la registrazione dei data-source e dei formatter). Si assuma ad esempio che nel wiki sia registrato il seguente DS:
| NOME | CATALOGO XML | CATALOGO HTML |
|---|---|---|
| TWDataSource | http://tw.web.cs.unibo.it/TWds.xml | http://tw.web.cs.unibo.it/TWds.html |
L’URL da utilizzare per la richiesta è appunto
http://tw.web.cs.unibo.it/TWds.xml
Il DS risponde con una auto-descrizione espressa in sintassi XML secondo le specifiche riportate nella sezione 4.1. Si noti che il catalogo può essere un documento statico o dinamico e che è necessario fornire anche una versione human-readable (HTML) dello stesso.
Il ruolo del catalogo di un DS è fondamentale: per ogni richiesta l'AC deve consultare il catalogo del DS e recuperare l'URL completo per richiedere un'elenco di dati o una singola scheda. Sebbene sia possibile implementare meccanismi di caching, è obbligatorio recuperare dinamicamente l'indirizzo dello script del DS dal catalogo. La modifica degli URL relativi ad un DS, quindi (tranne l'URL del catalogo) deve essere automicamente gestita dall'AC, senza nessuna modifica manuale al codice dell'applicazione.
Tale richiesta è realizzata con una GET HTTP all’URL specificato nel catalogo dall’elemento elenco,inserito nella parte globale. Il contenuto dell’elenco è parametrizzato: i parametri di costruzione dell’elenco vengono specificati al momento della richiesta da parte del AC attraverso una query string e devono essere fra quelli supportati dal DS. I parametri supportati dal DS sono a loro volta specificati all’interno della parte query nella descrizione del catalogo. Si rimanda alla sezione 4.1 per una descrizione dettagliata dei meccanismo di accesso e query specificati all’interno del catalogo.
L’applicazione potrebbe richiedere, ad esempio, la risorsa:
http://tw.web.cs.unibo.it/get.php?req=elenco&anno=1999
a cui il DS risponderà con l’elenco delle schede disponibili dell’anno 1999, in sintassi XML secondo le specifiche riportate in sez. 4.2.
Tale richiesta è realizzata con una GET HTTP all’URL specificato nel catalogo dall’elemento scheda,inserito nella parte globale. Con questa richiesta è necessario specificare nella query string l’identificativo univoco della scheda richiesta (contenuto nell’elemento id della scheda) come valore della keyword predefinita "id".
Ad esempio la richiesta di una scheda potrebbe essere:
http://tw.web.cs.unibo.it/get.php?req=scheda&id=23
Si rimanda alla sezione 4.3 per una descrizione dettagliata dei meccanismo di accesso specificati all’interno del catalogo.
Il data source (o DS) è un modulo indipendente (cioè scollegato da qualunque altra applicazione) e passivo (cioè non ha comportamenti proattivi, ma risponde soltanto ad esplicita richiesta) che fornisce contenuti in formato XML
I data source possono essere data storage (cioè posseggono effettivamente i dati che sono in grado di restituire) oppure data intermediary (cioè estraggono i dati da qualche fonte su Internet e la restituiscono nel formato richiesto).
Ogni data source deve obbligatoriamente fornire tre servizi: il catalogo, l’elenco e la scheda.
Il catalogo è un documento statico in cui vengono elencate le funzionalità fornite dal modulo. Attraverso il catalogo un’applicazione o un utente a valle può decidere cosa utilizzare del modulo e come. Il catalogo è sempre accessibile via un URI fisso obbligatoriamente registrato (vedi cap. 8).
| Nome | Descrizione |
|---|---|
catalogoDataSource |
L’elemento radice del catalogo del DS |
globale |
Contenitore per elementi che descrivono il tipo di catalogo e come raggiungerlo. Ha come attributo "tipo", che può assumere i valori "storage" o "intermediary". |
query |
Contenitore per le keyword supportate dal data source. Vedi dopo. |
nome |
Il nome del data source |
descrizione |
Una descrizione del contenuto del data source |
accesso |
Contiene gli elementi che indicano come accedere ad un elenco o ad una scheda. |
elenco |
L'URI dello script tramite il quale ottenere un elenco, concatenato a "?req=elenco" |
scheda |
L'URI dello script tramite il quale ottenere una scheda, concatenato a "?req=scheda" |
keyword |
Elemento vuoto che ha come attributi: "nome", per indicare il nome della keyword per cui si può effettuare la ricerca; "descrizione", per indicare il significato della keyword; "tipo", per indicare il tipo di dato supportato dalla keyword (di default è "stringa" e può assumere anche i valori "intero", "data" e "booleano"). |
Ogni URI è assoluto, e deve avere la seguente forma:
<scheda>http://golem.web.cs.unibo.it/get.php?req=scheda</scheda>
<elenco>http://golem.web.cs.unibo.it/get.php?req=elenco</elenco>
Un vincolo aggiuntivo consiste nel fatto che entrambe le richieste devono avere lo stesso URL di base e possono differenziarsi solo nei parametri della query string, come mostrato nell'esempio precedente.
Per effettuare, ad esempio, la ricerca di una scheda l'AC dovrà concatenare all'URL reperito dal catalogo l'identificativo della scheda come segue:
http://golem.web.cs.unibo.it/get.php?req=scheda&id=42
Si noti dunque che l'unica parte aggiunta all'URL è &id=42. Analogamente per l'elenco si dovrà concatenare una o più keyword.
ATTENZIONE: per evitare qualsiasi incomprensione, tengo a precisare che se si utilizzano delle RewriteRule ovviamente non è obbligatorio che nell'URI presente nel catalogo compaiano le due stringhe nel formato suddetto.DECISIONE: è stato deciso come devono essere formati esattamente gli URL per effettuare richieste per ottenere una scheda ed un elenco.
La parte query contiene la lista delle keyword rispetto alle quali il DS permette di eseguire una query per ottenere un elenco. Di ogni keyword va specificato il nome e il tipo (stringa, intero, data o booleano). In particolare, le date andranno espresse nel formato yyyymmgg, mentre i valori booleani con le stringhe "true" e "false".
Si noti che il "nome" utilizzato per le keyword deve essere scelto tra quelli degli elementi costitutivi della "scheda" (si veda la sezione 4.3).
<catalogoDataSource>
<globale tipo="storage">
<nome>AreaDS42</nome>
<descrizione>DataSource per libri <em>a</em> <strong>fantasy</strong>, <strong>fantascienza</strong>, <strong>Science-Fiction</strong>.</descrizione>
<accesso>
<elenco>http://gboccard.cs.unibo.it/html/TWeb/DS/DSstorage42.php?req=elenco</elenco>
<scheda>http://gboccard.cs.unibo.it/html/TWeb/DS/DSstorage42.php?req=scheda</scheda>
</accesso>
</globale>
<query>
<keyword nome="titolo" descrizione="Il titolo di un libro."/>
<keyword nome="autore" descrizione="L'autore di un libro."/>
<keyword nome="anno" descrizione="Anno di pubblicazione di un libro." tipo="intero"/>
<keyword nome="genere" descrizione="Genere letterario di un libro."/>
<keyword nome="personaggio" descrizione="Un personaggio di un libro."/>
</query>
</catalogoDataSource>
L’elenco è un documento generato come risposta ad una query. La query è sempre una espressione della forma campo1=val1&campo2=val2… in cui campo1 e campo2 sono keyword ammesse alla query, e val1 e val2 sono valori compatibili con i tipi dei campi 1 e 2.
Esistono le keyword predefinite autore e titolo per richiedere rispettivamente l'elenco dei libri pubblicati da un certo autore o aventi un certo titolo. Tutti i DS devono gestire queste keyword obbligatoriamente.
Per quanto riguarda la gestione delle wildcard si è deciso di limitarsi ai seguenti due casi: se la stringa da cercare non presenta al suo interno wildcard, la sua ricerca viene effettuata come sottostringa del valore dell'elemento cercato (i.e., Ada =>
Quindi l'elenco corrispondente alla richiesta
http://www.sito.com/techweb_ds.php?req=elenco&titolo=lli
conterrà informazioni su tutti e soli i libri il cui titolo contiene 'lli'. Ci sarà quindi un item relativo a "Il Signore degli Anelli" e "Il Silmarillion".
Contrariamente, ad una richiesta del tipo:
http://www.sito.com/techweb_ds.php?req=elenco&titolo="Lo Hobbit"
verrà restituito un elenco contenente informazioni su tutti e soli i libri il cui titolo fa esattamente match con 'Lo Hobbit'. Ci sarà quindi un item relativo a "Lo Hobbit", ma non a "Lo Hobbit Annotato".
Il DS restituisce alla query un documento composto da un elemento radice elenco che contiene tanti elementi scheda tutti uguali. L’elemento elenco riporta nell’attributo query la query che è stata effettuata per generare l’elenco stesso. Per concatenare più keyword in base alle quali è stata svolta la ricerca si è deciso di utilizzare il separatore "&" (ad es. <elenco query="titolo=XXX&autore=YYY">).
Ogni elemento voce contiene una sequenza di elementi tratti dal vocabolario ODALISK e utili per la visualizzazione dell’elenco. Si è deciso di permettere l'utilizzo, all'interno dell'elemento "voce", di tutti quegli elementi che sono presenti nel campo dati di "scheda", lasciando libertà al formatter di ciascun gruppo di gestire opportunamente l'output.
L’attributo richiediCon contiene un identificativo utile per richiedere al DS la scheda completa associata alla voce: in particolare, contiene un identificativo della scheda creato dall'AC come giustapposizione di un id assegnato dall'AC stesso a ciascun DS che gestisce e dell'identificativo contenuto nella scheda stessa
Ad esempio, il seguente è un elenco di libri di Tolkien:
<elenco query="autore=Tolkien">
<scheda cod="ds1-1723">
<titolo>Il Signore degli Anelli</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
<scheda cod="ds2-1040">
<titolo>I Racconti Perduti</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
<scheda cod="ds3-671">
<titolo>I Racconti Ritrovati</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
</elenco>
Gli elenchi sono costruiti dinamicamente, secondo i criteri dichiarati nel catalogo del DS. Tuttavia esistono due elenchi predefiniti che tutti i DS devono gestire e corrispondenti alle keyword autore e titolo.
La keyword autore è utilizzata per richiedere l'elenco di tutti i libri di un determinato autore. La seguente richiesta produce, ad esempio, l'elenco di tutti i libri di Tolkien:
http://www.sito.com/techweb_ds.php?req=elenco&autore=Tolkien
Il DS risponde a questa richiesta con l'elenco richiesto e per ogni libro specifica almeno titolo e autore. Di seguito un esempio della risposta:
<elenco query="autore=Tolkien">
<scheda cod="ds1-1723">
<titolo>Il Signore degli Anelli</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
<scheda cod="ds2-1040">
<titolo>I Racconti Perduti</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
<scheda cod="ds3-671">
<titolo>I Racconti Ritrovati</titolo>
<genere>Fantasy</genere>
<autore>Tolkien</autore>
<testo>
<contenuto>bla..bla...bla...</contenuto>
</testo>
</scheda>
</elenco>
La keyword titolo è utilizzata per richiedere l'elenco di tutti i libri aventi un determinato titolo. Per ogni libro, la risposta deve contenere almeno titolo e autore.
La scheda contiene tutte le informazioni associate ad un documento. Queste sono organizzate in sezioni che raggruppano informazioni tra loro omogenee per uso. Importante notare che tutte le pagine prodotte dall'AC devono essere codificate come schede e formattate dal DF.
Ogni pagina prodotta dall'AC, inclusi il catalogo e gli elenchi, è un documento che deve essere formattato dal DF.
Questo vincolo impone che sia la home-page sia ogni eventuale altra pagina statica o dinamica, help, ringraziamenti, motore di ricerca, ecc., siano sempre gestite attraverso il DF.
| Nome | Descrizione |
|---|---|
scheda |
L’elemento radice del documento scheda |
info |
Metadati informativi sulla scheda in quanto prodotto di un determinato DS |
dati |
Dati strutturati (tutti atomici) di descrizione della scheda. Dipendono dal tipo di dato richiesto e fornito dal DS. Può essere facoltativo nel caso di pagine intermedie, che non sono descritte da elementi atomici. |
testo |
Testi di media lunghezza (recensioni, commenti, ecc.) |
recensione |
Una recensione di un libro |
commento |
Un commento individuale ad un libro, o ad un testo di altro tipo sull’opera stessa. |
biografia |
Una biografia di un autore, traduttore, curatore, etc. |
contesto |
Un commento sul contesto (storico, artistico) all’interno del quale l'autore opera o ha operato. |
curiosita |
Aneddoti e curiosità su un libro, autore, personaggio. |
contenuto |
il contenuto di un libro |
team |
Il team a cui appartiene l’autore |
origine |
l’URI originale del documento su Internet da cui è tratto il contenuto della scheda, o la stringa "originale" altrimenti. |
dataUltimaVersione |
La data dell'ultima versione di una scheda |
titolo |
Il titolo di un libro |
sottotitolo |
Il sottotitolo di un libro |
titoloOriginale |
Il titolo di un libro in lingua originale |
sottotitoloOriginale |
Il sottotitolo di un libro in lingua originale |
autore |
Nome e cognome di un autore ed eventuale pseudonimo. |
illustratore |
Autore dei disegni |
ciclo |
Il ciclo (deciso dall'autore) cui appartiene un libro. |
editore |
L'editore del libro (nell'attributo NON si puo' specificare il sito dell'editore) |
collana |
La collana (scelta dall'editore) cui appartiene un libro. |
anno |
L’anno di pubblicazione di un libro |
numeroEdizione |
Il numero di edizione di un libro. |
annoPrimaPubblicazione |
L’anno di prima pubblicazione del libro |
traduttore |
Il traduttore di un libro |
lingua |
La lingua in cui è scritto un libro (nel formato dello standard ISO 639-1): italiano = IT, inglese = EN, ecc. |
linguaOriginale |
La lingua originale in cui è scritto un libro (nel formato dello standard ISO 639-1): italiano = IT, inglese = EN, ecc. |
genere |
Il genere di un libro. |
sottogenere |
Il sottogenere di un libro. |
pagine |
Il numero di pagine che compongono un libro |
isbn |
Il codice isbn di un libro |
materiale |
La tipologia di copertina (brossura (paperback), brossura con alette, copertina rigida (hardcover), pelle (leather bound)) |
personaggio |
Il nome di un personaggio |
mezzo |
Il mezzo di trasporto con cui viene effettuato un viaggio (dedicato a chi tratta libri di viaggi) |
luogo |
Il luogo meta di un viaggio (dedicato a chi tratta libri di viaggi) |
copertina |
L’URL dell’immagine della copertina di un libro. |
premio |
Un premio vinto da un libro. |
DECISIONE: a grande richiesta, e' stato eliminato l'elemento EXTRA.
I dati contenuti in una scheda dipendono dalle informazioni memorizzate nel DS. Tuttavia esistono alcune informazioni di base che ogni DS deve gestire. In particolare ogni DS è obbligato a fornire una scheda per ogni libro, contenente un set minimale di informazioni, in particolare "titolo" e "autore".
Il seguente esempio mostra una possibile scheda:
<scheda cod="1234567890">
<info>
<team>42</team>
<origine>originale</origine>
<dataUltimaVersione>20060504</dataUltimaVersione>
</info>
<dati>
<titolo>Il Signore degli Anelli</titolo>
<titoloOriginale>The Lord of the Rings</titoloOriginale>
<autore>John Ronald Reuel Tolkien</autore>
<genere>Fantascienza</genere>
<sottogenere>Horror</sottogenere>
<editore>Bompiani</editore>
<collana>I Libri di Tolkien</collana>
<isbn>88-452-9005-0</isbn>
<pagine>1380</pagine>
<materiale>Brossura, con sovraccoperta</materiale>
<anno>2000</anno>
<annoPrimaPubblicazione>1966</annoPrimaPubblicazione>
<lingua>IT</lingua>
<linguaOriginale>EN</linguaOriginale>
<traduttore>Vicky Alliata di Villafranca</traduttore>
<personaggio>Frodo Baggins</personaggio>
<personaggio>Bilbo Baggins</personaggio>
<personaggio>Samvise Gamgee</personaggio>
<personaggio>Peregrino Tuc</personaggio>
<personaggio>Meriadoc Brandybuck</personaggio>
<personaggio>Gandalf</personaggio>
<personaggio>Aragorn</personaggio>
<personaggio>Legolas</personaggio>
<personaggio>Gimli</personaggio>
<personaggio>Boromir</personaggio>
<personaggio>Gollum</personaggio>
<personaggio>Saruman</personaggio>
<personaggio>Sauron</personaggio>
<personaggio>Galadriel</personaggio>
<personaggio>Elrond</personaggio>
<personaggio>Arwen</personaggio>
<personaggio>Faramir</personaggio>
<personaggio>Théoden</personaggio>
<personaggio>Tom Bombadil</personaggio>
<personaggio>Éomer</personaggio>
<personaggio>Éowyn</personaggio>
<personaggio>Denethor</personaggio>
<personaggio>Grima Vermilinguo</personaggio>
<personaggio>Shelob</personaggio>
<copertina src="http://www.lafeltrinelli.it/upl/d@y/album/orig/productImages/00/00/03/66/44.jpg" alt="Copertina Il Signore degli Anelli"/>
<testo>
<contenuto originale="true" autore="Giacomo Boccardo">
Il <em>Signore degli Anelli</em> è un romanzo d'eccezione...
</contenuto>
<contenuto originale="true" autore="Giacomo Boccardo">
Il <em>Signore degli Anelli</em> è un romanzo eccezionale...
</contenuto>
<recensione originale="false" autore="Manuela Di Pietro" fonte="Sito PIù" urlFonte="http://www.librando.net/dev/projects/read.asp?pid=8&docid=154">
Pensiamo ad un mondo: un mondo in cui ogni cosa è possibile...
</recensione>
</testo>
</dati>
</scheda>
Le richieste inoltrate al DS possono generare diversi errori. Per gestirli il protocollo ASD prevede un messaggio di errore che riporta un codice ed una descrizione human-readable per l’errore. Il messaggio deve essere validato dal seguente DTD:
<!ELEMENT errori (errore)> <!ELEMENT errore (codice, descrizione)> <!ELEMENT codice (#PCDATA)> <!ELEMENT descrizione %inline;>
Il seguente frammento XML riporta un esempio di messaggio di errore:
<errori>
<errore>
<codice>00</codice>
<descrizione>DS non disponibile.</descrizione>
</errore>
...
</errori>
Viene riportata di seguito una tabella con gli errori e le relative descrizioni:
| Codice errore | Descrizione Errore |
|---|---|
| 00 | Non disponibile |
| 10 | Dati in input errati |
| 21 | Scheda inesistente (id non valido) |