org.carrot2.source.microsoft

Class Bing3DocumentSource

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.SearchEngineBase

org.carrot2.source.MultipageSearchEngine

org.carrot2.source.microsoft.Bing3DocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

Direct Known Subclasses:

Bing3ImageDocumentSource, Bing3NewsDocumentSource, Bing3WebDocumentSource

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

A base IDocumentSource sending requests to Bing Search API in Windows Azure Marketplace. We model this into separate subclasses, specific to a particular request type (web, image, news).

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

See Also:

"https://datamarket.azure.com/dataset/5ba839f1-12ce-4cce-bf57-a49d98d29a44"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bing3DocumentSource.AtomEntry
static class	Bing3DocumentSource.AtomFeed
static class	Bing3DocumentSource.ContentEntry
static class	Bing3DocumentSource.EntryProperties
static class	Bing3DocumentSource.Thumbnail

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	appid Microsoft-assigned application ID for querying the API.
Double	latitude Latitude (north/south coordinate).
Double	longitude Longitude (east/west coordinate).
MarketOption	market Language and country/region information for the request.
protected static int	MAX_CONCURRENT_THREADS Maximum concurrent threads from all instances of this subcomponents sending requests to Bing.
HttpRedirectStrategy	redirectStrategy HTTP redirect response strategy (follow or throw an error).
static String	SYSPROP_BING3_API System property key under which Bing app key can be passed (default).

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

Constructor and Description
Bing3DocumentSource(SourceType sourceType) Initialize with a fixed source type.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addIfNotEmpty(ArrayList<org.apache.http.NameValuePair> params, String paramName, Object value) Add a parameter if argument is not an empty string.
protected void	appendSourceParams(ArrayList<org.apache.http.NameValuePair> params) Append any source-specific parameters.
protected Callable<SearchEngineResponse>	createFetcher(MultipageSearchEngine.SearchRange bucket) Create a single page fetcher for the search range.
abstract void	process() Make this abstract so that subclasses override.
protected void	process(MultipageSearchEngineMetadata metadata, ExecutorService executor) Run a request the search engine's API, setting documents to the set of returned documents.
protected static String	stringValue(Object v)

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_BING3_API

public static final String SYSPROP_BING3_API

System property key under which Bing app key can be passed (default). You can also override the key via init or runtime attributes of course.

See Also:

Constant Field Values

MAX_CONCURRENT_THREADS

protected static final int MAX_CONCURRENT_THREADS

Maximum concurrent threads from all instances of this subcomponents sending requests to Bing.

See Also:

Constant Field Values

appid

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

Microsoft-assigned application ID for querying the API. Please generate your own ID for production deployments and branches off the Carrot2.org's code. See http://goo.gl/usVXW for more.

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

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).

latitude

@Processing
@Input
@Attribute
@Label(value="Latitude hint")
@Level(value=MEDIUM)
@Group(value="Filtering")
public Double latitude

Latitude (north/south coordinate). Valid input values range from –90 to 90.

longitude

@Processing
@Input
@Attribute
@Label(value="Longitude hint")
@Level(value=MEDIUM)
@Group(value="Filtering")
public Double longitude

Longitude (east/west coordinate). Valid input values range from –180 to 180.

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).

Constructor Detail

Bing3DocumentSource

public Bing3DocumentSource(SourceType sourceType)

Initialize with a fixed source type.

Method Detail

process

protected 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.

addIfNotEmpty

protected void addIfNotEmpty(ArrayList<org.apache.http.NameValuePair> params,
                 String paramName,
                 Object value)

Add a parameter if argument is not an empty string.

process

public abstract void process()
                      throws ProcessingException

Make this abstract so that subclasses override.

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.

appendSourceParams

protected void appendSourceParams(ArrayList<org.apache.http.NameValuePair> params)

Append any source-specific parameters.

stringValue

protected static String stringValue(Object v)