org.protempa.dest

Interface Destination

All Known Implementing Classes:

AbstractDestination, DeidentifiedDestination, KeyLoaderDestination, MapDestination, PropositionListDestination, TableDestination, XmlDestination

public interface Destination

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Gets the destination's display name for user interfaces.
String	getId() Gets the destination's identifier string for logging and internal purposes.
QueryResultsHandler	getQueryResultsHandler(Query query, DataSource dataSource, KnowledgeSource knowledgeSource) Performs any initialization required for the query results handler's configuration.
Statistics	getStatistics() Returns an instance that can be used to discover information about previous runs of data.
String[]	getSupportedPropositionIds(DataSource dataSource, KnowledgeSource knowledgeSource) Infers from the query results handler's specification what propositions this query results handler supports in its output.
boolean	isGetStatisticsSupported()

Method Detail

getId

String getId()

Gets the destination's identifier string for logging and internal purposes.

Returns:

a string.

getDisplayName

String getDisplayName()

Gets the destination's display name for user interfaces.

Returns:

a string.

getQueryResultsHandler

QueryResultsHandler getQueryResultsHandler(Query query,
                                           DataSource dataSource,
                                           KnowledgeSource knowledgeSource)
                                    throws QueryResultsHandlerInitException

Performs any initialization required for the query results handler's configuration. After calling this method, calls to #collectStatistics() will work. This method is called by Protempa before #handleKnowledgeSource(org.protempa.KnowledgeSource) .

Returns:

a query results handler.

Throws:

org.protempa.query.handler.QueryResultsHandlerInitException - if any exceptions occur. There may be a nested exception with more information.

QueryResultsHandlerInitException

isGetStatisticsSupported

boolean isGetStatisticsSupported()

getStatistics

Statistics getStatistics()
                  throws StatisticsException

Returns an instance that can be used to discover information about previous runs of data.

Returns:

collects and returns statistics, or null if statistics collection is not supported by this kind of query results handler.

Throws:

CollectStatisticsException - if an error occurred.

StatisticsException

getSupportedPropositionIds

String[] getSupportedPropositionIds(DataSource dataSource,
                                    KnowledgeSource knowledgeSource)
                             throws GetSupportedPropositionIdsException

Infers from the query results handler's specification what propositions this query results handler supports in its output. When executing a processing job, Protempa uses the proposition ids thus returned to filter those that are queried. Implementations of QueryResultsHandler for which such inference does not make sense may return an empty array, in which case, no filtering occurs.

Returns:

an array of proposition id String. Guaranteed not null.

Throws:

QueryResultsHandlerProcessingException - if an error occurs.

GetSupportedPropositionIdsException