org.protempa.backend.dsb

Interface DataSourceBackend

All Superinterfaces:

Backend<DataSourceBackendUpdatedEvent>

All Known Implementing Classes:

AbstractCommonsDataSourceBackend, AbstractDataSourceBackend

public interface DataSourceBackend
extends Backend<DataSourceBackendUpdatedEvent>

Interface for data source backends, which provide access to data sources for PROTEMPA.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
void	deleteAllKeys()
GranularityFactory	getGranularityFactory()
Comparator<Object>	getKeyIdComparator()
String	getKeyType()
String	getKeyTypeDisplayName()
String	getKeyTypePluralDisplayName()
KeySetSpec[]	getSelectedKeySetSpecs()
DataSourceBackendSourceSystem	getSourceSystem()
UnitFactory	getUnitFactory()
DataStreamingEventIterator<Proposition>	readPropositions(Set<String> keyIds, Set<String> propIds, Filter filters, QuerySession qs, QueryResultsHandler queryResultsHandler)
void	validateConfiguration(KnowledgeSource knowledgeSource)
DataValidationEvent[]	validateData(KnowledgeSource knowledgeSource)
void	writeKeys(Set<String> keyIds)

Methods inherited from interface org.protempa.backend.Backend

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

Method Detail

readPropositions

DataStreamingEventIterator<Proposition> readPropositions(Set<String> keyIds,
                                                         Set<String> propIds,
                                                         Filter filters,
                                                         QuerySession qs,
                                                         QueryResultsHandler queryResultsHandler)
                                                  throws DataSourceReadException

Throws:

DataSourceReadException

getGranularityFactory

GranularityFactory getGranularityFactory()

getUnitFactory

UnitFactory getUnitFactory()

getKeyType

String getKeyType()

getKeyTypeDisplayName

String getKeyTypeDisplayName()

getKeyTypePluralDisplayName

String getKeyTypePluralDisplayName()

validateData

DataValidationEvent[] validateData(KnowledgeSource knowledgeSource)
                            throws DataSourceBackendFailedDataValidationException,
                                   KnowledgeSourceReadException

Throws:

DataSourceBackendFailedDataValidationException

KnowledgeSourceReadException

validateConfiguration

void validateConfiguration(KnowledgeSource knowledgeSource)
                    throws DataSourceBackendFailedConfigurationValidationException,
                           KnowledgeSourceReadException

Throws:

DataSourceBackendFailedConfigurationValidationException

KnowledgeSourceReadException

deleteAllKeys

void deleteAllKeys()
            throws DataSourceWriteException

Throws:

DataSourceWriteException

writeKeys

void writeKeys(Set<String> keyIds)
        throws DataSourceWriteException

Throws:

DataSourceWriteException

getKeyIdComparator

Comparator<Object> getKeyIdComparator()

getSourceSystem

DataSourceBackendSourceSystem getSourceSystem()

getSelectedKeySetSpecs

KeySetSpec[] getSelectedKeySetSpecs()
                             throws DataSourceReadException

Throws:

DataSourceReadException