This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.

Architecture Management - Link Type Format

1.0 SPECIFICATION DRAFT

Introduction

A link type represents type of link that is or can be used when defining links from AM resources. The type has an ID (expressed as a URI), whose universally accepted semantics may be defined elsewhere. This resource represents the definition as it is used by this service provider. It is meant to make it easy for clients to get a list of known or registered link types with human readable definitions that can be used in client user interfaces.

Namespaces

The media type used for this RDF/XML representation MUST be application/x-oslc-am-linktype+xml.

The resource is a valid XML document with a <rdf:Description> root element. This root element MUST define an rdf:about atrribute whose value represents the ID or URI of the link type.

The following properties are defined as XML child elements for link type resources:

Property Required on Read Required on Write Read-only Represents
dc:title Yes Yes No The short label for the link type.
dc:description No No No Some description of the link type. Expected to be used in user interfaces to help explain the semantics of the link type.
dc:creator No No Yes Who added the link type to the service provider as a supported link type. The value of this element MAY be free form text, or MAY be a FOAF Person element. If the user has a URI it SHOULD be represented as a rdf:resource attribute of this element.
dc:created No No Yes When the link type was added to the service provider. Can be expressed as free form text, or in a standard form. When in a form that can be automated, the rdf:datatype attribute with a public date time URI SHOULD be present to assist the client in parsing the value (i.e. http://www.w3.org/2001/XMLSchema#dateTime).
dc:contributor No No Yes Who last modified the link type description or label. The value of this element MAY be free form text, or MAY a FOAF Person element. If the user has a URI it SHOULD be represented as a rdf:resource attribute of this element.
dc:modified No No Yes When the link type was last modified. MAY be expressed as free form text, or in a standard form. When in a form that can be automated, the rdf:datatype property with a public date time URI SHOULD be present to assist the client in parsing the value (i.e. http://www.w3.org/2001/XMLSchema#dateTime).

Examples

Example 1. All optional elements included, FOAF identities

<rdf:RDF 
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:dc="http://purl.org/dc/terms/">

  <rdf:Description rdf:about="http://example.com/linktype/depends">

    <dc:title>Depends</dc:title>

    <dc:description>
       The source end of this link depends on the target end.
    </dc:description> 

    <dc:created rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">
       2009-10-20T19:49:47-04:00
    </dc:created>

    <dc:creator rdf:resource="https://example.com/users/dan">
       <foaf:Person>
          <foaf:name>Dan Designer</foaf:name>
          <foaf:mbox rdf:resource="mailto:dan@example.com" />
          <foaf:img rdf:resource="https://example.com/users/photo/dan" />
       </foaf:Person>
    </dc:creator>

    <dc:modified rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">
       2009-11-03T08:53:00-04:00
    </dc:modified>

    <dc:contributor rdf:resource="https://example.com/users/ana">
       <foaf:Person>
         <foaf:name>Ana Analyst</foaf:name>
         <foaf:mbox rdf:resource="mailto:ana@example.com" />
         <foaf:img rdf:resource="https://example.com/users/photo/ana" />
       </foaf:Person>
    </dc:contributor>

  </rdf:Description>

</rdf:RDF> 

Example 2. Only Required Return Elements

In this example the link type is externally defined (leveraging the Dublin Core term license), and specified in the rdf:about attribute.

<rdf:RDF 
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:dc="http://purl.org/dc/terms/">

  <rdf:Description rdf:about="http://purl.org/dc/terms/license">
    <dc:title>Distribution License</dc:title>
  </rdf:Description>

</rdf:RDF> 

Example 3. All simple user identities

<rdf:RDF
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:dc="http://purl.org/dc/terms/">

  <rdf:Description rdf:about="http://example.com/linktype/depends">

   <dc:title>Depends</dc:title>
   <dc:description>
      The source end of this link depends on the target end.
   </dc:description>

   <dc:created rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">
      2009-10-20T19:49:47-04:00
   </dc:created>
   <dc:creator>Dan Developer</dc:create>

</rdf:RDF> 

Comments

Enter your comments here.

Where is this link type used? OSLC Common Link doesn't use it and the rdf:predicate plays the role of the link type in the reified statement.

-- JimAmsden - 27 Oct 2009

The link type is provided by one of the services as a means for a client to determine what link types have been added or registered with the service provider. This is expected to be used by user interfaces to provide users with a list of link types to select from.

-- JimConallen - 13 Nov 2009

 

Back to Architecture Management Resource Definitions

-- JimConallen - 07 Oct 2009

Edit | Attach | Print version | History: r11 < r10 < r9 < r8 < r7 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r8 - 04 Mar 2010 - 16:24:41 - JimConallen
 
This site is powered by the TWiki collaboration platform Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback