uk.ac.ebi.microarray.zooma.service
Interface OntologyRankingService

public interface OntologyRankingService

A service interface that can be used to rank ontologies in preference order.

Author:

Tony Burdett

Method Summary

void	addAlias(java.lang.String ontologyName, java.lang.String alias) Adds an alias to the given ontology name.
java.util.Collection<java.lang.String>	getAliases(java.lang.String ontologyName) Gets a collection of the aliases assigned to a named ontology.
void	rankOntologies(java.util.List<java.lang.String> ontologyNames) Ranks ontologies, by name, in preference order.
void	removeAlias(java.lang.String ontologyName, java.lang.String alias) Removes the association between a given alias and the ontology named.

Method Detail

rankOntologies

void rankOntologies(java.util.List<java.lang.String> ontologyNames)

Ranks ontologies, by name, in preference order. The name specified here is the name ZOOMA uses internally, and can be set to point to several aliases.

Parameters:

ontologyNames - a list of ontology names, sorted by preference order

addAlias

void addAlias(java.lang.String ontologyName,
              java.lang.String alias)

Adds an alias to the given ontology name. Effectively, this simply acts as a key-value pair, where the values are references to ontologies by their name as specified in other services.

Parameters:

ontologyName - the ZOOMA-assigned name for an ontology

alias - the alias assigned to this ontology in a remote resource

removeAlias

void removeAlias(java.lang.String ontologyName,
                 java.lang.String alias)

Removes the association between a given alias and the ontology named.

Parameters:

ontologyName - the ZOOMA-assigned name for an ontology

alias - the alias being removed

getAliases

java.util.Collection<java.lang.String> getAliases(java.lang.String ontologyName)

Gets a collection of the aliases assigned to a named ontology.

Parameters:

ontologyName - the name of the ontology we want aliases for

Returns:

a collection of assigned aliases