org.protempa

Class DataSourceImpl

java.lang.Object

org.protempa.AbstractSource<DataSourceUpdatedEvent,DataSourceBackend,DataSourceUpdatedEvent,DataSourceBackendUpdatedEvent>

org.protempa.DataSourceImpl

All Implemented Interfaces:

AutoCloseable, EventListener, BackendListener<DataSourceBackendUpdatedEvent>, DataSource, Source<DataSourceUpdatedEvent,DataSourceBackend,DataSourceBackendUpdatedEvent>

public final class DataSourceImpl
extends AbstractSource<DataSourceUpdatedEvent,DataSourceBackend,DataSourceUpdatedEvent,DataSourceBackendUpdatedEvent>
implements DataSource

Read-only access to a database. Data source backends are specified in the constructor that implement the actual database connection(s).

Author:

Andrew Post

See Also:

DataSourceBackend

Constructor Summary

Constructors

Constructor and Description
DataSourceImpl(DataSourceBackend[] backends)

Method Summary

Modifier and Type	Method and Description
void	backendUpdated(DataSourceBackendUpdatedEvent evt) 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.
void	deleteAllKeys()
GranularityFactory	getGranularityFactory() Returns an object for accessing the granularity of returned data from the schema adaptor for this data source.
String	getKeyType() Returns a string representing the type of keys in this data source (e.g., patient, case).
String	getKeyTypeDisplayName() Returns a string representing the type of keys in this data source (e.g., patient, case) for display purposes.
String	getKeyTypePluralDisplayName() Returns a plural string representing the type of keys in this data source (e.g., patient, case) for display purposes.
KeySetSpec[]	getSelectedKeySetSpecs()
UnitFactory	getUnitFactory() Returns the length units of returned data from this data source.
DataStreamingEventIterator<Proposition>	readPropositions(Set<String> keyIds, Set<String> propIds, Filter filters, QueryResultsHandler queryResultsHandler)
void	writeKeys(Set<String> keyIds)
void	writeKeysFromKeySet(KeySetQueryResultsHandler queryResultsHandler)

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

DataSourceImpl

public DataSourceImpl(DataSourceBackend[] backends)

Method Detail

getKeyType

public String getKeyType()
                  throws DataSourceReadException

Returns a string representing the type of keys in this data source (e.g., patient, case).

Specified by:

getKeyType in interface DataSource

Returns:

a String, guaranteed not null.

Throws:

TerminologyAdaptorInitializationException - if the terminology adaptor could not be initialized.

SchemaAdaptorInitializationException - if the schema adaptor could not be initialized.

DataSourceReadException

getKeyTypeDisplayName

public String getKeyTypeDisplayName()
                             throws DataSourceReadException

Returns a string representing the type of keys in this data source (e.g., patient, case) for display purposes.

Specified by:

getKeyTypeDisplayName in interface DataSource

Returns:

a String, guaranteed not null.

Throws:

TerminologyAdaptorInitializationException - if the terminology adaptor could not be initialized.

SchemaAdaptorInitializationException - if the schema adaptor could not be initialized.

DataSourceReadException

getKeyTypePluralDisplayName

public String getKeyTypePluralDisplayName()
                                   throws DataSourceReadException

Returns a plural string representing the type of keys in this data source (e.g., patient, case) for display purposes.

Specified by:

getKeyTypePluralDisplayName in interface DataSource

Returns:

a String, guaranteed not null.

Throws:

TerminologyAdaptorInitializationException - if the terminology adaptor could not be initialized.

SchemaAdaptorInitializationException - if the schema adaptor could not be initialized.

IllegalStateException - if the schema adaptor and/or terminology adaptor could not be initialized, or if the schema adaptor returned a null key type plural display name.

DataSourceReadException

getSelectedKeySetSpecs

public KeySetSpec[] getSelectedKeySetSpecs()
                                    throws DataSourceReadException

Specified by:

getSelectedKeySetSpecs in interface DataSource

Throws:

DataSourceReadException

getGranularityFactory

public GranularityFactory getGranularityFactory()
                                         throws DataSourceReadException

Returns an object for accessing the granularity of returned data from the schema adaptor for this data source.

Specified by:

getGranularityFactory in interface DataSource

Returns:

a GranularityFactory, or null if the data source could not be initialized or the schema adaptor returned a null GranularityFactory.

Throws:

TerminologyAdaptorInitializationException - if the terminology adaptor could not be initialized.

SchemaAdaptorInitializationException - if the schema adaptor could not be initialized.

DataSourceReadException

See Also:

SchemaAdaptor#getGranularityFactory()

getUnitFactory

public UnitFactory getUnitFactory()
                           throws DataSourceReadException

Returns the length units of returned data from this data source.

Specified by:

getUnitFactory in interface DataSource

Returns:

a UnitFactory, or null if the data source could not be initialized or the schema adaptor returned a null UnitFactory.

Throws:

DataSourceReadException - if the data source could not be initialized.

readPropositions

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

Specified by:

readPropositions in interface DataSource

Throws:

DataSourceReadException

deleteAllKeys

public void deleteAllKeys()
                   throws DataSourceWriteException

Specified by:

deleteAllKeys in interface DataSource

Throws:

DataSourceWriteException

writeKeys

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

Specified by:

writeKeys in interface DataSource

Throws:

DataSourceWriteException

writeKeysFromKeySet

public void writeKeysFromKeySet(KeySetQueryResultsHandler queryResultsHandler)
                         throws DataSourceWriteException

Specified by:

writeKeysFromKeySet in interface DataSource

Throws:

DataSourceWriteException

backendUpdated

public void backendUpdated(DataSourceBackendUpdatedEvent evt)

Description copied from interface: BackendListener

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

Specified by:

backendUpdated in interface BackendListener<DataSourceBackendUpdatedEvent>

Parameters:

evt - an EventObject

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<DataSourceUpdatedEvent,DataSourceBackend,DataSourceBackendUpdatedEvent>

Overrides:

close in class AbstractSource<DataSourceUpdatedEvent,DataSourceBackend,DataSourceUpdatedEvent,DataSourceBackendUpdatedEvent>

Throws:

SourceCloseException

clear

public void clear()

Specified by:

clear in interface Source<DataSourceUpdatedEvent,DataSourceBackend,DataSourceBackendUpdatedEvent>