edu.emory.cci.aiw.i2b2etl.dest

Class I2b2Destination

java.lang.Object

org.protempa.dest.AbstractDestination

edu.emory.cci.aiw.i2b2etl.dest.I2b2Destination

All Implemented Interfaces:

org.protempa.dest.Destination

public final class I2b2Destination
extends org.protempa.dest.AbstractDestination

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
I2b2Destination(Configuration config) Creates a new query results handler that will use the provided configuration file.
I2b2Destination(Configuration config, boolean inferSupportedPropositionIds) Creates a new query results handler that will use the provided configuration file.

Method Summary

Modifier and Type	Method and Description
org.protempa.dest.QueryResultsHandler	getQueryResultsHandler(org.protempa.query.Query query, org.protempa.DataSource dataSource, org.protempa.KnowledgeSource knowledgeSource, List<? extends org.protempa.ProtempaEventListener> eventListeners)
org.protempa.dest.Statistics	getStatistics()
String[]	getSupportedPropositionIds(org.protempa.DataSource dataSource, org.protempa.KnowledgeSource knowledgeSource)
boolean	isGetStatisticsSupported()

Methods inherited from class org.protempa.dest.AbstractDestination

getDisplayName, getId

Methods inherited from class java.lang.Object

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

Constructor Detail

I2b2Destination

public I2b2Destination(Configuration config)

Creates a new query results handler that will use the provided configuration file. It is the same as calling the two-argument constructor with inferPropositionIdsNeeded set to false.

Parameters:

confXML - an i2b2 query results handler configuration file. Cannot be null.

I2b2Destination

public I2b2Destination(Configuration config,
                       boolean inferSupportedPropositionIds)

Creates a new query results handler that will use the provided configuration file. This constructor, through the inferPropositionIdsNeeded parameter, lets you control whether proposition ids to be returned from the Protempa processing run should be inferred from the i2b2 configuration file.

Parameters:

confXML - an i2b2 query results handler configuration file. Cannot be null.

inferPropositionIdsNeeded - true if proposition ids to be returned from the Protempa processing run should include all of those specified in the i2b2 configuration file, false if the proposition ids returned should be only those specified in the Protempa Query.

Method Detail

getQueryResultsHandler

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

Throws:

org.protempa.dest.QueryResultsHandlerInitException

isGetStatisticsSupported

public boolean isGetStatisticsSupported()

Specified by:

isGetStatisticsSupported in interface org.protempa.dest.Destination

Overrides:

isGetStatisticsSupported in class org.protempa.dest.AbstractDestination

getStatistics

public org.protempa.dest.Statistics getStatistics()
                                           throws org.protempa.dest.StatisticsException

Specified by:

getStatistics in interface org.protempa.dest.Destination

Overrides:

getStatistics in class org.protempa.dest.AbstractDestination

Throws:

org.protempa.dest.StatisticsException

getSupportedPropositionIds

public String[] getSupportedPropositionIds(org.protempa.DataSource dataSource,
                                           org.protempa.KnowledgeSource knowledgeSource)
                                    throws org.protempa.dest.GetSupportedPropositionIdsException

Specified by:

getSupportedPropositionIds in interface org.protempa.dest.Destination

Overrides:

getSupportedPropositionIds in class org.protempa.dest.AbstractDestination

Throws:

org.protempa.dest.GetSupportedPropositionIdsException