org.protempa.backend.ksb

Class SimpleKnowledgeSourceBackend

java.lang.Object

org.protempa.backend.AbstractBackend<KnowledgeSourceBackendUpdatedEvent>

org.protempa.backend.ksb.AbstractKnowledgeSourceBackend

org.protempa.backend.ksb.SimpleKnowledgeSourceBackend

All Implemented Interfaces:

Backend<KnowledgeSourceBackendUpdatedEvent>, KnowledgeSourceBackend

public final class SimpleKnowledgeSourceBackend
extends AbstractKnowledgeSourceBackend

Constructor Summary

Constructors

Constructor and Description
SimpleKnowledgeSourceBackend()
SimpleKnowledgeSourceBackend(PropositionDefinition... propDefs)

Method Summary

Modifier and Type	Method and Description
Collection<PropositionDefinition>	collectPropDefDescendantsUsingAllNarrower(boolean inDataSourceOnly, String[] propIds)
Collection<PropositionDefinition>	collectPropDefDescendantsUsingInverseIsA(String[] propIds)
Collection<String>	collectPropIdDescendantsUsingAllNarrower(boolean inDataSourceOnly, String[] propIds)
Collection<String>	collectPropIdDescendantsUsingInverseIsA(String[] propIds)
void	fireKnowledgeSourceBackendUpdated() Make public so that tests can call it.
String	getDisplayName() Returns the name of this backend for display in user interfaces.
Set<String>	getKnowledgeSourceSearchResults(String searchKey)
void	initialize(BackendInstanceSpec config) Initializes the backend from a BackendInstanceSpec.
String[]	readAbstractedInto(String propId)
AbstractionDefinition	readAbstractionDefinition(String id)
List<AbstractionDefinition>	readAbstractionDefinitions(String[] ids)
ContextDefinition	readContextDefinition(String id)
List<ContextDefinition>	readContextDefinitions(String[] ids)
String[]	readInduces(String propId)
String[]	readIsA(String propId)
PropositionDefinition	readPropositionDefinition(String id) Reads a proposition definition into the given PROTEMPA knowledge base.
List<PropositionDefinition>	readPropositionDefinitions(String[] ids)
String[]	readSubContextOfs(String propId)
TemporalPropositionDefinition	readTemporalPropositionDefinition(String id)
List<TemporalPropositionDefinition>	readTemporalPropositionDefinitions(String[] ids)

Methods inherited from class org.protempa.backend.ksb.AbstractKnowledgeSourceBackend

close, getPropositionsByTerm, getPropositionsByTermSubsumption, readValueSet

Methods inherited from class org.protempa.backend.AbstractBackend

addBackendListener, fireBackendUpdated, fireEvent, fireUnrecoverableError, getConfigurationsId, getId, 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, removeBackendListener, setEventListeners

Constructor Detail

SimpleKnowledgeSourceBackend

public SimpleKnowledgeSourceBackend()

SimpleKnowledgeSourceBackend

public SimpleKnowledgeSourceBackend(PropositionDefinition... propDefs)

Method Detail

initialize

public void initialize(BackendInstanceSpec config)
                throws BackendInitializationException

Description copied from interface: Backend

Initializes the backend from a BackendInstanceSpec. It is called for you by BackendInstanceSpec.getInstance(), but if you create a Backend object yourself, you must call this manually before using it.

Specified by:

initialize in interface Backend<KnowledgeSourceBackendUpdatedEvent>

Overrides:

initialize in class AbstractBackend<KnowledgeSourceBackendUpdatedEvent>

Parameters:

config - the configuration Properties object.

Throws:

BackendInitializationException

fireKnowledgeSourceBackendUpdated

public void fireKnowledgeSourceBackendUpdated()

Make public so that tests can call it.

Overrides:

fireKnowledgeSourceBackendUpdated in class AbstractKnowledgeSourceBackend

See Also:

AbstractKnowledgeSourceBackend

getDisplayName

public String getDisplayName()

Description copied from interface: Backend

Returns the name of this backend for display in user interfaces.

Returns:

a String.

readPropositionDefinition

public PropositionDefinition readPropositionDefinition(String id)
                                                throws KnowledgeSourceReadException

Description copied from interface: KnowledgeSourceBackend

Reads a proposition definition into the given PROTEMPA knowledge base. This will only get called if the proposition definition has not already been loaded.

Parameters:

id - a proposition id String. Guaranteed not null.

Returns:

the PropositionDefinition, or null if none with the given id was found.

Throws:

KnowledgeSourceReadException

readPropositionDefinitions

public List<PropositionDefinition> readPropositionDefinitions(String[] ids)
                                                       throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractionDefinition

public AbstractionDefinition readAbstractionDefinition(String id)
                                                throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractionDefinitions

public List<AbstractionDefinition> readAbstractionDefinitions(String[] ids)
                                                       throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractedInto

public String[] readAbstractedInto(String propId)

readIsA

public String[] readIsA(String propId)

readContextDefinition

public ContextDefinition readContextDefinition(String id)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readContextDefinitions

public List<ContextDefinition> readContextDefinitions(String[] ids)
                                               throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinition

public TemporalPropositionDefinition readTemporalPropositionDefinition(String id)
                                                                throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinitions

public List<TemporalPropositionDefinition> readTemporalPropositionDefinitions(String[] ids)
                                                                       throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInduces

public String[] readInduces(String propId)
                     throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContextOfs

public String[] readSubContextOfs(String propId)
                           throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

getKnowledgeSourceSearchResults

public Set<String> getKnowledgeSourceSearchResults(String searchKey)
                                            throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingAllNarrower

public Collection<String> collectPropIdDescendantsUsingAllNarrower(boolean inDataSourceOnly,
                                                                   String[] propIds)

collectPropIdDescendantsUsingInverseIsA

public Collection<String> collectPropIdDescendantsUsingInverseIsA(String[] propIds)

collectPropDefDescendantsUsingAllNarrower

public Collection<PropositionDefinition> collectPropDefDescendantsUsingAllNarrower(boolean inDataSourceOnly,
                                                                                   String[] propIds)

collectPropDefDescendantsUsingInverseIsA

public Collection<PropositionDefinition> collectPropDefDescendantsUsingInverseIsA(String[] propIds)