org.carrot2.source.microsoft.v7

Class Bing7DocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.microsoft.v7.Bing7DocumentSourceDescriptor.AttributeBuilder

Direct Known Subclasses:

Bing7NewsDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

Bing7DocumentSourceDescriptor

public static class Bing7DocumentSourceDescriptor.AttributeBuilder
extends MultipageSearchEngineDescriptor.AttributeBuilder

Attribute map builder for the Bing7DocumentSource component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Modifier and Type	Method and Description
Bing7DocumentSourceDescriptor.AttributeBuilder	adult(AdultOption value) Adult search restriction (porn filter).
Bing7DocumentSourceDescriptor.AttributeBuilder	adult(org.carrot2.util.attribute.IObjectFactory<? extends AdultOption> value) Adult search restriction (porn filter).
Bing7DocumentSourceDescriptor.AttributeBuilder	apiKey(org.carrot2.util.attribute.IObjectFactory<? extends String> value) The API key used to authenticate requests.
Bing7DocumentSourceDescriptor.AttributeBuilder	apiKey(String value) The API key used to authenticate requests.
Bing7DocumentSourceDescriptor.AttributeBuilder	market(org.carrot2.util.attribute.IObjectFactory<? extends MarketOption> value) Language and country/region information for the request.
Bing7DocumentSourceDescriptor.AttributeBuilder	market(MarketOption value) Language and country/region information for the request.
Bing7DocumentSourceDescriptor.AttributeBuilder	redirectStrategy(HttpRedirectStrategy value) HTTP redirect response strategy (follow or throw an error).
Bing7DocumentSourceDescriptor.AttributeBuilder	redirectStrategy(org.carrot2.util.attribute.IObjectFactory<? extends HttpRedirectStrategy> value) HTTP redirect response strategy (follow or throw an error).
Bing7DocumentSourceDescriptor.AttributeBuilder	respectRateLimits(boolean value) Respect official guidelines concerning rate limits.
Bing7DocumentSourceDescriptor.AttributeBuilder	respectRateLimits(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) Respect official guidelines concerning rate limits.
Bing7DocumentSourceDescriptor.AttributeBuilder	site(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Site restriction to return value under a given URL.
Bing7DocumentSourceDescriptor.AttributeBuilder	site(String value) Site restriction to return value under a given URL.

Methods inherited from class org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder

searchMode, searchMode

Methods inherited from class org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

compressed, documents, query, query, results, results, resultsTotal, start, start

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

AttributeBuilder

protected AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

apiKey

public Bing7DocumentSourceDescriptor.AttributeBuilder apiKey(String value)

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.

See Also:

Bing7DocumentSource.apiKey

apiKey

public Bing7DocumentSourceDescriptor.AttributeBuilder apiKey(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

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.

See Also:

Bing7DocumentSource.apiKey

site

public Bing7DocumentSourceDescriptor.AttributeBuilder site(String value)

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

See Also:

Bing7DocumentSource.site

site

public Bing7DocumentSourceDescriptor.AttributeBuilder site(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

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

See Also:

Bing7DocumentSource.site

market

public Bing7DocumentSourceDescriptor.AttributeBuilder market(MarketOption value)

Language and country/region information for the request.

See Also:

Bing7DocumentSource.market

market

public Bing7DocumentSourceDescriptor.AttributeBuilder market(org.carrot2.util.attribute.IObjectFactory<? extends MarketOption> value)

Language and country/region information for the request.

See Also:

Bing7DocumentSource.market

adult

public Bing7DocumentSourceDescriptor.AttributeBuilder adult(AdultOption value)

Adult search restriction (porn filter).

See Also:

Bing7DocumentSource.adult

adult

public Bing7DocumentSourceDescriptor.AttributeBuilder adult(org.carrot2.util.attribute.IObjectFactory<? extends AdultOption> value)

Adult search restriction (porn filter).

See Also:

Bing7DocumentSource.adult

redirectStrategy

public Bing7DocumentSourceDescriptor.AttributeBuilder redirectStrategy(HttpRedirectStrategy value)

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

See Also:

Bing7DocumentSource.redirectStrategy

redirectStrategy

public Bing7DocumentSourceDescriptor.AttributeBuilder redirectStrategy(org.carrot2.util.attribute.IObjectFactory<? extends HttpRedirectStrategy> value)

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

See Also:

Bing7DocumentSource.redirectStrategy

respectRateLimits

public Bing7DocumentSourceDescriptor.AttributeBuilder respectRateLimits(boolean value)

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

See Also:

Bing7DocumentSource.respectRateLimits

respectRateLimits

public Bing7DocumentSourceDescriptor.AttributeBuilder respectRateLimits(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)

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

See Also:

Bing7DocumentSource.respectRateLimits