org.protempa.dest.xml

Class XmlQueryResultsHandler

java.lang.Object

org.protempa.dest.AbstractQueryResultsHandler

org.protempa.dest.xml.XmlQueryResultsHandler

All Implemented Interfaces:

AutoCloseable, QueryResultsHandler

public final class XmlQueryResultsHandler
extends AbstractQueryResultsHandler

Method Summary

Modifier and Type	Method and Description
void	finish() Called by Protempa as soon as all query results have been retrieved from the data source.
void	handleQueryResult(String key, List<Proposition> propositions, Map<Proposition,List<Proposition>> forwardDerivations, Map<Proposition,List<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references) Handles a single query result, which is the list of propositions associated with the given key.
void	start(Collection<PropositionDefinition> cache) Called by Protempa prior to the first invocation of QueryResultsHandler.handleQueryResult(java.lang.String, java.util.List, java.util.Map, java.util.Map, java.util.Map).
void	validate() Validates this query results handler's specification.

Methods inherited from class org.protempa.dest.AbstractQueryResultsHandler

cancel, close, getDisplayName, getId

Methods inherited from class java.lang.Object

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

Method Detail

validate

public void validate()
              throws QueryResultsHandlerValidationFailedException

Description copied from interface: QueryResultsHandler

Validates this query results handler's specification.

Specified by:

validate in interface QueryResultsHandler

Overrides:

validate in class AbstractQueryResultsHandler

Throws:

QueryResultsHandlerValidationFailedException - if validation failed.

finish

public void finish()
            throws QueryResultsHandlerProcessingException

Description copied from interface: QueryResultsHandler

Called by Protempa as soon as all query results have been retrieved from the data source. Will not be called if a previous step failed.

Specified by:

finish in interface QueryResultsHandler

Overrides:

finish in class AbstractQueryResultsHandler

Throws:

QueryResultsHandlerProcessingException - if any exceptions occur at a lower level

start

public void start(Collection<PropositionDefinition> cache)
           throws QueryResultsHandlerProcessingException

Description copied from interface: QueryResultsHandler

Called by Protempa prior to the first invocation of QueryResultsHandler.handleQueryResult(java.lang.String, java.util.List, java.util.Map, java.util.Map, java.util.Map). Implementers of this method may perform arbitrary processing related to the output of the handler, such as printing out headers of a file or extracting metadata for the handler's output.

Specified by:

start in interface QueryResultsHandler

Overrides:

start in class AbstractQueryResultsHandler

Parameters:

cache - a cache of all of the proposition definitions that were queried.

Throws:

QueryResultsHandlerProcessingException - if any exceptions occur at a lower level.

handleQueryResult

public void handleQueryResult(String key,
                              List<Proposition> propositions,
                              Map<Proposition,List<Proposition>> forwardDerivations,
                              Map<Proposition,List<Proposition>> backwardDerivations,
                              Map<UniqueId,Proposition> references)
                       throws QueryResultsHandlerProcessingException

Description copied from interface: QueryResultsHandler

Handles a single query result, which is the list of propositions associated with the given key.

Parameters:

key - the identifying key id for the result

propositions - the proposition results for the given key as a newly created List.

Throws:

QueryResultsHandlerProcessingException