org.protempa.backend.tsb

Interface TermSourceBackend

All Superinterfaces:

Backend<TermSourceBackendUpdatedEvent>

All Known Implementing Classes:

AbstractCommonsTermSourceBackend, AbstractTermSourceBackend, MockTermSourceBackend

public interface TermSourceBackend
extends Backend<TermSourceBackendUpdatedEvent>

Interface for term source backends

Author:

Michel Mansour

Method Summary

Modifier and Type	Method and Description
List<String>	getSubsumption(String id) Retrieves all of the descendants of the term specified by the given ID.
Term	readTerm(String id) Reads a term from the given terminology
Map<String,Term>	readTerms(String[] ids) Reads an array of terms from the given terminology

Methods inherited from interface org.protempa.backend.Backend

addBackendListener, close, getConfigurationsId, getDisplayName, getId, initialize, removeBackendListener, setEventListeners

Method Detail

readTerm

Term readTerm(String id)
       throws TermSourceReadException

Reads a term from the given terminology

Parameters:

id - the term to find

Returns:

a Term matching the given term in the given terminology

Throws:

TermSourceReadException - if the TermSource is unreadable

readTerms

Map<String,Term> readTerms(String[] ids)
                    throws TermSourceReadException

Reads an array of terms from the given terminology

Parameters:

ids - the terms to find

Returns:

an array of Terms matching the given terms in the given terminology

Throws:

TermSourceReadException - if the TermSource is unreadable

getSubsumption

List<String> getSubsumption(String id)
                     throws TermSourceReadException

Retrieves all of the descendants of the term specified by the given ID. In this case, the descendants include the given term itself.

Parameters:

id - the term whose descendants are to be retrieved

Returns:

a List of Strings that are the term IDs of the descendents of the given term

Throws:

TermSourceReadException - if the TermSource is unreadable