org.protempa.dest.deid

Class DeidentifiedDestination

java.lang.Object

org.protempa.dest.AbstractDestination

org.protempa.dest.deid.DeidentifiedDestination

All Implemented Interfaces:

Destination

public final class DeidentifiedDestination
extends AbstractDestination

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
DeidentifiedDestination(Destination destination, DeidConfig deidConfig)

Method Summary

Modifier and Type	Method and Description
String	getId() Gets the destination's identifier string for logging and internal purposes.
QueryResultsHandler	getQueryResultsHandler(Query query, DataSource dataSource, KnowledgeSource knowledgeSource, List<? extends ProtempaEventListener> eventListeners) 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()

Methods inherited from class org.protempa.dest.AbstractDestination

getDisplayName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeidentifiedDestination

public DeidentifiedDestination(Destination destination,
                               DeidConfig deidConfig)

Method Detail

getId

public String getId()

Description copied from interface: Destination

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

Specified by:

getId in interface Destination

Overrides:

getId in class AbstractDestination

Returns:

a string.

getQueryResultsHandler

public QueryResultsHandler getQueryResultsHandler(Query query,
                                                  DataSource dataSource,
                                                  KnowledgeSource knowledgeSource,
                                                  List<? extends ProtempaEventListener> eventListeners)
                                           throws QueryResultsHandlerInitException

Description copied from interface: Destination

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:

QueryResultsHandlerInitException

isGetStatisticsSupported

public boolean isGetStatisticsSupported()

Specified by:

isGetStatisticsSupported in interface Destination

Overrides:

isGetStatisticsSupported in class AbstractDestination

getStatistics

public Statistics getStatistics()
                         throws StatisticsException

Description copied from interface: Destination

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

Specified by:

getStatistics in interface Destination

Overrides:

getStatistics in class AbstractDestination

Returns:

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

Throws:

StatisticsException

getSupportedPropositionIds

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

Description copied from interface: Destination

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.

Specified by:

getSupportedPropositionIds in interface Destination

Overrides:

getSupportedPropositionIds in class AbstractDestination

Returns:

an array of proposition id String. Guaranteed not null.

Throws:

GetSupportedPropositionIdsException