org.protempa.backend.tsb

Class AbstractTermSourceBackend

java.lang.Object

org.protempa.backend.AbstractBackend<TermSourceBackendUpdatedEvent>

org.protempa.backend.tsb.AbstractTermSourceBackend

All Implemented Interfaces:

Backend<TermSourceBackendUpdatedEvent>, TermSourceBackend

Direct Known Subclasses:

AbstractCommonsTermSourceBackend, MockTermSourceBackend

public abstract class AbstractTermSourceBackend
extends AbstractBackend<TermSourceBackendUpdatedEvent>
implements TermSourceBackend

Author:

Michel Mansour

Constructor Summary

Constructors

Constructor and Description
AbstractTermSourceBackend()

Method Summary

Modifier and Type	Method and Description
void	close() Implemented as a no-op
protected void	fireTermSourceBackendUpdated()
String	getDisplayName() A default implementation that returns null
List<String>	getSubsumption(String id) A default implementation that returns null
Term	readTerm(String id) A default implementation that returns null
Map<String,Term>	readTerms(String[] ids) A default implementation that returns null

Methods inherited from class org.protempa.backend.AbstractBackend

addBackendListener, fireBackendUpdated, fireEvent, fireUnrecoverableError, getConfigurationsId, getId, initialize, removeBackendListener, setEventListeners, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.backend.Backend

addBackendListener, getConfigurationsId, getId, initialize, removeBackendListener, setEventListeners

Constructor Detail

AbstractTermSourceBackend

public AbstractTermSourceBackend()

Method Detail

readTerm

public Term readTerm(String id)
              throws TermSourceReadException

A default implementation that returns null

Specified by:

readTerm in interface TermSourceBackend

Parameters:

id - the term to find

Returns:

a Term matching the given term in the given terminology

Throws:

TermSourceReadException - if the TermSource is unreadable

See Also:

TermSourceBackend.readTerm(java.lang.String)

readTerms

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

A default implementation that returns null

Specified by:

readTerms in interface TermSourceBackend

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

See Also:

TermSourceBackend.readTerms(String[])

close

public void close()

Implemented as a no-op

Specified by:

close in interface Backend<TermSourceBackendUpdatedEvent>

See Also:

Backend.close()

getDisplayName

public String getDisplayName()

A default implementation that returns null

Specified by:

getDisplayName in interface Backend<TermSourceBackendUpdatedEvent>

Returns:

a String.

See Also:

Backend.getDisplayName()

getSubsumption

public List<String> getSubsumption(String id)
                            throws TermSourceReadException

A default implementation that returns null

Specified by:

getSubsumption in interface TermSourceBackend

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

See Also:

TermSourceBackend.getSubsumption(java.lang.String)

fireTermSourceBackendUpdated

protected void fireTermSourceBackendUpdated()