org.protempa.dest.table

Class TableDestination

java.lang.Object

org.protempa.dest.AbstractDestination

org.protempa.dest.table.TableDestination

All Implemented Interfaces:

Destination

public final class TableDestination
extends AbstractDestination

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
TableDestination(BufferedWriter out, char columnDelimiter, String[] rowPropositionIds, TableColumnSpec[] columnSpecs, boolean headerWritten)

Method Summary

Modifier and Type	Method and Description
char	getColumnDelimiter()
TableColumnSpec[]	getColumnSpecs()
TableQueryResultsHandler	getQueryResultsHandler(Query query, DataSource dataSource, KnowledgeSource knowledgeSource) Performs any initialization required for the query results handler's configuration.
String[]	getRowPropositionIds()
String[]	getSupportedPropositionIds(DataSource dataSource, KnowledgeSource knowledgeSource) Infers a list of propositions to populate all of the specified columns.
boolean	isHeaderWritten()

Methods inherited from class org.protempa.dest.AbstractDestination

getDisplayName, getId, getStatistics, isGetStatisticsSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDestination

public TableDestination(BufferedWriter out,
                        char columnDelimiter,
                        String[] rowPropositionIds,
                        TableColumnSpec[] columnSpecs,
                        boolean headerWritten)

Method Detail

getRowPropositionIds

public String[] getRowPropositionIds()

getColumnDelimiter

public char getColumnDelimiter()

getColumnSpecs

public TableColumnSpec[] getColumnSpecs()

isHeaderWritten

public boolean isHeaderWritten()

getQueryResultsHandler

public TableQueryResultsHandler getQueryResultsHandler(Query query,
                                                       DataSource dataSource,
                                                       KnowledgeSource knowledgeSource)
                                                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)
                                    throws GetSupportedPropositionIdsException

Infers a list of propositions to populate all of the specified columns.

Specified by:

getSupportedPropositionIds in interface Destination

Overrides:

getSupportedPropositionIds in class AbstractDestination

Returns:

an array of proposition id Strings.

Throws:

GetSupportedPropositionIdsException