org.phenotips.vocabulary.script

Class VocabularyScriptService

java.lang.Object

org.phenotips.vocabulary.script.VocabularyScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Unstable
 @Component
 @Named(value="vocabularies")
 @Singleton
public class VocabularyScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Provides access to the available vocabularies and their terms to public scripts.

Since:

1.2M4 (under different names since 1.0M8)

Version:

$Id: e0cd953c5fd4dc1a18c1a7b5bc199719fdda39b7 $

Constructor Summary

Constructors

Constructor and Description
VocabularyScriptService()

Method Summary

Modifier and Type	Method and Description
Vocabulary	get(String vocabularyId) Retrieve a vocabulary given its identifier.
List<String>	getAvailableVocabularies() Retrieves a list of vocabulary ids that are available for use with getVocabulary(String).
Vocabulary	getVocabulary(String vocabularyId) Retrieve a vocabulary given its identifier.
VocabularyTerm	resolveTerm(String termId) Retrieve a term from its owner vocabulary.
List<VocabularyTerm>	search(String input, String category, int maxResults) Suggest the terms that best match the user's input, in all vocabularies supporting the target category of terms.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VocabularyScriptService

public VocabularyScriptService()

Method Detail

resolveTerm

public VocabularyTerm resolveTerm(String termId)

Retrieve a term from its owner vocabulary. For this to work properly, the term identifier must contain a known vocabulary prefix.

Parameters:

termId - the term identifier, in the format <vocabulary prefix>:<term id>, for example HP:0002066

Returns:

the requested term, or null if the term doesn't exist in the vocabulary, or no matching vocabulary is available

getVocabulary

public Vocabulary getVocabulary(String vocabularyId)

Retrieve a vocabulary given its identifier.

Parameters:

vocabularyId - the vocabulary identifier, which is also used as a prefix in every term identifier from that vocabulary, or a known alias for it, for example MIM, hpo, HP or HPO

Returns:

the requested vocabulary, or null if it doesn't exist or isn't available in the platform

get

public Vocabulary get(String vocabularyId)

Retrieve a vocabulary given its identifier. This is a shortcut for getVocabulary(String) which allows scripts to use the shorter $services.vocabularies.hpo notation for accessing a vocabulary.

Parameters:

vocabularyId - the vocabulary identifier, which is also used as a prefix in every term identifier from that vocabulary, or a known alias for it, for example MIM, HP or HPO

Returns:

the requested vocabulary, or null if it doesn't exist or isn't available in the platform

getAvailableVocabularies

public List<String> getAvailableVocabularies()

Retrieves a list of vocabulary ids that are available for use with getVocabulary(String).

Returns:

a list of vocabulary identifiers, one for each vocabulary

Since:

1.3

search

public List<VocabularyTerm> search(String input,
                                   String category,
                                   int maxResults)

Suggest the terms that best match the user's input, in all vocabularies supporting the target category of terms.

Parameters:

input - the text to search for

category - the category of terms to search in

maxResults - the maximum number of terms to be returned

Returns:

a list of suggestions, possibly empty

Since:

1.4