org.protempa

Interface KnowledgeSource

All Superinterfaces:

AutoCloseable, BackendListener<KnowledgeSourceBackendUpdatedEvent>, EventListener, Source<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceBackendUpdatedEvent>

All Known Implementing Classes:

KnowledgeSourceImpl

public interface KnowledgeSource
extends Source<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceBackendUpdatedEvent>

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
Set<PropositionDefinition>	collectPropDefDescendantsUsingAllNarrower(boolean inDataSourceOnly, String... propIds)
Set<PropositionDefinition>	collectPropDefDescendantsUsingInverseIsA(String... propIds)
Set<String>	collectPropIdDescendantsUsingAllNarrower(boolean inDataSourceOnly, String... propIds)
Set<String>	collectPropIdDescendantsUsingInverseIsA(String... propIds)
List<PropositionDefinition>	getMatchingPropositionDefinitions(String searchKey)
List<String>	getPropositionDefinitionsByTerm(And<TermSubsumption> termSubsumptionClause) Gets the mappings from term IDs to proposition IDs for each backend.
boolean	hasAbstractionDefinition(String id)
boolean	hasContextDefinition(String id)
boolean	hasPropositionDefinition(String id)
boolean	hasTemporalPropositionDefinition(String id)
boolean	hasValueSet(String id)
List<PropositionDefinition>	readAbstractedFrom(AbstractionDefinition propDef)
List<PropositionDefinition>	readAbstractedFrom(String id)
List<AbstractionDefinition>	readAbstractedInto(PropositionDefinition propDef)
List<AbstractionDefinition>	readAbstractedInto(String propId)
AbstractionDefinition	readAbstractionDefinition(String id)
List<AbstractionDefinition>	readAbstractionDefinitions(String... propIds)
ContextDefinition	readContextDefinition(String id)
List<ContextDefinition>	readContextDefinitions(String... propIds)
List<TemporalPropositionDefinition>	readInducedBy(ContextDefinition contextDef)
List<TemporalPropositionDefinition>	readInducedBy(String contextId)
List<ContextDefinition>	readInduces(String tempPropDef)
List<ContextDefinition>	readInduces(TemporalPropositionDefinition tempPropDef)
List<PropositionDefinition>	readInverseIsA(PropositionDefinition propDef)
List<PropositionDefinition>	readInverseIsA(String id)
List<PropositionDefinition>	readIsA(PropositionDefinition propDef)
List<PropositionDefinition>	readIsA(String id)
List<PropositionDefinition>	readParents(PropositionDefinition propDef)
List<PropositionDefinition>	readParents(String propId)
PropositionDefinition	readPropositionDefinition(String id) Returns the specified proposition definition.
List<PropositionDefinition>	readPropositionDefinitions(String... propIds)
List<ContextDefinition>	readSubContextOfs(ContextDefinition contextDef)
List<ContextDefinition>	readSubContextOfs(String id)
List<ContextDefinition>	readSubContexts(ContextDefinition contextDef)
List<ContextDefinition>	readSubContexts(String id)
TemporalPropositionDefinition	readTemporalPropositionDefinition(String id)
List<TemporalPropositionDefinition>	readTemporalPropositionDefinitions(String... propIds)
ValueSet	readValueSet(String id)

Methods inherited from interface org.protempa.Source

addSourceListener, clear, close, getBackends, removeSourceListener, setEventListeners

Methods inherited from interface org.protempa.BackendListener

backendUpdated, unrecoverableErrorOccurred

Method Detail

getPropositionDefinitionsByTerm

List<String> getPropositionDefinitionsByTerm(And<TermSubsumption> termSubsumptionClause)
                                      throws KnowledgeSourceReadException

Gets the mappings from term IDs to proposition IDs for each backend.

Returns:

a Map of Strings to a List of Strings, with the keys being Term IDs and the values being lists of PropositionDefinition IDs.

Throws:

KnowledgeSourceReadException

hasAbstractionDefinition

boolean hasAbstractionDefinition(String id)
                          throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

hasPropositionDefinition

boolean hasPropositionDefinition(String id)
                          throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

hasTemporalPropositionDefinition

boolean hasTemporalPropositionDefinition(String id)
                                  throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

hasContextDefinition

boolean hasContextDefinition(String id)
                      throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

hasValueSet

boolean hasValueSet(String id)
             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingAllNarrower

Set<PropositionDefinition> collectPropDefDescendantsUsingAllNarrower(boolean inDataSourceOnly,
                                                                     String... propIds)
                                                              throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingAllNarrower

Set<String> collectPropIdDescendantsUsingAllNarrower(boolean inDataSourceOnly,
                                                     String... propIds)
                                              throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingInverseIsA

Set<PropositionDefinition> collectPropDefDescendantsUsingInverseIsA(String... propIds)
                                                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingInverseIsA

Set<String> collectPropIdDescendantsUsingInverseIsA(String... propIds)
                                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractedFrom

List<PropositionDefinition> readAbstractedFrom(AbstractionDefinition propDef)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractedFrom

List<PropositionDefinition> readAbstractedFrom(String id)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractedInto

List<AbstractionDefinition> readAbstractedInto(PropositionDefinition propDef)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractedInto

List<AbstractionDefinition> readAbstractedInto(String propId)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractionDefinition

AbstractionDefinition readAbstractionDefinition(String id)
                                         throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readContextDefinition

ContextDefinition readContextDefinition(String id)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInverseIsA

List<PropositionDefinition> readInverseIsA(PropositionDefinition propDef)
                                    throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInverseIsA

List<PropositionDefinition> readInverseIsA(String id)
                                    throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readIsA

List<PropositionDefinition> readIsA(PropositionDefinition propDef)
                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readIsA

List<PropositionDefinition> readIsA(String id)
                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContexts

List<ContextDefinition> readSubContexts(String id)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContexts

List<ContextDefinition> readSubContexts(ContextDefinition contextDef)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContextOfs

List<ContextDefinition> readSubContextOfs(String id)
                                   throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readSubContextOfs

List<ContextDefinition> readSubContextOfs(ContextDefinition contextDef)
                                   throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInduces

List<ContextDefinition> readInduces(String tempPropDef)
                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInduces

List<ContextDefinition> readInduces(TemporalPropositionDefinition tempPropDef)
                             throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInducedBy

List<TemporalPropositionDefinition> readInducedBy(String contextId)
                                           throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readInducedBy

List<TemporalPropositionDefinition> readInducedBy(ContextDefinition contextDef)
                                           throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readPropositionDefinition

PropositionDefinition readPropositionDefinition(String id)
                                         throws KnowledgeSourceReadException

Returns the specified proposition definition.

Parameters:

id - a proposition id String. Cannot be null.

Returns:

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

Throws:

KnowledgeSourceReadException - if an error occurred reading from the knowledge base.

readTemporalPropositionDefinition

TemporalPropositionDefinition readTemporalPropositionDefinition(String id)
                                                         throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readValueSet

ValueSet readValueSet(String id)
               throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readParents

List<PropositionDefinition> readParents(PropositionDefinition propDef)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readParents

List<PropositionDefinition> readParents(String propId)
                                 throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

getMatchingPropositionDefinitions

List<PropositionDefinition> getMatchingPropositionDefinitions(String searchKey)
                                                       throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readPropositionDefinitions

List<PropositionDefinition> readPropositionDefinitions(String... propIds)
                                                throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readAbstractionDefinitions

List<AbstractionDefinition> readAbstractionDefinitions(String... propIds)
                                                throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinitions

List<TemporalPropositionDefinition> readTemporalPropositionDefinitions(String... propIds)
                                                                throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException

readContextDefinitions

List<ContextDefinition> readContextDefinitions(String... propIds)
                                        throws KnowledgeSourceReadException

Throws:

KnowledgeSourceReadException