org.protempa.dest

Class AbstractQueryResultsHandler

java.lang.Object

org.protempa.dest.AbstractQueryResultsHandler

All Implemented Interfaces:

AutoCloseable, QueryResultsHandler

Direct Known Subclasses:

DeidentifiedQueryResultsHandler, KeyLoaderQueryResultsHandler, MapQueryResultsHandler, PropositionListQueryResultsHandler, TableQueryResultsHandler, XmlQueryResultsHandler

public abstract class AbstractQueryResultsHandler
extends Object
implements QueryResultsHandler

Author:

Andrew Post

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueryResultsHandler()

Method Summary

Modifier and Type	Method and Description
void	cancel() Requests cancellation of whatever this object is currently doing.
void	close() Called by Protempa after #handleFinish() to clean up any resources used by the handler.
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	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 java.lang.Object

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

Methods inherited from interface org.protempa.dest.QueryResultsHandler

handleQueryResult

Constructor Detail

AbstractQueryResultsHandler

protected AbstractQueryResultsHandler()

Method Detail

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

Returns:

a string.

getDisplayName

public String getDisplayName()

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

Specified by:

getDisplayName in interface QueryResultsHandler

Returns:

a string.

validate

public void validate()
              throws QueryResultsHandlerValidationFailedException

Description copied from interface: QueryResultsHandler

Validates this query results handler's specification.

Specified by:

validate in interface QueryResultsHandler

Throws:

QueryResultsHandlerValidationFailedException - if validation failed.

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

Parameters:

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

Throws:

QueryResultsHandlerProcessingException - if any exceptions occur at a lower level.

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

Throws:

QueryResultsHandlerProcessingException - if any exceptions occur at a lower level

close

public void close()
           throws QueryResultsHandlerCloseException

Description copied from interface: QueryResultsHandler

Called by Protempa after #handleFinish() to clean up any resources used by the handler. It is called always, even if a previous step failed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface QueryResultsHandler

Throws:

QueryResultsHandlerCloseException - if any exceptions occur at a lower level

cancel

public void cancel()

Description copied from interface: QueryResultsHandler

Requests cancellation of whatever this object is currently doing. If QueryResultsHandler.finish() has not been called yet, it will be skipped. If QueryResultsHandler.close() has not been called yet, it will be called, and it must finish cleaning up all resources associated with this query results handler.

Specified by:

cancel in interface QueryResultsHandler