org.carrot2.source.idol

Class IdolDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.MultipageSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.idol.IdolDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

IdolDocumentSourceDescriptor

public static class IdolDocumentSourceDescriptor.AttributeBuilder
extends MultipageSearchEngineDescriptor.AttributeBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
IdolDocumentSourceDescriptor.AttributeBuilder	idolServerName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) URL of the IDOL Server.
IdolDocumentSourceDescriptor.AttributeBuilder	idolServerName(String value) URL of the IDOL Server.
IdolDocumentSourceDescriptor.AttributeBuilder	idolServerPort(int value) IDOL Server Port.
IdolDocumentSourceDescriptor.AttributeBuilder	idolServerPort(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) IDOL Server Port.
IdolDocumentSourceDescriptor.AttributeBuilder	maximumResults(int value) Maximum number of results.
IdolDocumentSourceDescriptor.AttributeBuilder	maximumResults(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum number of results.
IdolDocumentSourceDescriptor.AttributeBuilder	minScore(int value) Minimum IDOL Score.
IdolDocumentSourceDescriptor.AttributeBuilder	minScore(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Minimum IDOL Score.
IdolDocumentSourceDescriptor.AttributeBuilder	otherSearchAttributes(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Any other search attributes (separated by &) from the Autonomy Query Search API's Ensure all the attributes are entered to satisfy XSL that will be applied.
IdolDocumentSourceDescriptor.AttributeBuilder	otherSearchAttributes(String value) Any other search attributes (separated by &) from the Autonomy Query Search API's Ensure all the attributes are entered to satisfy XSL that will be applied.
IdolDocumentSourceDescriptor.AttributeBuilder	resultsPerPage(int value) Results per page.
IdolDocumentSourceDescriptor.AttributeBuilder	resultsPerPage(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Results per page.
IdolDocumentSourceDescriptor.AttributeBuilder	userAgent(org.carrot2.util.attribute.IObjectFactory<? extends String> value) User agent header.
IdolDocumentSourceDescriptor.AttributeBuilder	userAgent(String value) User agent header.
IdolDocumentSourceDescriptor.AttributeBuilder	userName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) User name to use for authentication.
IdolDocumentSourceDescriptor.AttributeBuilder	userName(String value) User name to use for authentication.
IdolDocumentSourceDescriptor.AttributeBuilder	xslTemplateName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) IDOL XSL Template Name.
IdolDocumentSourceDescriptor.AttributeBuilder	xslTemplateName(String value) IDOL XSL Template Name.

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

IdolDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

idolServerName

public IdolDocumentSourceDescriptor.AttributeBuilder idolServerName(String value)

URL of the IDOL Server.

See Also:

IdolDocumentSource.idolServerName

idolServerName

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

URL of the IDOL Server.

See Also:

IdolDocumentSource.idolServerName

idolServerPort

public IdolDocumentSourceDescriptor.AttributeBuilder idolServerPort(int value)

IDOL Server Port.

See Also:

IdolDocumentSource.idolServerPort

idolServerPort

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

IDOL Server Port.

See Also:

IdolDocumentSource.idolServerPort

xslTemplateName

public IdolDocumentSourceDescriptor.AttributeBuilder xslTemplateName(String value)

IDOL XSL Template Name. The Reference of an IDOL XSL template that outputs the results in OpenSearch format.

See Also:

IdolDocumentSource.xslTemplateName

xslTemplateName

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

IDOL XSL Template Name. The Reference of an IDOL XSL template that outputs the results in OpenSearch format.

See Also:

IdolDocumentSource.xslTemplateName

otherSearchAttributes

public IdolDocumentSourceDescriptor.AttributeBuilder otherSearchAttributes(String value)

Any other search attributes (separated by &) from the Autonomy Query Search API's Ensure all the attributes are entered to satisfy XSL that will be applied.

See Also:

IdolDocumentSource.otherSearchAttributes

otherSearchAttributes

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

Any other search attributes (separated by &) from the Autonomy Query Search API's Ensure all the attributes are entered to satisfy XSL that will be applied.

See Also:

IdolDocumentSource.otherSearchAttributes

resultsPerPage

public IdolDocumentSourceDescriptor.AttributeBuilder resultsPerPage(int value)

Results per page. The number of results per page the document source will expect the feed to return.

See Also:

IdolDocumentSource.resultsPerPage

resultsPerPage

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

Results per page. The number of results per page the document source will expect the feed to return.

See Also:

IdolDocumentSource.resultsPerPage

minScore

public IdolDocumentSourceDescriptor.AttributeBuilder minScore(int value)

Minimum IDOL Score. The minimum score of the results returned by IDOL.

See Also:

IdolDocumentSource.minScore

minScore

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

Minimum IDOL Score. The minimum score of the results returned by IDOL.

See Also:

IdolDocumentSource.minScore

maximumResults

public IdolDocumentSourceDescriptor.AttributeBuilder maximumResults(int value)

Maximum number of results. The maximum number of results the document source can deliver.

See Also:

IdolDocumentSource.maximumResults

maximumResults

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

Maximum number of results. The maximum number of results the document source can deliver.

See Also:

IdolDocumentSource.maximumResults

userAgent

public IdolDocumentSourceDescriptor.AttributeBuilder userAgent(String value)

User agent header. The contents of the User-Agent HTTP header to use when making requests to the feed URL. If empty or null value is provided, the following User-Agent will be sent: Rome Client (http://tinyurl.com/64t5n) Ver: UNKNOWN.

See Also:

IdolDocumentSource.userAgent

userAgent

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

User agent header. The contents of the User-Agent HTTP header to use when making requests to the feed URL. If empty or null value is provided, the following User-Agent will be sent: Rome Client (http://tinyurl.com/64t5n) Ver: UNKNOWN.

See Also:

IdolDocumentSource.userAgent

userName

public IdolDocumentSourceDescriptor.AttributeBuilder userName(String value)

User name to use for authentication.

See Also:

IdolDocumentSource.userName

userName

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

User name to use for authentication.

See Also:

IdolDocumentSource.userName