org.carrot2.source.etools

Class EToolsDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.SimpleSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.etools.EToolsDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

EToolsDocumentSourceDescriptor

public static class EToolsDocumentSourceDescriptor.AttributeBuilder
extends RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
EToolsDocumentSourceDescriptor.AttributeBuilder	country(EToolsDocumentSource.Country value) Determines the country of origin for the returned search results.
EToolsDocumentSourceDescriptor.AttributeBuilder	country(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.Country> value) Determines the country of origin for the returned search results.
EToolsDocumentSourceDescriptor.AttributeBuilder	customerId(org.carrot2.util.attribute.IObjectFactory<? extends String> value) eTools customer identifier.
EToolsDocumentSourceDescriptor.AttributeBuilder	customerId(String value) eTools customer identifier.
EToolsDocumentSourceDescriptor.AttributeBuilder	dataSources(EToolsDocumentSource.DataSources value) Determines which data sources to search.
EToolsDocumentSourceDescriptor.AttributeBuilder	dataSources(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.DataSources> value) Determines which data sources to search.
EToolsDocumentSourceDescriptor.AttributeBuilder	language(EToolsDocumentSource.Language value) Determines the language of the returned search results.
EToolsDocumentSourceDescriptor.AttributeBuilder	language(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.Language> value) Determines the language of the returned search results.
EToolsDocumentSourceDescriptor.AttributeBuilder	partnerId(org.carrot2.util.attribute.IObjectFactory<? extends String> value) eTools partner identifier.
EToolsDocumentSourceDescriptor.AttributeBuilder	partnerId(String value) eTools partner identifier.
EToolsDocumentSourceDescriptor.AttributeBuilder	safeSearch(boolean value) If enabled, excludes offensive content from the results.
EToolsDocumentSourceDescriptor.AttributeBuilder	safeSearch(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) If enabled, excludes offensive content from the results.
EToolsDocumentSourceDescriptor.AttributeBuilder	serviceUrlBase(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Base URL for the eTools service
EToolsDocumentSourceDescriptor.AttributeBuilder	serviceUrlBase(String value) Base URL for the eTools service
EToolsDocumentSourceDescriptor.AttributeBuilder	site(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Site URL or comma-separated list of site site URLs to which the returned results should be restricted.
EToolsDocumentSourceDescriptor.AttributeBuilder	site(String value) Site URL or comma-separated list of site site URLs to which the returned results should be restricted.
EToolsDocumentSourceDescriptor.AttributeBuilder	timeout(int value) Maximum time in milliseconds to wait for all data sources to return results.
EToolsDocumentSourceDescriptor.AttributeBuilder	timeout(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum time in milliseconds to wait for all data sources to return results.

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

redirectStrategy, redirectStrategy, xmlDocumentSourceHelper

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

EToolsDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

serviceUrlBase

public EToolsDocumentSourceDescriptor.AttributeBuilder serviceUrlBase(String value)

Base URL for the eTools service

See Also:

EToolsDocumentSource.serviceUrlBase

serviceUrlBase

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

Base URL for the eTools service

See Also:

EToolsDocumentSource.serviceUrlBase

country

public EToolsDocumentSourceDescriptor.AttributeBuilder country(EToolsDocumentSource.Country value)

Determines the country of origin for the returned search results.

See Also:

EToolsDocumentSource.country

country

public EToolsDocumentSourceDescriptor.AttributeBuilder country(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.Country> value)

Determines the country of origin for the returned search results.

See Also:

EToolsDocumentSource.country

language

public EToolsDocumentSourceDescriptor.AttributeBuilder language(EToolsDocumentSource.Language value)

Determines the language of the returned search results.

See Also:

EToolsDocumentSource.language

language

public EToolsDocumentSourceDescriptor.AttributeBuilder language(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.Language> value)

Determines the language of the returned search results.

See Also:

EToolsDocumentSource.language

timeout

public EToolsDocumentSourceDescriptor.AttributeBuilder timeout(int value)

Maximum time in milliseconds to wait for all data sources to return results.

See Also:

EToolsDocumentSource.timeout

timeout

public EToolsDocumentSourceDescriptor.AttributeBuilder timeout(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Maximum time in milliseconds to wait for all data sources to return results.

See Also:

EToolsDocumentSource.timeout

dataSources

public EToolsDocumentSourceDescriptor.AttributeBuilder dataSources(EToolsDocumentSource.DataSources value)

Determines which data sources to search.

See Also:

EToolsDocumentSource.dataSources

dataSources

public EToolsDocumentSourceDescriptor.AttributeBuilder dataSources(org.carrot2.util.attribute.IObjectFactory<? extends EToolsDocumentSource.DataSources> value)

Determines which data sources to search.

See Also:

EToolsDocumentSource.dataSources

safeSearch

public EToolsDocumentSourceDescriptor.AttributeBuilder safeSearch(boolean value)

If enabled, excludes offensive content from the results.

See Also:

EToolsDocumentSource.safeSearch

safeSearch

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

If enabled, excludes offensive content from the results.

See Also:

EToolsDocumentSource.safeSearch

site

public EToolsDocumentSourceDescriptor.AttributeBuilder site(String value)

Site URL or comma-separated list of site site URLs to which the returned results should be restricted. For example: wikipedia.org or en.wikipedia.org,de.wikipedia.org. Very larger lists of site restrictions (larger than 2000 characters) may result in a processing exception.

See Also:

EToolsDocumentSource.site

site

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

Site URL or comma-separated list of site site URLs to which the returned results should be restricted. For example: wikipedia.org or en.wikipedia.org,de.wikipedia.org. Very larger lists of site restrictions (larger than 2000 characters) may result in a processing exception.

See Also:

EToolsDocumentSource.site

partnerId

public EToolsDocumentSourceDescriptor.AttributeBuilder partnerId(String value)

eTools partner identifier. If you have commercial arrangements with eTools, specify your partner id here.

See Also:

EToolsDocumentSource.partnerId

partnerId

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

eTools partner identifier. If you have commercial arrangements with eTools, specify your partner id here.

See Also:

EToolsDocumentSource.partnerId

customerId

public EToolsDocumentSourceDescriptor.AttributeBuilder customerId(String value)

eTools customer identifier. For commercial use of eTools, please e-mail: contact@comcepta.com to obtain your customer identifier.

See Also:

EToolsDocumentSource.customerId

customerId

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

eTools customer identifier. For commercial use of eTools, please e-mail: contact@comcepta.com to obtain your customer identifier.

See Also:

EToolsDocumentSource.customerId