org.carrot2.source.google
Class GoogleDesktopDocumentSourceDescriptor.AttributeBuilder

java.lang.Object
  org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder
      org.carrot2.source.SimpleSearchEngineDescriptor.AttributeBuilder
          org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder
              org.carrot2.source.google.GoogleDesktopDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

GoogleDesktopDocumentSourceDescriptor

public static class GoogleDesktopDocumentSourceDescriptor.AttributeBuilder
extends RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

Attribute map builder for the GoogleDesktopDocumentSource 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

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

Method Summary

GoogleDesktopDocumentSourceDescriptor.AttributeBuilder	keepHighlights(boolean value) Keep query word highlighting.
GoogleDesktopDocumentSourceDescriptor.AttributeBuilder	queryUrl(String value) Query URL.

Methods inherited from class org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

xmlDocumentSourceHelper

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

GoogleDesktopDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

queryUrl

public GoogleDesktopDocumentSourceDescriptor.AttributeBuilder queryUrl(String value)

Query URL. Installation-specific URL at which Google Desktop search service is available. On Windows machines, the URL is available at the HKEY_CURRENT_USER\Software\Google\Google Desktop\API\search_url system registry key and Carrot2 will attempt to automatically read the value from the registry when run with Administrator provileges. Please consult Google Desktop API documentation for further instructions on how to determine the query URL on other systems.

See Also:

GoogleDesktopDocumentSource.queryUrl

keepHighlights

public GoogleDesktopDocumentSourceDescriptor.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:

GoogleDesktopDocumentSource.keepHighlights