org.protempa.backend.ksb

Interface KnowledgeSourceBackend

All Superinterfaces:

Backend<KnowledgeSourceBackendUpdatedEvent>

All Known Implementing Classes:

AbstractCommonsKnowledgeSourceBackend, AbstractKnowledgeSourceBackend, SimpleKnowledgeSourceBackend

public interface KnowledgeSourceBackend
extends Backend<KnowledgeSourceBackendUpdatedEvent>

Translates from an arbitrary knowledge base to a PROTEMPA knowledge base. Users of KnowledgeSourceBackend implementations must first call #initialize(java.util.Properties) with a set of configuration properties that is specific to the KnowledgeSourceBackend implementation.

Author:

Andrew Post

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)
Set<String>	getKnowledgeSourceSearchResults(String searchKey)
String[]	readAbstractedInto(String propId)
AbstractionDefinition	readAbstractionDefinition(String id)
List<AbstractionDefinition>	readAbstractionDefinitions(String[] ids)
ContextDefinition	readContextDefinition(String id)
List<ContextDefinition>	readContextDefinitions(String[] toArray)
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[] toArray)
ValueSet	readValueSet(String id) Reads the value set from the knowledge base and returns it.

Methods inherited from interface org.protempa.backend.Backend

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

Method Detail

readPropositionDefinition

PropositionDefinition readPropositionDefinition(String id)
                                         throws KnowledgeSourceReadException

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

readAbstractionDefinition

AbstractionDefinition readAbstractionDefinition(String id)
                                         throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readContextDefinition

ContextDefinition readContextDefinition(String id)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinition

TemporalPropositionDefinition readTemporalPropositionDefinition(String id)
                                                         throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readValueSet

ValueSet readValueSet(String id)
               throws KnowledgeSourceReadException

Reads the value set from the knowledge base and returns it. This only will get called if the value set has not already been loaded.

Parameters:

id - The id of the value set to read

Returns:

The ValueSet object

Throws:

KnowledgeSourceReadException

readAbstractedInto

String[] readAbstractedInto(String propId)
                     throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readIsA

String[] readIsA(String propId)
          throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInduces

String[] readInduces(String propId)
              throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContextOfs

String[] readSubContextOfs(String propId)
                    throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

getKnowledgeSourceSearchResults

Set<String> getKnowledgeSourceSearchResults(String searchKey)
                                     throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingAllNarrower

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

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingAllNarrower

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

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingInverseIsA

Collection<PropositionDefinition> collectPropDefDescendantsUsingInverseIsA(String[] propIds)
                                                                    throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingInverseIsA

Collection<String> collectPropIdDescendantsUsingInverseIsA(String[] propIds)
                                                    throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readPropositionDefinitions

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

Throws:

KnowledgeSourceReadException

readAbstractionDefinitions

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

Throws:

KnowledgeSourceReadException

readContextDefinitions

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

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinitions

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

Throws:

KnowledgeSourceReadException