OpenSearch-rajapinta

OpenSearch-rajapinnan avulla voidaan hakea URL:ään upotettujen Lucene-hakusyntaksilla tehtyjen hakujen mukaisia kyselyjä ja vastaus saadaan XML:nä. OpenSearch korvaa aiemmin käytössä olevaa SRU-rajapintaa, jota ei valitettavasti enää tueta Dspacessa. Toisaalta OpenSearch on SRU:ta monipuolisempi hakujen osalta.

Kansalliskirjaston julkaisuarkistoja on kahdessa eri DSpace-versiossa. Uudemmassa versiossa URL:ään täytyy lisätä discover-termi:

Vanhassa:

http://www.doria.fi/open-search/?query=

Uudessa:

http://www.doria.fi/open-search/discover?query=

 

OpenSearch -rajapinnan kautta julkaisuarkistossa tehtyjen hakujen tuloksia saa vastauksena RSS- tai Atom-syötteinä, joiden avulla julkaisuista on mahdollista tehdä automaattisesti päivittyviä listauksia esim. omille kotisivuille, muodostaa hakuja RSS-readereiden käyttöön yms. Kansalliskirjaston DSpace-arkistoihin on lisätty syötemuotoisten vastausten lisäksi kk-formaatti, jolla OpenSearch haut saa XML-muodossa, jossa on tulostietueiden kaikki saatavilla oleva metadata näkyvillä.

Ohessa OpenSearchin syntaksin esittelyä tarkemmin Doria-julkaisuarkistoon kohdistuvien hakuesimerkkien avulla. 

OpenSearchin käyttöesimerkki: Tilataan MPKK:n kokoelmiin kohdistetun haun "sukellusvene" -hakutulokset RSS-syötteenä:

 

http://www.doria.fi/open-search/?query=sukellusvene&sort_by=3&order=desc&start=0&rpp=50&format=atom&scope=10024/72633
  • query-parametrin perään voidaan tehdä haku samaan tapaan kuin Dspacessa muutenkin, eli Lucene-hakumoottorin syntaksilla. Voidaan siis esim. kohdistaa haku tiettyyn kenttään hakualiaksien avulla, eli esim. title:sitäjatätä. Julkaisuarkistojemme kentthaukuun tarvittavat aliakset löytyy täältä. Sulkujen käyttöä ei kannata säästellä monimutkaisemmissa booleanhauissa. 
  • sort_by-parametrilla voi järjestää syötteen seuraavasti: 0 = Relevanssin, 1 = Nimekkeen, 2 = Julkaisuajan, 3 = Syöttöajan mukaan 
  • order-parametrillä voi muuttaa järjestyksen nousevaksi (asc) tai laskevaksi (desc) 
  • start-parametri kertoo, mistä hakutuloksesta aloitetaan näyttäminen. 
  • rpp-parametrillä kerrotaan, kuinka monta tulosta maksimissaan listataan per sivu.
  • format-parametri voi olla joko atom, rss tai kk ja kkf. (kk ja kkf ovat Kansalliskirjaston omatekemä formaatti, jolla palauttaa kaikki julkisesti saatavilla olevat metadatadatat tulostietueista. kkf palauttaa myös tiedostolinkit, esimerkiksi kokotekstien ja kuvien linkit)
  • scope-parametrilla voi rajoitta haun tiettyyn kokoelmaan tai yhteisöön, arvoksi annetaan handle. Jos scopea ei määritellä, haku kohdistuu koko Dspace-arkistoon. 

HUOM! Jotta saat kaikki tulokset, täytyy hakutuloksia iteroida start-parametria kasvattamalla sitä rpp-parametrin verran. Kun tulosjoukko on tyhjä tai pienempi kuin rpp:n arvo, voidaan päätellä, että kaikki tulokset on iteroitu läpi.


Muita hakuesimerkkejä Doriasta.

Haussa voi käyttää fraaseja:

http://www.doria.fi/open-search/?query="vietnamin sota"&sort_by=3&order=desc&start=0&rpp=50&format=atom&scope=10024/72633

 

MPKK:n julkaisemia koptereita tai panssarivaunuja käsitteleviä artikkeleita RSS-feedinä:

http://www.doria.fi/open-search/?query=publisher:maanpuolustuskorkeakoulu AND (abstract:helikopteri* OR abstract:panssariv*)&start=1&rpp=50&format=rss

 

MPKK:n julkaisemia julkaisuja, joissa mainitaan Israel tai Palestiina:

http://www.doria.fi/open-search/?query=publisher:maanpuolustuskorkeakoulu AND (abstract:israel OR abstract:palestiina)&start=1&rpp=100&format=kk

 

Yksi tapa käyttää Open Search kyselyitä on siis integroida tuloksena saatavien RSS-, Atom- tai XML-muotoinen tieto osaksi omia kotisivuja.

OpenSearchin tuottama RSS-, Atom tai XML-muotoinen tieto ei sisällä HTML-muotoilutietoja, pitää syötteiden halutusta ulkoasusta huolehtia web-sivuston puolella. Tämän toteutus riippuu kotisivujen ylläpitoon käytetystä ohjelmistosta.

Kenttähaussa käytettävissä olevat aliakset (indeksoidut kentät)

Toiveita uusista hakualiakista voi esittää meille ja niitä lisätään harkinnan mukaan. Tämän hetkiset hakualikset löytyvät täältä. 

Syötteiden tilaus (RSS ja ATOM)

 

Syötteitä voi tilata kokolma- yhteisö tai koko julkaisuarkiston tasolla.

Koko arkiston RSS-feedien haku rss:nä ja atomina:

 

http://www.doria.fi/feed/rss_2.0/site
http://www.doria.fi/feed/atom_1.0/site

 

Haun kohdistaminen tiettyyn kokoelmaan tai yhteisöön (käytä yhteisön/kokoelman handlea)

http://www.doria.fi/feed/rss_2.0/10024/4194 http://www.doria.fi/feed/atom_1.0/10024/4194

 

Haku palauttaa niin monta työtä kuin DSpace-arkistossa on määritelty, vaihtelee neljän ja seitsemän välillä. Tulokset ovat uutuusjärjestyksessä kentän dc.date.accessioned mukaan. DSpacen feedit on kuitenkin huomattavasti rajoittuneempia verrattuna OpenSearch-rajapinnan käyttöön.  Sen (hakuja rajattavissa vain kokoelmahierarkian perusteella tai koko arkistoon). DSpacen Open Search -rajapinta on tässä suhteessa paljon monipuolisempi, ja sillä on mahdollista tuottaa esim. verkkosivuille päivittyviä uutuuslistoja aineistosta myös metadatasta tehtävien hakujen pohjalta,eli se ei ole sidoksissa kokoelmarakenteeseen.

  • No labels