org.protempa

Class KnowledgeSourceImpl

java.lang.Object

org.protempa.AbstractSource<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceUpdatedEvent,KnowledgeSourceBackendUpdatedEvent>

org.protempa.KnowledgeSourceImpl

All Implemented Interfaces:

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

public final class KnowledgeSourceImpl
extends AbstractSource<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceUpdatedEvent,KnowledgeSourceBackendUpdatedEvent>
implements KnowledgeSource

A read-only "interface" to an externally-maintained knowledge base. The user must specify a backend in the constructor from where information about primitive parameters and abstract parameters can be obtained.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
KnowledgeSourceImpl(KnowledgeSourceBackend... backends)

Method Summary

Modifier and Type	Method and Description
void	backendUpdated(KnowledgeSourceBackendUpdatedEvent event) Notifies a listener when it needs to reread data in the backend.
void	clear()
void	close() Removes this Source as a listener to the Backends provided to the constructor.
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<String>	getMatchingPropIds(String searchKey) Gets the proposition Definitions from each backend that match the 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 id)
List<String>	readAbstractedIntoPropIds(PropositionDefinition propDef)
List<String>	readAbstractedIntoPropIds(String id)
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 id)
List<ContextDefinition>	readInduces(TemporalPropositionDefinition propDef)
List<String>	readInducesPropIds(String id)
List<String>	readInducesPropIds(TemporalPropositionDefinition propDef)
List<PropositionDefinition>	readInverseIsA(PropositionDefinition propDef)
List<PropositionDefinition>	readInverseIsA(String id)
List<PropositionDefinition>	readIsA(PropositionDefinition propDef)
List<PropositionDefinition>	readIsA(String id)
List<String>	readIsAPropIds(PropositionDefinition propDef)
List<String>	readIsAPropIds(String id)
List<String>	readParentPropIds(PropositionDefinition propDef)
List<String>	readParentPropIds(String propId)
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<String>	readSubContextOfPropIds(ContextDefinition cd)
List<String>	readSubContextOfPropIds(String id)
List<ContextDefinition>	readSubContextOfs(ContextDefinition cd)
List<ContextDefinition>	readSubContextOfs(String id)
List<ContextDefinition>	readSubContexts(ContextDefinition contextDef)
List<ContextDefinition>	readSubContexts(String contextId)
TemporalPropositionDefinition	readTemporalPropositionDefinition(String id)
List<TemporalPropositionDefinition>	readTemporalPropositionDefinitions(String... propIds)
ValueSet	readValueSet(String id)

Methods inherited from class org.protempa.AbstractSource

addSourceListener, fireClosedUnexpectedly, fireSourceUpdated, getBackends, isClosed, removeSourceListener, setEventListeners, unrecoverableErrorOccurred

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.Source

addSourceListener, getBackends, removeSourceListener, setEventListeners

Methods inherited from interface org.protempa.BackendListener

unrecoverableErrorOccurred

Constructor Detail

KnowledgeSourceImpl

public KnowledgeSourceImpl(KnowledgeSourceBackend... backends)

Method Detail

readInverseIsA

public List<PropositionDefinition> readInverseIsA(PropositionDefinition propDef)
                                           throws KnowledgeSourceReadException

Specified by:

readInverseIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readIsA

public List<PropositionDefinition> readIsA(PropositionDefinition propDef)
                                    throws KnowledgeSourceReadException

Specified by:

readIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readIsAPropIds

public List<String> readIsAPropIds(PropositionDefinition propDef)
                            throws KnowledgeSourceReadException

Specified by:

readIsAPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInverseIsA

public List<PropositionDefinition> readInverseIsA(String id)
                                           throws KnowledgeSourceReadException

Specified by:

readInverseIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readIsA

public List<PropositionDefinition> readIsA(String id)
                                    throws KnowledgeSourceReadException

Specified by:

readIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readIsAPropIds

public List<String> readIsAPropIds(String id)
                            throws KnowledgeSourceReadException

Specified by:

readIsAPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedFrom

public List<PropositionDefinition> readAbstractedFrom(AbstractionDefinition propDef)
                                               throws KnowledgeSourceReadException

Specified by:

readAbstractedFrom in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedInto

public List<AbstractionDefinition> readAbstractedInto(PropositionDefinition propDef)
                                               throws KnowledgeSourceReadException

Specified by:

readAbstractedInto in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedIntoPropIds

public List<String> readAbstractedIntoPropIds(PropositionDefinition propDef)
                                       throws KnowledgeSourceReadException

Specified by:

readAbstractedIntoPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedFrom

public List<PropositionDefinition> readAbstractedFrom(String id)
                                               throws KnowledgeSourceReadException

Specified by:

readAbstractedFrom in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedInto

public List<AbstractionDefinition> readAbstractedInto(String id)
                                               throws KnowledgeSourceReadException

Specified by:

readAbstractedInto in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractedIntoPropIds

public List<String> readAbstractedIntoPropIds(String id)
                                       throws KnowledgeSourceReadException

Specified by:

readAbstractedIntoPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInduces

public List<ContextDefinition> readInduces(TemporalPropositionDefinition propDef)
                                    throws KnowledgeSourceReadException

Specified by:

readInduces in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInducesPropIds

public List<String> readInducesPropIds(TemporalPropositionDefinition propDef)
                                throws KnowledgeSourceReadException

Specified by:

readInducesPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInduces

public List<ContextDefinition> readInduces(String id)
                                    throws KnowledgeSourceReadException

Specified by:

readInduces in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInducesPropIds

public List<String> readInducesPropIds(String id)
                                throws KnowledgeSourceReadException

Specified by:

readInducesPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContextOfs

public List<ContextDefinition> readSubContextOfs(String id)
                                          throws KnowledgeSourceReadException

Specified by:

readSubContextOfs in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContextOfPropIds

public List<String> readSubContextOfPropIds(String id)
                                     throws KnowledgeSourceReadException

Specified by:

readSubContextOfPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContextOfs

public List<ContextDefinition> readSubContextOfs(ContextDefinition cd)
                                          throws KnowledgeSourceReadException

Specified by:

readSubContextOfs in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContextOfPropIds

public List<String> readSubContextOfPropIds(ContextDefinition cd)
                                     throws KnowledgeSourceReadException

Specified by:

readSubContextOfPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContexts

public List<ContextDefinition> readSubContexts(String contextId)
                                        throws KnowledgeSourceReadException

Specified by:

readSubContexts in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readSubContexts

public List<ContextDefinition> readSubContexts(ContextDefinition contextDef)
                                        throws KnowledgeSourceReadException

Specified by:

readSubContexts in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readParents

public List<PropositionDefinition> readParents(PropositionDefinition propDef)
                                        throws KnowledgeSourceReadException

Specified by:

readParents in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readParentPropIds

public List<String> readParentPropIds(PropositionDefinition propDef)
                               throws KnowledgeSourceReadException

Specified by:

readParentPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readParents

public List<PropositionDefinition> readParents(String propId)
                                        throws KnowledgeSourceReadException

Specified by:

readParents in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readParentPropIds

public List<String> readParentPropIds(String propId)
                               throws KnowledgeSourceReadException

Specified by:

readParentPropIds in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInducedBy

public List<TemporalPropositionDefinition> readInducedBy(String contextId)
                                                  throws KnowledgeSourceReadException

Specified by:

readInducedBy in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readInducedBy

public List<TemporalPropositionDefinition> readInducedBy(ContextDefinition contextDef)
                                                  throws KnowledgeSourceReadException

Specified by:

readInducedBy in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

hasTemporalPropositionDefinition

public boolean hasTemporalPropositionDefinition(String id)
                                         throws KnowledgeSourceReadException

Specified by:

hasTemporalPropositionDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinition

public TemporalPropositionDefinition readTemporalPropositionDefinition(String id)
                                                                throws KnowledgeSourceReadException

Specified by:

readTemporalPropositionDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readTemporalPropositionDefinitions

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

Specified by:

readTemporalPropositionDefinitions in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readPropositionDefinition

public PropositionDefinition readPropositionDefinition(String id)
                                                throws KnowledgeSourceReadException

Returns the specified proposition definition.

Specified by:

readPropositionDefinition in interface KnowledgeSource

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.

readPropositionDefinitions

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

Specified by:

readPropositionDefinitions in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

hasPropositionDefinition

public boolean hasPropositionDefinition(String id)
                                 throws KnowledgeSourceReadException

Specified by:

hasPropositionDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractionDefinition

public AbstractionDefinition readAbstractionDefinition(String id)
                                                throws KnowledgeSourceReadException

Specified by:

readAbstractionDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readAbstractionDefinitions

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

Specified by:

readAbstractionDefinitions in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readContextDefinition

public ContextDefinition readContextDefinition(String id)
                                        throws KnowledgeSourceReadException

Specified by:

readContextDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readContextDefinitions

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

Specified by:

readContextDefinitions in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

hasAbstractionDefinition

public boolean hasAbstractionDefinition(String id)
                                 throws KnowledgeSourceReadException

Specified by:

hasAbstractionDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

hasContextDefinition

public boolean hasContextDefinition(String id)
                             throws KnowledgeSourceReadException

Specified by:

hasContextDefinition in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

readValueSet

public ValueSet readValueSet(String id)
                      throws KnowledgeSourceReadException

Specified by:

readValueSet in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

hasValueSet

public boolean hasValueSet(String id)
                    throws KnowledgeSourceReadException

Specified by:

hasValueSet in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

close

public void close()
           throws SourceCloseException

Description copied from class: AbstractSource

Removes this Source as a listener to the Backends provided to the constructor. Must be called by subclasses, or proper cleanup will not occur.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Source<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceBackendUpdatedEvent>

Overrides:

close in class AbstractSource<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceUpdatedEvent,KnowledgeSourceBackendUpdatedEvent>

Throws:

SourceCloseException

clear

public void clear()

Specified by:

clear in interface Source<KnowledgeSourceUpdatedEvent,KnowledgeSourceBackend,KnowledgeSourceBackendUpdatedEvent>

collectPropIdDescendantsUsingAllNarrower

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

Specified by:

collectPropIdDescendantsUsingAllNarrower in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingAllNarrower

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

Specified by:

collectPropDefDescendantsUsingAllNarrower in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

collectPropIdDescendantsUsingInverseIsA

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

Specified by:

collectPropIdDescendantsUsingInverseIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

collectPropDefDescendantsUsingInverseIsA

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

Specified by:

collectPropDefDescendantsUsingInverseIsA in interface KnowledgeSource

Throws:

KnowledgeSourceReadException

getPropositionDefinitionsByTerm

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

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

Specified by:

getPropositionDefinitionsByTerm in interface KnowledgeSource

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

backendUpdated

public void backendUpdated(KnowledgeSourceBackendUpdatedEvent event)

Description copied from interface: BackendListener

Notifies a listener when it needs to reread data in the backend.

Specified by:

backendUpdated in interface BackendListener<KnowledgeSourceBackendUpdatedEvent>

Parameters:

event - an EventObject

getMatchingPropIds

public List<String> getMatchingPropIds(String searchKey)
                                throws KnowledgeSourceReadException

Gets the proposition Definitions from each backend that match the searchKey

Specified by:

getMatchingPropIds in interface KnowledgeSource

Parameters:

searchKey -

Returns:

Throws:

KnowledgeSourceReadException