概要

IIIF Presentation API v2のIIIFコレクションで、ページネーションを使う機会がありましたので、備忘録です。

背景

IIIFコレクションでは、以下のように、複数のマニフェストファイル(およびコレクション)の一覧を提供することができます。

https://iiif.io/api/presentation/2.1/#collection

{}""""""""]@@@lvdamcitaieta{}odybestnn"pewcri"""t:elirif@@le""nibeitax"::gpusdybthHttt"pe"t""iiis:el:tsTnoo"""pcotnn:"::"::p"""hh/C:::[t""t/oLtsBtele"""pcopxlvtDP::o:aeeoer/Mk/mclpso/a/pt"cven1iliC,rixi"ieooidafi.nlpemefo"ltdps.r,eiltigcobe"otny.,iioaiooErpinfxgifa///fCmipcoopirorlliellefslEe/eexcObncatrottmigoaipoaktolnn1ine"i/o/,zmntOaa/ortn2pgii/"aofc,nneoi"snz,tta"et,xito.nj"s,on",

この時、対象とするマニフェストファイルが多数になった場合、一つのIIIFコレクションでは配信が難しくなりました。

これに対して、以下でページネーションに関する仕様がありましたので、こちらを使ってみます。

https://iiif.io/api/presentation/2.1/#paging

ページネーション

上記のページでは、以下のような例が紹介されていました。

{}""""""@@@ltfcitaoiodybtrn"peast:ellte""""x"::::th"t""9":tsE3hpcx1t"::a6th/Cm2pt/op9:tell0/pxle,/:aee/mcBx/ptiailigmieopi.nClfo"oe.r,l.iglooericgait/piiiifoi//nipc"fro,/elcsloeelncltteaictotinio/ontn/o/2pc/"1c,"ontext.json",
{}"""""""]@@@wsnmcititeaodytaxnn"phrtit:eit"fMe"nI:eax":"nsnth:d"ti"t"ehsf:ts"xt"epch"t:s"::t:pth/Ct:[st/op0/tel:,/lpxl/ei:ae/xv/mceae/ptxmiliaphieomlei.nperfo"l.e.r,eoig.roogir/aigipi/iifii//ifpci/rofcel/oslcleeolnclettlcaiettociintoo/innco//1nc2"/2/,t"co,opn"t,ext.json",

まず、一つの目のJSONでコレクション全体のマニフェストファイル数totalを示し、さらにはじめの部分マニフェストファイル群へのリンクをfirstで提示します。

firstで指定されたコレクションが2つ目のJSONであり、startIndexnextを使って、現在の位置と次の部分マニフェストファイル群へのリンクを示すようでした。

DrupalとElasticsearchの組み合わせによる実装例

上記のようなページネーションについて、DrupalとElasticsearchの組み合わせによる実装例を紹介します。以下の記事で紹介したように、drupal/elasticsearch_connectorを使って、DrupalとElasticsearchを接続していることを前提とします。

Elasticsearchでは、fromを使ってオフセットを指定することができますが、max_result_window(デフォルトでは、10,000件)を超える場合、正しく機能しません。

そこでsearch_afterを使って、特定のコンテンツに続くコンテンツを取得することができます。

例えば、特定のソート条件下で、20,000件目のコンテンツのID(field_id)を取得し、以下のようなクエリにより、20,001件目以降のコンテンツを取得できます。searchAfterに20,000件目のコンテンツのIDが入っています。

c}i}o;fn_ssqssio(utozrseueterqr,:ayucr.ee[csr:{heyAa:[ffr'itcSteeheilr_atd)arl_fcei{th'deQ,:rue''=rfayis[ecs=l'eda{_}rm]ca,hnAiffteesrt]';,'field_id'],

ただし、Elasticsearch単独で特定のソート条件下において、デフォルトのmax_result_windowを使う場合、例えば20,000件目のコンテンツのID(field_id)を取得するには工夫が必要になります。

そこで、特定のソート条件下におけるxxx件目のコンテンツの取得、を行う部分については、DrupalのREST APIを使用しました。DrupalのViewsを使い、オフセットでユーザが指定指定できるようにした上で、1件のコンテンツを返却できるようにしました。

例:/api/xxx?offset=20000

これにより、search_afterに必要なコンテンツのIDを取得することができ、上述したElasticsearchへのクエリと組み合わせることで、ページネーションを含むIIIFコレクションを構築することができました。

参考

上記で実装したIIIFコレクションをPresentation API Validatorにかけてみました。

https://presentation-validator.iiif.io/

結果、上述したような、1つ目のコレクション全体を示すJSONでは、以下の警告が表示されました。

WWAARRNNIINNGG::SSeettttiinnggnnoonn--ssttaannddaarrddffiieelldd''ftiortsatl''oonnrreessoouurrcceeooffttyyppee''sscc::CCoolllleeccttiioonn''

また、2つ目のコレクションの一部の示すJSONでは、以下の警告が表示されました。

WWAARRNNIINNGG::SSeettttiinnggnnoonn--ssttaannddaarrddffiieelldd''nsetxatr'tIonnderxe'soounrcreesoofurtcyepeof'stcy:pCeol'lsecc:tCioolnl'ection'

さらに、1つ目のコレクション全体を示すJSONについては、Universal ViewerやMiradorでもうまく表示させることができませんでした。

今回紹介した実装に問題があるのか等、引き続き調査してみたいと思います。

まとめ

IIIFコレクションを使って、多数のマニフェストファイル(またはサブコレクション)を提示する際に、本記事が参考になりましたら幸いです。