A Data View serves as a container for representing search results within CLARIN-FCS. Data Views are designed to allow for different representations of results. This specification defines supplementary Data Views beyond the Generic Hits Data View and Advanced Data View, that is defined as part of the CLARIN-FCS Core 2.0 specification. For detailed information as to what Data Views are and how they are integrated in CLARIN-FCS, see [ref:CLARIN-FCSCore20].
|
Note
|
The examples in the following sections show only the payload with the enclosing <fcs:DataView> element of a Data View. Of course, the Data View must be embedded either in a <fcs:Resource> or a <fcs:ResourceFragment> element. The @pid and @ref attributes have been omitted for all inline payload types.
|
The Generic Hits (HITS) Data View is an integral part of the Core specification and serves as the as the most basic agreement in CLARIN-FCS for the serialization of search results. For details about this Data View, see the Core specification CLARIN-FCS-Core 1.0 or 2.0, Section "Generic Hits (HITS)".
The Advanced (ADV) Data View is an integral part of the Core 2.0 specification and serves as the as the agreement in CLARIN-FCS for the serialization of CLARIN-FCS 2.0 Advanced Search results. For details about this Data View, see the Core specification CLARIN-FCS-Core 2.0, Section "Advanced (ADV)".
Description |
A CMDI metadata record |
|---|---|
MIME type |
|
Payload Disposition |
inline or reference |
Payload Delivery |
send-by-default ( |
Recommended Short Identifier |
|
The Component Metadata Data View allows the embedding of a CMDI metadata record that is applicable to the specific context into the Endpoint response, e.g. metadata about the resource in which the hit was produced. If this CMDI record is applicable for the entire Resource, it SHOULD be put in a <fcs:DataView> element below the <fcs:Resource> element. If it is applicable to the Resource Fragment, i.e. it contains more specialized metadata than the metadata for the encompassing resource, it SHOULD be put in a <fcs:DataView> element below the <fcs:ResourceFragment> element. Endpoints SHOULD provide the payload inline, but Endpoints MAY also use the reference method. If an Endpoint uses the reference method, the CMDI metadata record MUST be downloadable without any restrictions.
link:examples/cmdi-inline.xml[role=include]link:examples/cmdi-referenced.xml[role=include]Description |
An image related to the hit |
|---|---|
MIME type |
|
Payload Disposition |
reference |
Payload Delivery |
need-to-request ( |
Recommended Short Identifier |
|
The Image Data View provides an image that is relevant to the hit, e.g. a facsimile of the source of a transcription. Endpoints MUST provide the payload by the reference method and the image file SHOULD be downloadable without any restrictions.
link:examples/image-referenced.xml[role=include]Description |
An geographic location related to the hit |
|---|---|
MIME type |
|
Payload Disposition |
inline |
Payload Delivery |
need-to-request ( |
Recommended Short Identifier |
|
The 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].
link:examples/kml-inline.xml[role=include]