uk.ac.soton.itinnovation.registry.management.icomponent.configuration
Interface Configuration

All Known Implementing Classes:

XmlConfigurationFacility

public interface Configuration

Method Summary

void	createConcept(String concept) Gets or creates a concept in the registry domain model.
void	createConcept(String concept, String superConcept) Creates a concept in the registry domain model that is a sub concept of another concept.
void	deleteConcept(String concept) Removes a concept from the domain model.
void	deleteRelationship(String fromConceptId, String relationshipName, String toConceptId) Removes a relationship between two concepts.
void	deleteRelationships(String fromConceptId, String toConceptId) Removes all relationships between two concepts.
RegistryDomainModel	getRegistryDomainModel() Get the current used registry domain model.
void	insertBidirectionalRelationship(String fromConceptId, String relationshipFromToTo, String relationshipToToFrom, String toConceptId) Inserts a bidirectional relationship between two entities specified by their ids.
void	insertRelationship(String fromConceptId, String relationshipName, String toConceptId) Stores a relationship with specific name between two entities specified by their ids.
void	registerPredefinedQuery(String name, String query, String... parameterNames) Registration of predefined queries.
void	setPredefinedQueries(String filename) Set up predefined queries.
void	setPredefinedQueries(URI uri) Set up predefined queries.
void	setRegistryDomainModel(RegistryDomainModel model) The a new registry domain model.

Method Detail

setRegistryDomainModel

void setRegistryDomainModel(RegistryDomainModel model)
                            throws ConfigurationException

The a new registry domain model. The old one will be overwritten.

Parameters:

model - the new registry domain model.

Throws:

ConfigurationException

getRegistryDomainModel

RegistryDomainModel getRegistryDomainModel()
                                           throws ConfigurationException

Get the current used registry domain model.

Returns:

the registry domain model

Throws:

ConfigurationException

createConcept

void createConcept(String concept)
                   throws ConfigurationException

Gets or creates a concept in the registry domain model.

Parameters:

concept -

Throws:

RegistrationException

ConfigurationException

createConcept

void createConcept(String concept,
                   String superConcept)
                   throws ConfigurationException

Creates a concept in the registry domain model that is a sub concept of another concept.

Parameters:

concept - concept to be created

superConcept - super or parent concept

Throws:

ConfigurationException

deleteConcept

void deleteConcept(String concept)
                   throws ConfigurationException

Removes a concept from the domain model.

Parameters:

concept -

Throws:

RegistrationException

ConfigurationException

insertBidirectionalRelationship

void insertBidirectionalRelationship(String fromConceptId,
                                     String relationshipFromToTo,
                                     String relationshipToToFrom,
                                     String toConceptId)
                                     throws ConfigurationException

Inserts a bidirectional relationship between two entities specified by their ids.

Parameters:

fromConceptId -

relationshipFromToTo -

relationshipToToFrom -

toConceptId -

Throws:

XMLDBException

ConfigurationException

insertRelationship

void insertRelationship(String fromConceptId,
                        String relationshipName,
                        String toConceptId)
                        throws ConfigurationException

Stores a relationship with specific name between two entities specified by their ids.

Parameters:

fromConceptId -

relationshipName -

toConceptId -

Throws:

RegistrationException

ConfigurationException

deleteRelationships

void deleteRelationships(String fromConceptId,
                         String toConceptId)
                         throws ConfigurationException

Removes all relationships between two concepts.

Parameters:

fromConceptId -

toConceptId -

Throws:

RegistrationException

ConfigurationException

deleteRelationship

void deleteRelationship(String fromConceptId,
                        String relationshipName,
                        String toConceptId)
                        throws ConfigurationException

Removes a relationship between two concepts.

Parameters:

fromConceptId -

relationshipName -

toConceptId -

Throws:

ConfigurationException

registerPredefinedQuery

void registerPredefinedQuery(String name,
                             String query,
                             String... parameterNames)
                             throws ConfigurationException

Registration of predefined queries.

Parameters:

name - unique name of the predefined, parameterised query.

query - query expression.

parameterNames - parameter names used within the query.

Throws:

RegistrationException

ConfigurationException

setPredefinedQueries

void setPredefinedQueries(String filename)
                          throws ConfigurationException

Set up predefined queries. Existing queries are deleted.

Parameters:

filename -

Throws:

ConfigurationException

setPredefinedQueries

void setPredefinedQueries(URI uri)
                          throws ConfigurationException

Set up predefined queries. Existing queries are deleted.

Parameters:

uri -

Throws:

ConfigurationException