Changes between Version 40 and Version 41 of FCS-Specification-ScrapBook


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

--

Legend:

Unmodified
Added
Removed
Modified

  • FCS-Specification-ScrapBook

    v40 v41  
    4848}}}
    4949 * `string`: the literal ''string'' must be used either as element content or attribute value
    50 Endpoints and Clients `MUST` adhere the [#REF_XML_Namespaces XML-Namespaces] specification. This specification generally does not dictate whether XML elements should be serialized in their prefixed or non-prefixed syntax, but Endpoints `MUST` ensure, that the correct XML namespace is used for elements and that XML namespaces are declared correctly. Clients `MUST` be agnostic to which syntax was used by an Endpoint to serialize XML elements, i.e. if prefixed or unprefixed variant was used, and `SHOULD` operate solely on ''expanded name'', i.e. pairs of ''namespace name'' and ''local name''.
     50Endpoints and Clients `MUST` adhere the [#REF_XML_Namespaces XML-Namespaces] specification. The CLARIN-FCS interface specification generally does not dictate whether XML elements should be serialized in their prefixed or non-prefixed syntax, but Endpoints `MUST` ensure that the correct XML namespace is used for elements and that XML namespaces are declared correctly. Clients `MUST` be agnostic to which syntax for serializing the XML elements, i.e. if the prefixed or un-prefixed variant was used, and `SHOULD` operate solely on ''expanded names'', i.e. pairs of ''namespace name'' and ''local name''.
    5151
    5252The following XML namespace names and prefixes are used throughout this specification. The column ''Recommended Syntax'' indicates, which syntax variant `SHOULD` be used by Endpoints when serializing the XML response.
    … …  
    168168The 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.
    169169
    170 Generally, CLARIN-FCS Interface Specification consists of two components, a set of ''formats'' and a ''transport protocol''. The ''Endpoint'' component is a software component that acts as a bridge between the Formats, that are send by a ''Client'' using the ''Transport Protocol'', and a ''Search Engine''. The ''Search Engine'' is a custom software component, that allows searching in the language resources of a CLARIN center. The ''Endpoint'' basically implements the ''transport protocol''  and acts as an mediator between the CLRAIN-FCS specific formats and the idiosyncrasies of ''Search Engines''. The following figure illustrates the overall architecture.
     170Generally, CLARIN-FCS Interface Specification consists of two components, a set of ''formats'' and a ''transport protocol''. The ''Endpoint'' component is a software component that acts as a bridge between the Formats, that are send by a ''Client'' using the ''Transport Protocol'', and a ''Search Engine''. The ''Search Engine'' is a custom software component, that allows searching in the language resources of a CLARIN center. The ''Endpoint'' basically implements the ''transport protocol''  and acts as an mediator between the CLARIN-FCS specific formats and the idiosyncrasies of ''Search Engines''. The following figure illustrates the overall architecture.
    171171{{{
    172172                 +---------+
    … …  
    367367||=Payload Disposition =|| ''inline'' ||
    368368The ''Geolocation'' Data View allows to geolocalize a hit. If `MUST` be encoded using the XML representation of the Keyhole Markup Language (KML). The KML fragment `MUST` comply with the specification as defined by [#REF_KML_Spec KML].
    369 
    370369 * Example:
    371370{{{#!xml
    … …  
    386385
    387386=== Endpoint Description ===
    388 
    389387Endpoints need to provide information about their capabilities to support auto-configuration of Clients, This capabilities include, among other information, the Profile that is supported by an Endpoint. The ''Endpoint Description'' mechanism provides the necessary facility to provide this information to the Clients. Endpoints `MUST` encode their capabilities using an XML format and embed this information into the SRU/CQL protocol as described in section [#explain Operation ''explain'']. The XML fragment generated by the Endpoint for the Endpoint Description `MUST` be valid according to the XML schema "[source:FederatedSearch/schema/Endpoint-Description.xsd Endpoint-Description.xsd]" ([source:FederatedSearch/schema/Endpoint-Description.xsd?format=txt download]).
    390388
    … …  
    412410   If a collection has searchable sub-collections the Endpoint `MUST` supply additional finer grained collection elements, which are wrapped in a `<ed:Collections>` element. A sub-collection is a searchable entity within a collection, e.g. a sub-corpus.
    413411
    414 [=#REF_ED_Example_1]Example 1:
     412[=#REF_Example_4]Example 4:
    415413{{{#!xml
    416414<ed:EndpointDescription xmlns:ed="http://clarin.eu/fcs/1.0/endpoint-description">
    … …  
    434432</ed:EndpointDescription>
    435433}}}
    436 This [#REF_ED_Example_1 example] shows a simple Endpoint Description for an Endpoint that supports the ''basic'' Profile and only provides the Generic Hits Data View. It only provides one top-level collection identified by the persistent identifier `http://hdl.handle.net/4711/0815`. The collection a title as well as a description in German and English. A landing page is located at `http://repos.example.org/corpus1.html`. The searchable collection contents are only available in German.
    437 
    438 [=#REF_ED_Example_2]Example 2:
     434This [#REF_Example_4 example] shows a simple Endpoint Description for an Endpoint that supports the ''basic'' Profile and only provides the Generic Hits Data View. It only provides one top-level collection identified by the persistent identifier `http://hdl.handle.net/4711/0815`. The collection a title as well as a description in German and English. A landing page is located at `http://repos.example.org/corpus1.html`. The searchable collection contents are only available in German.
     435
     436[=#REF_Example_5]Example 5:
    439437{{{#!xml
    440438<ed:EndpointDescription xmlns:ed="http://clarin.eu/fcs/1.0/endpoint-description">
    … …  
    488486</ed:EndpointDescription>
    489487}}}
    490 This more complex [#REF_ED_Example_2 example] show a Endpoint Description for an Endpoint that, similar to [#REF_ED_Example_1 Example 1], supports the ''basic'' profile. In addition to the Generic Hits Data View it also supports CMDI the CMDI Data View. The Endpoint has two top-level collections (identified by the persistent identifiers `http://hdl.handle.net/4711/0815` and `http://hdl.handle.net/4711/0816`. The second top-level collection has two sub-collections, identified by the persistent identifier `http://hdl.handle.net/4711/0816-1` and `http://hdl.handle.net/4711/0816-2`. All collections are described using several properties, like title, description, etc.
     488This more complex [#REF_Example_5 example] show a Endpoint Description for an Endpoint that, similar to [#REF_Example_4 Example 4], supports the ''basic'' profile. In addition to the Generic Hits Data View it also supports CMDI the CMDI Data View. The Endpoint has two top-level collections (identified by the persistent identifiers `http://hdl.handle.net/4711/0815` and `http://hdl.handle.net/4711/0816`. The second top-level collection has two sub-collections, identified by the persistent identifier `http://hdl.handle.net/4711/0816-1` and `http://hdl.handle.net/4711/0816-2`. All collections are described using several properties, like title, description, etc.
    491489
    492490