org.protempa.backend.dsb

Class AbstractDataSourceBackend

java.lang.Object

org.protempa.backend.AbstractBackend<DataSourceBackendUpdatedEvent>

org.protempa.backend.dsb.AbstractDataSourceBackend

All Implemented Interfaces:

Backend<DataSourceBackendUpdatedEvent>, DataSourceBackend

Direct Known Subclasses:

AbstractCommonsDataSourceBackend

public abstract class AbstractDataSourceBackend
extends AbstractBackend<DataSourceBackendUpdatedEvent>
implements DataSourceBackend

Convenience class for implementing a data source backend. It assumes data that uses absolute time units by default, but that can be overridden using setGranularityFactory(org.protempa.proposition.value.GranularityFactory) and setUnitFactory(org.protempa.proposition.value.UnitFactory). The key type must be set using setKeyType(java.lang.String) to the id of the proposition definition represented by keys in the data.

Author:

Andrew Post

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataSourceBackend()

Method Summary

Modifier and Type	Method and Description
void	close() Releases any resources allocated by this backend.
void	deleteAllKeys()
GranularityFactory	getGranularityFactory()
Comparator<Object>	getKeyIdComparator()
String	getKeyType()
String	getKeyTypeDisplayName()
String	getKeyTypePluralDisplayName()
KeySetSpec[]	getSelectedKeySetSpecs()
DataSourceBackendSourceSystem	getSourceSystem()
UnitFactory	getUnitFactory()
void	setGranularityFactory(GranularityFactory granularityFactory)
void	setKeyIdComparator(Comparator<Object> keyIdComparator)
void	setKeyType(String keyType)
void	setUnitFactory(UnitFactory unitFactory)
void	validateConfiguration(KnowledgeSource knowledgeSource)
DataValidationEvent[]	validateData(KnowledgeSource knowledgeSource)
void	writeKeys(Set<String> keyIds)

Methods inherited from class org.protempa.backend.AbstractBackend

addBackendListener, fireBackendUpdated, fireEvent, fireUnrecoverableError, getConfigurationsId, getId, initialize, 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.dsb.DataSourceBackend

readPropositions

Methods inherited from interface org.protempa.backend.Backend

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

Constructor Detail

AbstractDataSourceBackend

protected AbstractDataSourceBackend()

Method Detail

getKeyType

public String getKeyType()

Specified by:

getKeyType in interface DataSourceBackend

setKeyType

public void setKeyType(String keyType)

getGranularityFactory

public GranularityFactory getGranularityFactory()

Specified by:

getGranularityFactory in interface DataSourceBackend

setGranularityFactory

public void setGranularityFactory(GranularityFactory granularityFactory)

getUnitFactory

public UnitFactory getUnitFactory()

Specified by:

getUnitFactory in interface DataSourceBackend

setUnitFactory

public void setUnitFactory(UnitFactory unitFactory)

setKeyIdComparator

public void setKeyIdComparator(Comparator<Object> keyIdComparator)

getKeyIdComparator

public Comparator<Object> getKeyIdComparator()

Specified by:

getKeyIdComparator in interface DataSourceBackend

close

public void close()
           throws BackendCloseException

Description copied from interface: Backend

Releases any resources allocated by this backend.

Specified by:

close in interface Backend<DataSourceBackendUpdatedEvent>

Throws:

BackendCloseException

getKeyTypeDisplayName

public String getKeyTypeDisplayName()

Specified by:

getKeyTypeDisplayName in interface DataSourceBackend

getKeyTypePluralDisplayName

public String getKeyTypePluralDisplayName()

Specified by:

getKeyTypePluralDisplayName in interface DataSourceBackend

getSelectedKeySetSpecs

public KeySetSpec[] getSelectedKeySetSpecs()
                                    throws DataSourceReadException

Specified by:

getSelectedKeySetSpecs in interface DataSourceBackend

Throws:

DataSourceReadException

deleteAllKeys

public void deleteAllKeys()
                   throws DataSourceWriteException

Specified by:

deleteAllKeys in interface DataSourceBackend

Throws:

DataSourceWriteException

writeKeys

public void writeKeys(Set<String> keyIds)
               throws DataSourceWriteException

Specified by:

writeKeys in interface DataSourceBackend

Throws:

DataSourceWriteException

getSourceSystem

public DataSourceBackendSourceSystem getSourceSystem()

Specified by:

getSourceSystem in interface DataSourceBackend

validateData

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

Specified by:

validateData in interface DataSourceBackend

Throws:

DataSourceBackendFailedDataValidationException

KnowledgeSourceReadException

validateConfiguration

public void validateConfiguration(KnowledgeSource knowledgeSource)
                           throws DataSourceBackendFailedConfigurationValidationException,
                                  KnowledgeSourceReadException

Specified by:

validateConfiguration in interface DataSourceBackend

Throws:

DataSourceBackendFailedConfigurationValidationException

KnowledgeSourceReadException