Changes between Version 3 and Version 4 of FCS-Specification-ScrapBook


Ignore:
Timestamp:
01/30/14 19:41:06 (10 years ago)
Author:
oschonef
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • FCS-Specification-ScrapBook

    v3 v4  
    2424[[PageOutline(1-3)]]
    2525
     26== Introduction ==
     27The main goal of CLARIN federated content search (CLARIN-FCS) is to introduce a ''interface specification'', to decouple the ''search engine''' functionality from its ''exploitation''', i.e. user-interfaces, third-party applications and to allow services to access search engines in an uniform way.
    2628
    27 == Introduction ==
    2829
    29 The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [http://tools.ietf.org/html/rfc2119 RFC 2119].
     30=== Terminology ===
     31The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [#REF_RFC_2119 RFC2119].
    3032
    31 This documents describes ...
    3233
    3334=== Glossary ===
    3435 Aggregator::
    35    write def
     36    A module or service to dispatch queries to repositories and collect
     37results.
    3638
    3739 CLARIN-FCS, FCS::
    38    CLARIN federated content search
     40    CLARIN federated content search, an interface specification to allow searching within resource content of repositories.
     41
     42 Client::
     43    A software component, that implements the interface specification to query endpoints, i.e. an aggregator or an user-interface.     
     44
     45 CQL::
     46    Contextual Query Language, previously known as Common Query Language, is a formal language for representing queries to information retrieval systems such as search engines, bibliographic catalogs and museum collection information.
    3947
    4048 Endpoint::
    41    write def
     49    A software component, that implements the CLARIN-FCS interface specification and translates between CLARIN-FCS and a search engine.
     50
     51 Interface Specification::
     52    Common harmonized interface and suite of protocols that repositories need to implement.
    4253
    4354 Search Engine::
    44    write def
     55    A software component within a repository, that allows for searching within the repository contents.
    4556
    4657 SRU::
    47    Search and Retrieve via URL, is a protocol for Internet search queries
     58    Search and Retrieve via URL, is a protocol for Internet search queries.
    4859
    49  CQL::
    50    Contextual Query Language, previously known as Common Query Language, is a formal language for representing queries to information retrieval systems such as search engines, bibliographic catalogs and museum collection information
    51  
    5260 Data View::
    53    write def
     61    write def
    5462
    5563 PID::
    56    persistent identifier, write more
     64    Persistent identifier, write more
    5765
     66 Repository::
     67    A software component at a CLARIN center that stores resources (= data) and information about these resources (= metadata).
     68
     69 Repository Registry::
     70    A separate service that allows registering endpoints and provides information about these to other components, e.g. an aggegator. The [http://centres.clarin.eu/ CLARIN Center Registry] is an implementation of such a repository registry.
     71
     72=== Normaitive References ===
     73 RFC2119[=#REF_RFC_2119]::
     74    Key words for use in RFCs to Indicate Requirement Levels, IETF RFC 2119, March 1997, \\
     75    [http://www.ietf.org/rfc/rfc2119.txt]
     76
     77 OASIS-SRU-Overview[=#REF_SRU_Overview]::
     78    searchRetrieve: Part 0. Overview Version 1.0, OASIS, January 2013, \\
     79    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part0-overview/searchRetrieve25v1.0-csd01-part0-overview.doc]
     80
     81 OASIS-SRU-APD[=#REF_SRU_APD]::
     82    searchRetrieve: Part 1. Abstract Protocol Definition Version 1.0, OASIS, January 2013, \\
     83    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part1-apd/searchRetrieve-v1.0-29 csd01-part1-apd.doc]
     84 
     85 OASIS-SRU12[=#REF_SRU_12]::
     86    searchRetrieve: Part 2. SRU searchRetrieve Operation: APD Binding for SRU 1.2 Version 1.0, OASIS, January 2013, \\
     87    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part2-sru1.2/searchRetrieve33v1.0-csd01-part2-sru1.2.doc]
     88
     89 OASIS-CQL[=#REF_CQL]::
     90    searchRetrieve: Part 5. CQL: The Contextual Query Language version 1.0, OASIS, January 2013, \\
     91    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/44 part5-cql/searchRetrieve-v1.0-45 csd01-part5-cql.doc]
     92
     93 SRU-Explain[=#REF_Explain]::
     94    searchRetrieve: Part 7. SRU Explain Operation version 1.0, OASIS, January 2013, \\
     95    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part7-explain/searchRetrieve53v1.0-csd01-part7-explain.doc]
     96
     97 SRU-Scan[=#REF_Scan]::
     98    searchRetrieve: Part 6. SRU Scan Operation version 1.0, OASIS, January 2014, \\
     99    [http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part6-scan/searchRetrieve-v1.0-csd01-part6-scan.doc] 
     100
     101 LOC-SRU12[=#REF_LOC_SRU_12]::
     102    SRU VERSION 1.2: SRU Search/Retrieve Operation, Library of Congress,\\
     103    [http://www.loc.gov/standards/sru/sru-1-2.html]
     104
     105
     106=== SRU/CQL ===
     107
     108Endpoints `MUST` implement the SRU/CQL protocol suite as defined in [#REF_SRU_Overview OASIS-SRU-Overview], [#REF_SRU_APD OASIS-SRU-APD], [#REF_CQL OASIS-CQL], [#REF_Explain SRU-Explain], [#REF_Scan SRU-Scan], especially with respect to:
     109 * Data Model,
     110 * Query Model,
     111 * Processing Model,
     112 * Result Set Model, and
     113 * Diagnostics Model   
     114
     115Endpoints `MUST` use the implement the APD Binding for SRU 1.2, as defined in [#REF_SRU_12 OASIS-SRU-12]. Endpoints `MAY` implement APD binding for version 1.1 or version 2.0.
     116
     117Endpoints `MUST` use the following namespace URIs for serializing responses:
     118 * `http://www.loc.gov/zing/srw/` for SRU response documents, and
     119 * `http://www.loc.gov/zing/srw/diagnostic/` for serializing diagnostics within SRU response documents.
     120CLARIN-FCS deviates from the OASIS specification [#REF_SRU_Overview OASIS-SRU-Overview] and [#REF_SRU_12 OASIS-SRU-12] to ensure backwards comparability with SRU 1.2 services as they where defined by the [#REF_LOC_SRU_12 LOC-SRU12].
     121
     122
     123== CLARIN-FCS Interface Specification ==
    58124
    59125=== Profiles ===
    … …  
    61127Yada yada yada ...
    62128
    63 == SRU/CQL ==
     129
     130=== Data Views ===
     131
     132Yada Yada yada ...
     133
     134
     135=== Operations ===
    64136
    65137Yada yada yada ...
    66138
    67 === Explain ===
     139=== Endpoint Identification ===
    68140
    69 Yada yada yada ...
     141Is mapped to SRU ''explain'' operation. Yada yada ...
    70142
    71 === Scan ===
    72143
    73 Yada yada yada ...
     144=== Performing Queries and returning results ===
    74145
    75 === !SearchRetrieve ===
    76 
    77 Yada yada yada ...
     146Is mapped to SRU ''!SearchRetrieve'' operation. Yada yada ...