com.attivio.sdk.server.component.query

Interface ResponseTransformer

All Superinterfaces:

Stage

All Known Implementing Classes:

SampleResponseTransformer

public interface ResponseTransformer
extends Stage

Base interface for components that work on a QueryResponse before being sent back to a client. The framework will first call processResponseInfo(QueryResponse), followed by processResponseDocuments(QueryResponse, SearchDocumentList).

Method Summary

Modifier and Type	Method and Description
void	processResponseDocuments(QueryResponse info, SearchDocumentList documents) Process the documents for a response.
void	processResponseInfo(QueryResponse info) Process a QueryResponse which contains information about the query request and the metadata about how long it took to compute the results.

Method Detail

processResponseInfo

void processResponseInfo(QueryResponse info)
                  throws AttivioException

Process a QueryResponse which contains information about the query request and the metadata about how long it took to compute the results.

Throws:

AttivioException

processResponseDocuments

void processResponseDocuments(QueryResponse info,
                              SearchDocumentList documents)
                       throws AttivioException

Process the documents for a response.

NOTE: The only modifications made to info should be the addition of feedback messages. If you want to do any transformation of the info block, you should implement processResponseInfo(QueryResponse).

Parameters:

info -

documents -

Throws:

AttivioException