org.carrot2.source.google

Class GoogleDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.google.GoogleDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

GoogleDocumentSourceDescriptor

public static class GoogleDocumentSourceDescriptor.AttributeBuilder
extends MultipageSearchEngineDescriptor.AttributeBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
GoogleDocumentSourceDescriptor.AttributeBuilder	keepHighlights(boolean value) Keep query word highlighting.
GoogleDocumentSourceDescriptor.AttributeBuilder	keepHighlights(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) Keep query word highlighting.
GoogleDocumentSourceDescriptor.AttributeBuilder	redirectStrategy(HttpRedirectStrategy value) HTTP redirect response strategy (follow or throw an error).
GoogleDocumentSourceDescriptor.AttributeBuilder	redirectStrategy(org.carrot2.util.attribute.IObjectFactory<? extends HttpRedirectStrategy> value) HTTP redirect response strategy (follow or throw an error).
GoogleDocumentSourceDescriptor.AttributeBuilder	referer(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Request referrer.
GoogleDocumentSourceDescriptor.AttributeBuilder	referer(String value) Request referrer.
GoogleDocumentSourceDescriptor.AttributeBuilder	serviceUrl(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Service URL.
GoogleDocumentSourceDescriptor.AttributeBuilder	serviceUrl(String value) Service 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

GoogleDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

serviceUrl

public GoogleDocumentSourceDescriptor.AttributeBuilder serviceUrl(String value)

Service URL. Google web search service URL.

See Also:

GoogleDocumentSource.serviceUrl

serviceUrl

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

Service URL. Google web search service URL.

See Also:

GoogleDocumentSource.serviceUrl

referer

public GoogleDocumentSourceDescriptor.AttributeBuilder referer(String value)

Request referrer. Please do not use the default value when deploying this component in production environments. Instead, put the URL to your application here.

See Also:

GoogleDocumentSource.referer

referer

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

Request referrer. Please do not use the default value when deploying this component in production environments. Instead, put the URL to your application here.

See Also:

GoogleDocumentSource.referer

keepHighlights

public GoogleDocumentSourceDescriptor.AttributeBuilder keepHighlights(boolean value)

Keep query word highlighting. Google by default highlights query words in snippets using the bold HTML tag. Set this attribute to true to keep these highlights.

See Also:

GoogleDocumentSource.keepHighlights

keepHighlights

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

Keep query word highlighting. Google by default highlights query words in snippets using the bold HTML tag. Set this attribute to true to keep these highlights.

See Also:

GoogleDocumentSource.keepHighlights

redirectStrategy

public GoogleDocumentSourceDescriptor.AttributeBuilder redirectStrategy(HttpRedirectStrategy value)

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

See Also:

GoogleDocumentSource.redirectStrategy

redirectStrategy

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

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

See Also:

GoogleDocumentSource.redirectStrategy