org.protempa.dest.key

Class KeyLoaderQueryResultsHandler

java.lang.Object

org.protempa.dest.AbstractQueryResultsHandler

org.protempa.dest.key.KeyLoaderQueryResultsHandler

All Implemented Interfaces:

AutoCloseable, QueryResultsHandler

public class KeyLoaderQueryResultsHandler
extends AbstractQueryResultsHandler

Author:

Andrew Post

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.
String	getDisplayName() Returns this query result handler's display name for user interfaces.
String	getId() Gets the query result handler's identifier string for logging and internal purposes.
void	handleQueryResult(String keyId, List<Proposition> propositions, Map<Proposition,Set<Proposition>> forwardDerivations, Map<Proposition,Set<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references) Handles a single query result, which is the list of propositions associated with the given key.
void	start(PropositionDefinitionCache 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).

Methods inherited from class org.protempa.dest.AbstractQueryResultsHandler

cancel, close, validate

Methods inherited from class java.lang.Object

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

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: AbstractQueryResultsHandler

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

Specified by:

getDisplayName in interface QueryResultsHandler

Overrides:

getDisplayName in class AbstractQueryResultsHandler

Returns:

a string.

getId

public String getId()

Description copied from interface: QueryResultsHandler

Gets the query result handler's identifier string for logging and internal purposes.

Specified by:

getId in interface QueryResultsHandler

Overrides:

getId in class AbstractQueryResultsHandler

Returns:

a string.

start

public void start(PropositionDefinitionCache 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 keyId,
                              List<Proposition> propositions,
                              Map<Proposition,Set<Proposition>> forwardDerivations,
                              Map<Proposition,Set<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:

keyId - the identifying key id for the result

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

Throws:

QueryResultsHandlerProcessingException

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