Changes between Version 9 and Version 10 of FCS-Specification-ScrapBook


Ignore:
Timestamp:
02/03/14 15:40:34 (10 years ago)
Author:
oschonef
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • FCS-Specification-ScrapBook

    v9 v10  
    2626== Introduction ==
    2727The 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.
    28 
    29 The CLARIN-FCS interface specification is built upon the SRU/CQL standard and additional functionality required for CLARIN-FCS is added through SRU/CQL's extension mechanisms.
    3028
    3129
    … …  
    118116
    119117
     118== CLARIN-FCS Interface Specification ==
     119
     120The CLARIN-FCS interface specification defined two profiles, an extensible result format and a set of required operations. CLARIN-FCS is built on the SRU/CQL standard and additional functionality required for CLARIN-FCS is added through SRU/CQL's extension mechanisms.
     121
     122The following sections describe the profiles, how SRU/CQL is used in the context of CLARIN-FCS and the CLARIN-FCS specific extions to SRU.
     123
     124
     125=== Profiles ===
     126
     127CLARIN-FCS supports two profiles:
     128 ''Basic profile''::
     129   Endpoints `MUST` support ''term-only'' queries. \\
     130   Endpoints `SHOULD` support ''terms'' combined with boolean operator (''AND'' and ''OR'') queries, including subqueries. Endpoints `MAY` support the ''NOT'' or ''PROX'' operators. If an endpoint does not support such a query, it `MUST` return an appropriate error message using the appropriate SRU diagnostic. \\
     131   Examples for valid CQL queries :
     132{{{
     133cat
     134"cat"
     135cat AND dog
     136"grumpy cat"
     137"grumpy cat" AND dog
     138"grumpy cat" OR "lazy dog"
     139cat AND (mouse OR "lazy dog")
     140}}}
     141   The endpoint is `MUST` perform the query on an annotation tier, that makes the most sense for the user, i.e. the textual content for a text corpus resource or the orthographic transcription of a spoken language corpus. Endpoints are `RECOMMENDED` to perform the query case-sensitive.\\
     142   Endpoint `MUST NOT` silently accept queries that include CQL features besides ''term-only'' and ''terms'' combined with boolean operator queries, i.e. queries involving context sets, etc.
     143
     144 ''Extended profile''::
     145   This profile will support more sophisticated queries such as selecting annotation tiers, expanding of tags, or mapping of data categories. \\
     146   '''NOTE''': the extended profile is not yet defined and will be part of a future CLARIN-FCS specification.
     147
     148Endpoints and Clients `MUST` support the ''basic profile''. Endpoints and Clients `MUST NOT` claim to support the ''extended profile''.
     149
     150
    120151=== SRU/CQL ===
    121152SRU (!Search/Retrieve via URL) specifies a general communication protocol for searching and retrieving records and the CQL (Contextual Query Language) specifies a extensible query language. CLARIN-FCS is built on SRU 1.2; subsequent specification may built on SRU 2.0.
    … …  
    135166CLARIN-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].
    136167
    137 Endpoints or Clients `MUST` support CQL conformance ''Level 2'' (as defined in [#REF_OASIS_CQL OASIA-CQL, section 6]), i.e. ab to ''parse'' (Endpoints) or ''serialize'' (Clients) all of CQL and respond with appropriate error messages to the search/retrieve protocol interface.
     168Endpoints or Clients `MUST` support CQL conformance ''Level 2'' (as defined in [#REF_OASIS_CQL OASIA-CQL, section 6]), i.e. be able to ''parse'' (Endpoints) or ''serialize'' (Clients) all of CQL and respond with appropriate error messages to the search/retrieve protocol interface.
    138169
    139 '''NOTE''': this does '''not imply''', that endpoints are ''required'' support for all of CQL, but rather that they are able to ''parse'' all of CQL and generate the appropriate error message, if a query includes a feature they do not support.
    140 
    141 
    142 == CLARIN-FCS Interface Specification ==
    143 
    144 === Profiles ===
    145 
    146 Yada yada yada ...
     170'''NOTE''': this does ''not imply'', that Endpoints are ''required'' support for all of CQL, but rather that they are able to ''parse'' all of CQL and generate the appropriate error message, if a query includes a feature they do not support.
    147171
    148172
    … …  
    152176
    153177
    154 === Operations ===
     178=== Operations ===#identify
    155179
    156180Yada yada yada ...