it.uniroma2.art.semanticturkey.plugin.extpts

Interface URIGenerator

All Known Implementing Classes:

CODAURIGenerator, NativeTemplateBasedURIGenerator

public interface URIGenerator

Extension point for the generation of URIs. Such a generation is performed, when it is not possible or desired to generate a URI based on a provided local name.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	URIGenerator.Parameters
static class	URIGenerator.Roles

Method Summary

Methods

Modifier and Type	Method and Description
ARTURIResource	generateURI(STServiceContext stServiceContext, String xRole, Map<String,ARTNode> args) Generates a new URI for the identification of a resource.

Method Detail

generateURI

ARTURIResource generateURI(STServiceContext stServiceContext,
                         String xRole,
                         Map<String,ARTNode> args)
                           throws URIGenerationException

Generates a new URI for the identification of a resource. The parameter xRole holds the nature of the resource that will be identified with the given URI. Depending on the value of the parameter xRole, a conforming converter may generate differently shaped URIs, possibly using specific arguments passed via the map args. For each specific xRole, the client should provide some agreed-upon parameters to the converters. This contract defines the following parameters:

• concept (for skos:Concepts)
  • label (optional): the accompanying preferred label of the skos:Concept
  • scheme (optional): the concept scheme to which the concept is being attached at the moment of its creation
• conceptScheme (for skos:ConceptSchemes)
  • label (optional): the accompaying preferred label of the skos:Concept
• xLabel (for skosxl:Labelss)
  • lexicalForm: the lexical form of the skosxl:Label without its language tag
  • lexicalizedResource: the resource to which the skosxl:Label will be attached to
  • type: the property used for attaching the label
• xNote
(for reified skos:notes)
• value: the content of the note
• annotatedResource: the resource being annotated
• type: the property used for annotation

The parameters requested by additional xRoles are defined elsewhere by the party defining that xRole. Users of this extension point should always supply values for the required parameters associated with an xRole; therefore, they should not attempt to generate a URI for an xRole unless they known what arguments are requested. Conversely, it is a duty of the specific implementation of this extension point to verify that all relevant information has been provided by the client. In fact, it is suggested that implementations act defensively, that is to say they should:

• complain only about the absence of absolutely required parameters
• handle unknown xRoles gracefully, by means some fallback strategy

Parameters:

stServiceContext -

xRole -

args -

Returns:

Throws:

URIGenerationException