org.carrot2.source.pubmed

Class PubMedDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.SimpleSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.pubmed.PubMedDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

PubMedDocumentSourceDescriptor

public static class PubMedDocumentSourceDescriptor.AttributeBuilder
extends SimpleSearchEngineDescriptor.AttributeBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
PubMedDocumentSourceDescriptor.AttributeBuilder	maxResults(int value) Maximum results to fetch.
PubMedDocumentSourceDescriptor.AttributeBuilder	maxResults(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Maximum results to fetch.
PubMedDocumentSourceDescriptor.AttributeBuilder	redirectStrategy(HttpRedirectStrategy value) HTTP redirect response strategy (follow or throw an error).
PubMedDocumentSourceDescriptor.AttributeBuilder	redirectStrategy(org.carrot2.util.attribute.IObjectFactory<? extends HttpRedirectStrategy> value) HTTP redirect response strategy (follow or throw an error).
PubMedDocumentSourceDescriptor.AttributeBuilder	toolName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Tool name, if registered.
PubMedDocumentSourceDescriptor.AttributeBuilder	toolName(String value) Tool name, if registered.

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

PubMedDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

toolName

public PubMedDocumentSourceDescriptor.AttributeBuilder toolName(String value)

Tool name, if registered.

See Also:

PubMedDocumentSource.toolName

toolName

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

Tool name, if registered.

See Also:

PubMedDocumentSource.toolName

maxResults

public PubMedDocumentSourceDescriptor.AttributeBuilder maxResults(int value)

Maximum results to fetch. No more than the specified number of results will be fetched from PubMed, regardless of the requested number of results.

See Also:

PubMedDocumentSource.maxResults

maxResults

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

Maximum results to fetch. No more than the specified number of results will be fetched from PubMed, regardless of the requested number of results.

See Also:

PubMedDocumentSource.maxResults

redirectStrategy

public PubMedDocumentSourceDescriptor.AttributeBuilder redirectStrategy(HttpRedirectStrategy value)

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

See Also:

PubMedDocumentSource.redirectStrategy

redirectStrategy

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

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

See Also:

PubMedDocumentSource.redirectStrategy