org.carrot2.source.microsoft.v7

Class Bing7DocumentSource

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.SearchEngineBase

org.carrot2.source.MultipageSearchEngine

org.carrot2.source.microsoft.v7.Bing7DocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

Direct Known Subclasses:

Bing7NewsDocumentSource

@Bindable(prefix="Bing7DocumentSource",
          inherit=CommonAttributes.class)
public class Bing7DocumentSource
extends MultipageSearchEngine

A IDocumentSource fetching web page search results from Bing, using Search API V7.

Important: there are limits for free use of the above API (beyond which it is a paid service).

See Also:

"https://msdn.microsoft.com/en-us/library/mt604056.aspx"

Nested Class Summary

Nested classes/interfaces inherited from class org.carrot2.source.MultipageSearchEngine

MultipageSearchEngine.SearchEngineResponseCallable, MultipageSearchEngine.SearchMode, MultipageSearchEngine.SearchRange

Field Summary

Fields

Modifier and Type	Field and Description
AdultOption	adult Adult search restriction (porn filter).
String	apiKey The API key used to authenticate requests.
MarketOption	market Language and country/region information for the request.
HttpRedirectStrategy	redirectStrategy HTTP redirect response strategy (follow or throw an error).
boolean	respectRateLimits Respect official guidelines concerning rate limits.
String	site Site restriction to return value under a given URL.
static String	SYSPROP_BING7_API System property name for passing Bing API key.

Fields inherited from class org.carrot2.source.MultipageSearchEngine

searchMode

Fields inherited from class org.carrot2.source.SearchEngineBase

compressed, documents, POSTPROCESSING, query, results, resultsTotal, SERVICE, start, statistics

Constructor Summary

Constructors

Modifier	Constructor and Description
	Bing7DocumentSource()
protected	Bing7DocumentSource(MultipageSearchEngineMetadata metadata, String serviceURL)

Method Summary

Modifier and Type	Method and Description
protected void	augmentSearchHeaders(List<org.apache.http.Header> headers)
protected void	augmentSearchParameters(List<org.apache.http.NameValuePair> params)
protected Callable<SearchEngineResponse>	createFetcher(MultipageSearchEngine.SearchRange bucket) Create a single page fetcher for the search range.
protected void	handleResponse(BingResponse response, SearchEngineResponse ser)
void	process() Performs the processing required to fulfill the request.
protected void	process(MultipageSearchEngineMetadata metadata, ExecutorService executor) Run a request the search engine's API, setting documents to the set of returned documents.

Methods inherited from class org.carrot2.source.MultipageSearchEngine

collectDocuments, runQuery

Methods inherited from class org.carrot2.source.SearchEngineBase

afterFetch, clean, urlEncode

Methods inherited from class org.carrot2.core.ProcessingComponentBase

afterProcessing, beforeProcessing, dispose, getContext, getSharedExecutor, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.carrot2.core.IProcessingComponent

afterProcessing, beforeProcessing, dispose, init

Field Detail

SYSPROP_BING7_API

public static final String SYSPROP_BING7_API

System property name for passing Bing API key. You can also override the key per-controller or request via init or runtime attributes.

See Also:

Constant Field Values

apiKey

@Processing
 @Input
 @Attribute
 @Label(value="Application API key")
 @Level(value=BASIC)
 @Group(value="Service")
 @Required
public String apiKey

The API key used to authenticate requests. You will have to provide your own API key. There is a free monthly grace request limit.

By default takes the system property's value under key: bing7.key.

site

@Processing
 @Input
 @Attribute
 @Label(value="Site restriction")
 @Level(value=ADVANCED)
 @Group(value="Filtering")
public String site

Site restriction to return value under a given URL. Example: http://www.wikipedia.org or simply wikipedia.org.

market

@Input
 @Processing
 @Attribute
 @Label(value="Market")
 @Level(value=BASIC)
 @Group(value="Filtering")
public MarketOption market

Language and country/region information for the request.

adult

@Processing
 @Input
 @Attribute
 @Label(value="Safe search")
 @Level(value=MEDIUM)
 @Group(value="Filtering")
public AdultOption adult

Adult search restriction (porn filter).

redirectStrategy

@Input
 @Processing
 @Attribute
 @Label(value="HTTP redirect strategy")
 @Level(value=MEDIUM)
 @Group(value="Service")
 @Internal
public HttpRedirectStrategy redirectStrategy

HTTP redirect response strategy (follow or throw an error).

respectRateLimits

@Input
 @Processing
 @Attribute
 @Label(value="Respect request rate limits")
 @Level(value=ADVANCED)
 @Group(value="Service")
public boolean respectRateLimits

Respect official guidelines concerning rate limits. If set to false, rate limits are not observed.

Constructor Detail

Bing7DocumentSource

public Bing7DocumentSource()

Bing7DocumentSource

protected Bing7DocumentSource(MultipageSearchEngineMetadata metadata,
                              String serviceURL)

Method Detail

process

public final void process()
                   throws ProcessingException

Description copied from interface: IProcessingComponent

Performs the processing required to fulfill the request. This method is called once per request.

Specified by:

process in interface IProcessingComponent

Overrides:

process in class ProcessingComponentBase

Throws:

ProcessingException - when processing failed. If thrown, the IProcessingComponent.afterProcessing() method will be called and the component will be ready to accept further requests or to be disposed of. Finally, the exception will be rethrown from the controller method that caused the component to perform processing.

process

protected final void process(MultipageSearchEngineMetadata metadata,
                             ExecutorService executor)
                      throws ProcessingException

Description copied from class: MultipageSearchEngine

Run a request the search engine's API, setting documents to the set of returned documents.

Overrides:

process in class MultipageSearchEngine

Throws:

ProcessingException

createFetcher

protected final Callable<SearchEngineResponse> createFetcher(MultipageSearchEngine.SearchRange bucket)

Create a single page fetcher for the search range.

Specified by:

createFetcher in class MultipageSearchEngine

Parameters:

bucket - The search range to fetch.

augmentSearchHeaders

protected void augmentSearchHeaders(List<org.apache.http.Header> headers)

augmentSearchParameters

protected void augmentSearchParameters(List<org.apache.http.NameValuePair> params)

handleResponse

protected void handleResponse(BingResponse response,
                              SearchEngineResponse ser)