org.protempa.dest.keyloader

Class KeyLoaderDestination

java.lang.Object

org.protempa.dest.AbstractDestination

org.protempa.dest.keyloader.KeyLoaderDestination

All Implemented Interfaces:

Destination

public class KeyLoaderDestination
extends AbstractDestination

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
KeyLoaderDestination(Criteria criteria)
KeyLoaderDestination(String id, Criteria criteria)
KeyLoaderDestination(String id, String displayName, Criteria criteria)

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Returns this 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, List<? extends ProtempaEventListener> eventListeners) Performs any initialization required for the query results handler's configuration.
String[]	getSupportedPropositionIds(DataSource dataSource, KnowledgeSource knowledgeSource) Infers from the query results handler's specification what propositions this query results handler supports in its output.

Methods inherited from class org.protempa.dest.AbstractDestination

getStatistics, isGetStatisticsSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyLoaderDestination

public KeyLoaderDestination(Criteria criteria)

KeyLoaderDestination

public KeyLoaderDestination(String id,
                            Criteria criteria)

KeyLoaderDestination

public KeyLoaderDestination(String id,
                            String displayName,
                            Criteria criteria)

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: AbstractDestination

Returns this destination's display name for user interfaces. This implementation returns the same string as AbstractDestination.getId().

Specified by:

getDisplayName in interface Destination

Overrides:

getDisplayName in class AbstractDestination

Returns:

a string.

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

getSupportedPropositionIds

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

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.