com.whitepages.proapi.api.client

Interface DataSource<U,V>

public interface DataSource<U,V>

Data sources act as brokers of information, fetching a response of one type, using a request of another type. For example, a data source may take a URI instance, call the associated external web service, and return an InputStream containing the response body.

DataSource 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
V	execute(U u, Client client) Transforms the query intermediate form into a raw result.

Method Detail

execute

V execute(U u,
        Client client)
          throws DataSourceException

Transforms the query intermediate form into a raw result.

Parameters:

u - The query intermediate form.

client - The client performing the request.

Returns:

The raw result.

Throws:

DataSourceException - The wrapper error for any errors encountered while attempting to retrieve data.