org.protempa.dest

Class AbstractDestination

java.lang.Object

org.protempa.dest.AbstractDestination

All Implemented Interfaces:

Destination

Direct Known Subclasses:

DeidentifiedDestination, KeyLoaderDestination, KeySetDestination, MapDestination, PropositionListDestination

public abstract class AbstractDestination
extends Object
implements Destination

Author:

Andrew Post

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDestination()

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.
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 java.lang.Object

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

Methods inherited from interface org.protempa.dest.Destination

getQueryResultsHandler

Constructor Detail

AbstractDestination

protected AbstractDestination()

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

Returns:

a string.

getDisplayName

public String getDisplayName()

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

Specified by:

getDisplayName in interface Destination

Returns:

a string.

isGetStatisticsSupported

public boolean isGetStatisticsSupported()

Specified by:

isGetStatisticsSupported in interface Destination

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

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

Returns:

an array of proposition id String. Guaranteed not null.

Throws:

GetSupportedPropositionIdsException