org.carrot2.source.microsoft

Class Bing3DocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.microsoft.Bing3DocumentSourceDescriptor.AttributeBuilder

Direct Known Subclasses:

Bing3ImageDocumentSourceDescriptor.AttributeBuilder, Bing3NewsDocumentSourceDescriptor.AttributeBuilder, Bing3WebDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

Bing3DocumentSourceDescriptor

public static class Bing3DocumentSourceDescriptor.AttributeBuilder
extends MultipageSearchEngineDescriptor.AttributeBuilder

Attribute map builder for the Bing3DocumentSource 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	Bing3DocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
Bing3DocumentSourceDescriptor.AttributeBuilder	adult(AdultOption value) Adult search restriction (porn filter).
Bing3DocumentSourceDescriptor.AttributeBuilder	adult(Class<? extends AdultOption> clazz) Adult search restriction (porn filter).
Bing3DocumentSourceDescriptor.AttributeBuilder	appid(String value) Microsoft-assigned application ID for querying the API.
Bing3DocumentSourceDescriptor.AttributeBuilder	latitude(Double value) Latitude (north/south coordinate).
Bing3DocumentSourceDescriptor.AttributeBuilder	longitude(Double value) Longitude (east/west coordinate).
Bing3DocumentSourceDescriptor.AttributeBuilder	market(Class<? extends MarketOption> clazz) Language and country/region information for the request.
Bing3DocumentSourceDescriptor.AttributeBuilder	market(MarketOption value) Language and country/region information for the request.

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

searchMode, searchMode

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

compressed, documents, query, results, resultsTotal, 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

Bing3DocumentSourceDescriptor.AttributeBuilder

protected Bing3DocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

appid

public Bing3DocumentSourceDescriptor.AttributeBuilder appid(String value)

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.

See Also:

Bing3DocumentSource.appid

market

public Bing3DocumentSourceDescriptor.AttributeBuilder market(MarketOption value)

Language and country/region information for the request.

See Also:

Bing3DocumentSource.market

market

public Bing3DocumentSourceDescriptor.AttributeBuilder market(Class<? extends MarketOption> clazz)

Language and country/region information for the request.

See Also:

Bing3DocumentSource.market

adult

public Bing3DocumentSourceDescriptor.AttributeBuilder adult(AdultOption value)

Adult search restriction (porn filter).

See Also:

Bing3DocumentSource.adult

adult

public Bing3DocumentSourceDescriptor.AttributeBuilder adult(Class<? extends AdultOption> clazz)

Adult search restriction (porn filter).

See Also:

Bing3DocumentSource.adult

latitude

public Bing3DocumentSourceDescriptor.AttributeBuilder latitude(Double value)

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

See Also:

Bing3DocumentSource.latitude

longitude

public Bing3DocumentSourceDescriptor.AttributeBuilder longitude(Double value)

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

See Also:

Bing3DocumentSource.longitude