KRSMS Semantic Annotation Language

This is version 9. It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

SMS Semantic-Annotation XML Interchange Format

An annotation is composed of three parts:

1. Resources. These are the objects being annotated (referred to). Typically there will only be one resource. We currently provide support for resources that are datasets, actors as a whole, or actor input and output ports.
2. Semantic Types. These are ontology-based (i.e., concept) descriptions of the classifications of the resources. Typically there will be only one semantic type for a resource(s).
3. Encodings. These are optional sets of expressions that link portions of resources to portions of the semantic types. An encoding links the two items, thus describing how the semantic types are "realized" within the resources.

An annotation takes the following form, expressed in XML:

<sms:Annotation ID="...">

   <sms:Resources>

      ...

   </sms:Resources>

   <sms:SemanticTypes>

      ...

   </sms:SemanticTypes>

   <sms:Encodings>

      ...

   </sms:Encodings>

</sms:Annotation>

Note that every annotation should have a unique identifier, preferably an LSID. We describe each of the annotation subelements in turn below.

Resources

A resource can take one of the following three forms, depending its resource type (i.e., dataset, actor, or actor input/output port):

<sms:Dataset resource="..."/>

<sms:Actor resource="..."/>

<sms:ActorPort portName="..." resource="..."/>

The Dataset tag designates a dataset resource, whose resource identifier is given via the resource attribute. A dataset identifier is a unique identifier (e.g., an LSID) for the dataset, and we assume that the dataset identifier can be used (via additional tools) to retrieve the actual dataset.

Similarly, the Actor tag designates an actor resource and the resource attribute the unique identifier for the actor being reference.

Finally, the ActorPort tag denotes a port of an actor. The portName attribute specifies the port for an actor identified via the resource attribute.

A Resources element in an annotation must specify at least one resource subelement (either Dataset, Actor, or ActorPort). More than one resource subelement is permitted. For each subelement, the resource is attribute is required. In addition, for ActorPort elements, the portName attribute is required.

Semantic Types