org.apache.stanbol.ontologymanager.servicesapi.session

Interface SessionIDGenerator

All Known Subinterfaces:

SessionIDGenerator

public interface SessionIDGenerator

Implementations of this interface provide algorithms for generating valid identifiers for KReS sessions. These algorithms should take into account the need for excluding existing session IDs.

Author:

alexdma

Method Summary

Methods

Modifier and Type	Method and Description
String	createSessionID() Generates a new context-free session ID.
String	createSessionID(Set<String> exclude) Generates a new session ID that is different from any IRI in the exclude set.
org.semanticweb.owlapi.model.IRI	getBaseIRI() Returns the base IRI for all generated IDs to start with.
void	setBaseIRI(org.semanticweb.owlapi.model.IRI baseIRI) Sets the base IRI for all generated IDs to start with.

Method Detail

createSessionID

String createSessionID()

Generates a new context-free session ID. Whether this causes duplicate IDs, it should be care of the object that invoked this method to check it.

Returns:

the newly generated session ID.

createSessionID

String createSessionID(Set<String> exclude)

Generates a new session ID that is different from any IRI in the exclude set. Whether this causes duplicate IDs (supposing the exclude set does not include all of them), it should be care of the object that invoked this method to check it.

Parameters:

exclude - the set of IRIs none of which the generate ID must be equal to.

Returns:

the newly generated session ID.

getBaseIRI

org.semanticweb.owlapi.model.IRI getBaseIRI()

Returns the base IRI for all generated IDs to start with. It should be used by all createSessionID() methods, or ignore if null.

Parameters:

baseIRI - the base IRI.

setBaseIRI

void setBaseIRI(org.semanticweb.owlapi.model.IRI baseIRI)

Sets the base IRI for all generated IDs to start with. It should be used by all createSessionID() methods, or ignore if null.

Parameters:

baseIRI - the base IRI.