org.carrot2.source.microsoft
Class Bing2WebDocumentSourceDescriptor.AttributeBuilder

java.lang.Object
  org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder
      org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder
          org.carrot2.source.microsoft.Bing2DocumentSourceDescriptor.AttributeBuilder
              org.carrot2.source.microsoft.Bing2WebDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

Bing2WebDocumentSourceDescriptor

public static class Bing2WebDocumentSourceDescriptor.AttributeBuilder
extends Bing2DocumentSourceDescriptor.AttributeBuilder

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

Field Summary

Map<String,Object>

map The attribute map populated by this builder.

Constructor Summary

protected

Bing2WebDocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Bing2WebDocumentSourceDescriptor.AttributeBuilder	fileTypes(String value) Specify the allowed file types.
Bing2WebDocumentSourceDescriptor.AttributeBuilder	site(String value) Site restriction to return results under a given URL.
Bing2WebDocumentSourceDescriptor.AttributeBuilder	webOptions(String value) Miscellaneous Web-request specific options.

Methods inherited from class org.carrot2.source.microsoft.Bing2DocumentSourceDescriptor.AttributeBuilder

adult, adult, appid, market, market, options

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

Bing2WebDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

webOptions

public Bing2WebDocumentSourceDescriptor.AttributeBuilder webOptions(String value)

Miscellaneous Web-request specific options. Bing provides the following options:

• DisableHostCollapsing
• DisableQueryAlterations

Options should be space-separated.

See Also:

Bing2WebDocumentSource.webOptions

fileTypes

public Bing2WebDocumentSourceDescriptor.AttributeBuilder fileTypes(String value)

Specify the allowed file types. Space-separated list of file extensions (upper-case). See Bing documentation.

See Also:

Bing2WebDocumentSource.fileTypes

site

public Bing2WebDocumentSourceDescriptor.AttributeBuilder site(String value)

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

See Also:

Bing2WebDocumentSource.site