org.protempa.dest.proplist

Class PropositionListQueryResultsHandler

java.lang.Object

org.protempa.dest.AbstractQueryResultsHandler

org.protempa.dest.proplist.PropositionListQueryResultsHandler

All Implemented Interfaces:

AutoCloseable, QueryResultsHandler

public final class PropositionListQueryResultsHandler
extends AbstractQueryResultsHandler

An implementation of QueryResultsHandler providing functionality for writing the results to an output stream in a tab-delimited format.

Author:

Michel Mansour

Constructor Summary

Constructors

Constructor and Description
PropositionListQueryResultsHandler(BufferedWriter out) Instantiates this handler to write to a Writer.
PropositionListQueryResultsHandler(BufferedWriter out, boolean includeDerived)
PropositionListQueryResultsHandler(BufferedWriter out, List<? extends Comparator<Proposition>> comparator) Instantiates this handler to write to a Writer with optional sorting of propositions.
PropositionListQueryResultsHandler(BufferedWriter writer, List<? extends Comparator<Proposition>> comparator, boolean includeDerived)

Method Summary

Modifier and Type	Method and Description
void	handleQueryResult(String key, List<Proposition> propositions, Map<Proposition,List<Proposition>> forwardDerivations, Map<Proposition,List<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references) Writes a keys worth of data in tab delimited format optionally sorted.

Methods inherited from class org.protempa.dest.AbstractQueryResultsHandler

cancel, close, finish, getDisplayName, getId, start, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

PropositionListQueryResultsHandler

public PropositionListQueryResultsHandler(BufferedWriter out)

Instantiates this handler to write to a Writer. No sorting will be performed.

Parameters:

out - a Writer.

PropositionListQueryResultsHandler

public PropositionListQueryResultsHandler(BufferedWriter out,
                                          boolean includeDerived)

PropositionListQueryResultsHandler

public PropositionListQueryResultsHandler(BufferedWriter out,
                                          List<? extends Comparator<Proposition>> comparator)

Instantiates this handler to write to a Writer with optional sorting of propositions.

Parameters:

out - a Writer.

comparator - a extends Comparator>. Every key's propositions will be sorted by the provided comparators in the order they are given. A value of null or an empty array means no sorting will be performed.

PropositionListQueryResultsHandler

public PropositionListQueryResultsHandler(BufferedWriter writer,
                                          List<? extends Comparator<Proposition>> comparator,
                                          boolean includeDerived)

Method Detail

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

Writes a keys worth of data in tab delimited format optionally sorted.

Parameters:

key - a key id String.

propositions - a List.

Throws:

QueryResultsHandlerProcessingException - if an error occurred writing to the specified file, output stream or writer.