com.whitepages.proapi.api.client

Interface QueryCoder<Q extends Query,U>

public interface QueryCoder<Q extends Query,U>

Query coders serve to transform/translate a Query into an intermediate form that is compatible with the DataSource. For example, one may change the query into a URI for later execution against an external web service.

QueryCoder is part of the ResultFinder pipeline. ResultFinder instances link together the dataflow of the conversion of a Query to a Response via the following steps:

1. The Query is transformed to an intermediate form via a QueryCoder,
2. The intermediate form is used to fetch the raw response from the data source via a DataSource, and
3. The raw response is transformed into a normalized Response via a ResponseDecoder

See Also:

ResultFinder, ResultFinderImpl, QueryCoder, DataSource, ResponseDecoder, Response

Method Summary

Methods

Modifier and Type	Method and Description
U	encode(Q query, Client client) Transforms the query to an intermediate form.

Method Detail

encode

U encode(Q query,
       Client client)
         throws QueryCoderException

Transforms the query to an intermediate form.

Parameters:

query - The query.

client - The client performing the query.

Returns:

The query intermediate form.

Throws:

QueryCoderException - The wrapper for any errors encountered while attempting this transformation.