This XML schema defines the inner structure of a hit within the
search result in the CLARIN federated content search (CLARIN-FCS).
Every hit in the result set must be represented as one
<sru:record> element in the
<sru:searchRetrieveResponse;gt; response
document.
This schema allows Endpoint to return:
metadata about the matched record, including
reference to a CMDI record
separate (metadata) description of full
Resource and ResourceFragment (matching part of the
resource, i.e. an addressable sentence)
various views on the data delivered (HITS, text-snippet,
image, individual annotation-layers, ...)
providing links (either as PID or as
simple URLs) to any of: Resource, ResourceFragment,
Metadata (CMDI record), Data Views
Endpoint specific extensions through an
extension mechanism
A one hit in a resource in one or more representations.
A one hit in a resource in one or more representations.
Use this instead of a plain <Resource>, if the
fragment can be addresses directly, e.g. a sentence in
a corpus that can be addressed via a PID (with fragment)
or a regular URI.
Extension point to allow Endpoints to add custom data to a resource.
CLARIN-FCS clients SHOULD ignore any data they do not understand.
This extension mechanism can for example be used to provide hints
to an (XSLT/XQuery) application that works directly on CLARIN-FCS,
e.g. to allow it to generate back and forward links to
navigate in the result set.
A representation of a hit, e.g. a HITS, a Geolocation,
an image, etc.
A HITS Data View is mandatory for every hit in the result set.
The type of the content of the Data View as a MIME type.
For the mandatory HITS Data View, use the MIME type
application/x-clarin-fcs-hits+xml.
A persistent identifier of given entity. This attribute
should be used, if a PID is available for the given entity.
An Endpoint SHOULD also make the PID available tough the
<sru:recordIdentifier> element of
the <sru:record>/ element.
If more PIDs are available for one record (i.e. Resource,
Metadata, the individual Data View), the Endpoint is MUST
to put the "most important" (e.g. the primary) PID into the
<sru:recordIdentifier> element.
A regular URI for the given entity, that can be retrieved
directly (via HTTP or HTTPS).
This URI may include custom Endpoint specific query strings
to implement features like hit highlighting.