org.protempa

Interface DataSource

All Superinterfaces:

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

All Known Implementing Classes:

DataSourceImpl

public interface DataSource
extends Source<DataSourceUpdatedEvent,DataSourceBackend,DataSourceBackendUpdatedEvent>

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
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)

Methods inherited from interface org.protempa.Source

addSourceListener, clear, close, getBackends, removeSourceListener, setEventListeners

Methods inherited from interface org.protempa.BackendListener

backendUpdated, unrecoverableErrorOccurred

Method Detail

getGranularityFactory

GranularityFactory getGranularityFactory()
                                  throws DataSourceReadException

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

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()

getKeyType

String getKeyType()
           throws DataSourceReadException

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

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

String getKeyTypeDisplayName()
                      throws DataSourceReadException

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

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

String getKeyTypePluralDisplayName()
                            throws DataSourceReadException

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

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

KeySetSpec[] getSelectedKeySetSpecs()
                             throws DataSourceReadException

Throws:

DataSourceReadException

getUnitFactory

UnitFactory getUnitFactory()
                    throws DataSourceReadException

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

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

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

Throws:

DataSourceReadException

deleteAllKeys

void deleteAllKeys()
            throws DataSourceWriteException

Throws:

DataSourceWriteException

writeKeys

void writeKeys(Set<String> keyIds)
        throws DataSourceWriteException

Throws:

DataSourceWriteException