org.protempa.backend.ksb

Class AbstractKnowledgeSourceBackend

java.lang.Object

org.protempa.backend.AbstractBackend<KnowledgeSourceBackendUpdatedEvent>

org.protempa.backend.ksb.AbstractKnowledgeSourceBackend

All Implemented Interfaces:

Backend<KnowledgeSourceBackendUpdatedEvent>, KnowledgeSourceBackend

Direct Known Subclasses:

AbstractCommonsKnowledgeSourceBackend, SimpleKnowledgeSourceBackend

public abstract class AbstractKnowledgeSourceBackend
extends AbstractBackend<KnowledgeSourceBackendUpdatedEvent>
implements KnowledgeSourceBackend

Skeletal implementation of the KnowledgeSourceBackend interface to minimize the effort required to implement this interface.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
AbstractKnowledgeSourceBackend()

Method Summary

Modifier and Type	Method and Description
void	close() Implemented as a no-op.
protected void	fireKnowledgeSourceBackendUpdated() Notifies registered listeners that the backend has been updated.
String[]	getPropositionsByTerm(String termId) A default implementation that returns an empty list.
List<String>	getPropositionsByTermSubsumption(And<TermSubsumption> termId) A default implementation that returns an empty List.
ValueSet	readValueSet(String id) A default implementation that returns null.

Methods inherited from class org.protempa.backend.AbstractBackend

addBackendListener, fireBackendUpdated, fireUnrecoverableError, getConfigurationsId, getId, initialize, removeBackendListener, 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.ksb.KnowledgeSourceBackend

collectPropDefDescendantsUsingAllNarrower, collectPropDefDescendantsUsingInverseIsA, collectPropIdDescendantsUsingAllNarrower, collectPropIdDescendantsUsingInverseIsA, getKnowledgeSourceSearchResults, readAbstractedInto, readAbstractionDefinition, readAbstractionDefinitions, readContextDefinition, readContextDefinitions, readInduces, readIsA, readPropositionDefinition, readPropositionDefinitions, readSubContextOfs, readTemporalPropositionDefinition, readTemporalPropositionDefinitions

Methods inherited from interface org.protempa.backend.Backend

addBackendListener, getConfigurationsId, getDisplayName, getId, initialize, removeBackendListener

Constructor Detail

AbstractKnowledgeSourceBackend

public AbstractKnowledgeSourceBackend()

Method Detail

readValueSet

public ValueSet readValueSet(String id)
                      throws KnowledgeSourceReadException

A default implementation that returns null. Override this if your knowledge base contains value sets.

Specified by:

readValueSet in interface KnowledgeSourceBackend

Parameters:

id - a proposition id String.

Returns:

an ValueSet, always null in this implementation.

Throws:

KnowledgeSourceReadException

getPropositionsByTermSubsumption

public List<String> getPropositionsByTermSubsumption(And<TermSubsumption> termId)
                                              throws KnowledgeSourceReadException

A default implementation that returns an empty List.

Specified by:

getPropositionsByTermSubsumption in interface KnowledgeSourceBackend

Parameters:

termId - the term subsumptions to match in the knowledge source

Returns:

a List.

Throws:

KnowledgeSourceReadException - if there is a problem reading from the knowledge source

getPropositionsByTerm

public String[] getPropositionsByTerm(String termId)
                               throws KnowledgeSourceReadException

A default implementation that returns an empty list.

Specified by:

getPropositionsByTerm in interface KnowledgeSourceBackend

Parameters:

termId - the term ID to look up

Returns:

a List of proposoition IDs related to the given term

Throws:

KnowledgeSourceReadException - if there is a problem reading from the Knowledge source

See Also:

org.protempa.KnowledgeSourceBackend#getPropositionsByTerm(java.lang.String)

close

public void close()

Implemented as a no-op.

Specified by:

close in interface Backend<KnowledgeSourceBackendUpdatedEvent>

See Also:

org.protempa.KnowledgeSourceBackend#close()

fireKnowledgeSourceBackendUpdated

protected void fireKnowledgeSourceBackendUpdated()

Notifies registered listeners that the backend has been updated.

See Also:

org.protempa.KnowledgeSourceBackendUpdatedEvent, org.protempa.KnowledgeSourceBackendListener