org.protempa.dest.xml

Class XmlDestination

java.lang.Object

org.protempa.dest.AbstractDestination

org.protempa.dest.xml.XmlDestination

All Implemented Interfaces:

Destination

public final class XmlDestination
extends AbstractDestination

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
XmlDestination(Writer writer, Map<String,String> propOrder, String initialPropId, String[] propIds) Constructor

Method Summary

Modifier and Type	Method and Description
QueryResultsHandler	getQueryResultsHandler(Query query, DataSource dataSource, KnowledgeSource knowledgeSource) Performs any initialization required for the query results handler's configuration.
String[]	getSupportedPropositionIds(DataSource dataSource, KnowledgeSource knowledgeSource) Returns the proposition ids specified in the constructor.

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

XmlDestination

public XmlDestination(Writer writer,
                      Map<String,String> propOrder,
                      String initialPropId,
                      String[] propIds)

Constructor

Parameters:

writer - The Writer object that will be used to write the output.

propOrder - A Map object that will be used to guide the navigation between some propositions. If this results handler visits a proposition, the ID of the proposition equals a key in the Map and the value associated with the key is a name in a Reference associated with the proposition, then the Reference is used to navigate from the proposition. This has the effect of imposing a partial ordering on the nesting of XML elements in the output.

initialPropId - The ID of the proposition that will be the root of the output.

propIds - The IDs of propositions that are to be included in the output. If a proposition's ID is not included in this array, it will not be included in the output.

Method Detail

getQueryResultsHandler

public QueryResultsHandler 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)

Returns the proposition ids specified in the constructor.

Specified by:

getSupportedPropositionIds in interface Destination

Overrides:

getSupportedPropositionIds in class AbstractDestination

Returns:

an array of proposition id Strings. Guaranteed not null.