it.uniroma2.art.coda.converters.contracts

Interface RandomIdGenerator

All Superinterfaces:

Converter

All Known Implementing Classes:

TemplateBasedRandomIdGenerator

@Description(value="Randomic converter. Generates a URI concatenating a prefix with a 8-digits hexadecimal randomic char sequence. The converter takes two input parameters:\n\t- xRole: tells the nature of the resource. Available\n\t- args: a map of further optional arguments. They depends on the xRole parameter as follow:\n\t\t- concept (for skos:Concepts)\n\t\t\t- label: the accompanying preferred label of the skos:Concept (or literal form of the accompanying xLabel)skos:Concept\n\t\t\t- schemes: the concept schemes to which the concept is being attached at the moment of its creation (serialized as a Turtle collection)\n\t\t- conceptScheme (for skos:ConceptSchemes)\n\t\t\t- label: the accompanying preferred label of the skos:Concept (or literal form of the accompanying xLabel)\n\t\t- skosCollection (for skos:Collections)\n\t\t\t- label: the accompanying preferred label of the skos:Collection (or literal form of the accompanying xLabel)\n\t\t- xLabel (for skosxl:Labelss)\n\t\t\t- lexicalForm: the lexical form of the skosxl:Label\n\t\t\t- lexicalizedResource: the resource to which the skosxl:Label will be attached to\n\t\t\t- lexicalizationProperty: the property used for attaching the label\n\t\t- xNote (for reified skos:notes)\n\t\t\t- value: the content of the note\n\t\t\t- annotatedResource: the resource being annotated\n\t\t\t- noteProperty: the property used for annotation\n\t\t- A custom prefix that will be placed befor the randomic sequence.")
public interface RandomIdGenerator
extends Converter

A converter compliant with the RandomIdGenerator contract generates resource identifiers in a random manner, i.e. producing different outputs for the same arguments. Its identifier is "http://art.uniroma2.it/coda/contracts/randIdGen".

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RandomIdGenerator.PARAMETERS
static class	RandomIdGenerator.XRoles

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTRACT_URI

Fields inherited from interface it.uniroma2.art.coda.interfaces.Converter

OSGI_SERVICE_PROPERTY_CONTRACT, OSGI_SERVICE_PROPERTY_CONVERTER, STATIC_FIELD_CONTRACT_URI, STATIC_FIELD_CONVERTER_URI

Method Summary

Modifier and Type	Method and Description
org.eclipse.rdf4j.model.IRI	produceURI(CODAContext ctx, String value) An overload of produceURI(CODAContext, String, String, Map) without an explicit xRole and parameter map.
org.eclipse.rdf4j.model.IRI	produceURI(CODAContext ctx, String value, String xRole) An overload of produceURI(CODAContext, String, String, Map) without an explicit parameter map.
org.eclipse.rdf4j.model.IRI	produceURI(CODAContext ctx, String value, String xRole, Map<String,org.eclipse.rdf4j.model.Value> args) Returns a resource identifier produced randomly from the given inputs.

Field Detail

CONTRACT_URI

static final String CONTRACT_URI

See Also:

Constant Field Values

Method Detail

produceURI

@FeaturePathArgument(requirementLevel=IGNORED)
org.eclipse.rdf4j.model.IRI produceURI(CODAContext ctx,
                                                                                       String value,
                                                                                       @Parameter(name="xRole")
                                                                                       String xRole,
                                                                                       @Parameter(name="args")
                                                                                       Map<String,org.eclipse.rdf4j.model.Value> args)
                                                                                throws ConverterException

Returns a resource identifier produced randomly from the given inputs. 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 (or literal form of the accompanying xLabel)
  skos:Concept
  • schemes (optional): the concept schemes to which the concept is being attached at the moment of its creation (serialized as a Turtle collection)
• conceptScheme (for skos:ConceptSchemes)
  • label (optional): the accompanying preferred label of the skos:Concept (or literal form of the accompanying xLabel)
  skos:Concept
• skosCollection (for skos:Collections)
  • label (optional): the accompanying preferred label of the skos:Collection (or literal form of the accompanying xLabel)
• xLabel (for skosxl:Labelss)
  • lexicalForm: the lexical form of the skosxl:Label
  • lexicalizedResource: the resource to which the skosxl:Label will be attached to
  • lexicalizationProperty: the property used for attaching the label
• xNote
(for reified skos:notes)
• value: the content of the note
• annotatedResource: the resource being annotated
• noteProperty: the property used for annotation

The parameters requested by additional xRoles are defined elsewhere by the party defining that xRole. Users of this contract 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 converter implementing this contract to verify that all relevant information has been provided by the client. In fact, it is suggested that converters are implemented 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:

ctx - the conversion context

value - the value seeding the generation of the identifier (ignored in this case)

xRole - an extension of the notion of role (see RDFResourceRolesEnum), allowing for finer grained distinctions

args - additional arguments, depending on the specific type of identifier

Returns:

Throws:

ConverterException

produceURI

@FeaturePathArgument(requirementLevel=IGNORED)
org.eclipse.rdf4j.model.IRI produceURI(CODAContext ctx,
                                                                                       String value,
                                                                                       @Parameter(name="xRole")
                                                                                       String xRole)
                                                                                throws ConverterException

An overload of produceURI(CODAContext, String, String, Map) without an explicit parameter map.

Parameters:

ctx -

value -

xRole -

Returns:

Throws:

ConverterException

produceURI

@FeaturePathArgument(requirementLevel=IGNORED)
org.eclipse.rdf4j.model.IRI produceURI(CODAContext ctx,
                                                                                       String value)
                                                                                throws ConverterException

An overload of produceURI(CODAContext, String, String, Map) without an explicit xRole and parameter map.

Parameters:

ctx -

value -

Returns:

Throws:

ConverterException