org.carrot2.source

Class SearchEngineBaseDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

Direct Known Subclasses:

MultipageSearchEngineDescriptor.AttributeBuilder, SimpleSearchEngineDescriptor.AttributeBuilder

Enclosing class:

SearchEngineBaseDescriptor

public static class SearchEngineBaseDescriptor.AttributeBuilder
extends Object

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compressed() Indicates whether the search engine returned a compressed result stream.
Collection<Document>	documents()
SearchEngineBaseDescriptor.AttributeBuilder	query(org.carrot2.util.attribute.IObjectFactory<? extends String> value)
SearchEngineBaseDescriptor.AttributeBuilder	query(String value)
SearchEngineBaseDescriptor.AttributeBuilder	results(int value)
SearchEngineBaseDescriptor.AttributeBuilder	results(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
long	resultsTotal()
SearchEngineBaseDescriptor.AttributeBuilder	start(int value)
SearchEngineBaseDescriptor.AttributeBuilder	start(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

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

SearchEngineBaseDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

start

public SearchEngineBaseDescriptor.AttributeBuilder start(int value)

See Also:

SearchEngineBase.start

start

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

See Also:

SearchEngineBase.start

results

public SearchEngineBaseDescriptor.AttributeBuilder results(int value)

See Also:

SearchEngineBase.results

results

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

See Also:

SearchEngineBase.results

query

public SearchEngineBaseDescriptor.AttributeBuilder query(String value)

See Also:

SearchEngineBase.query

query

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

See Also:

SearchEngineBase.query

resultsTotal

public long resultsTotal()

See Also:

SearchEngineBase.resultsTotal

documents

public Collection<Document> documents()

See Also:

SearchEngineBase.documents

compressed

public boolean compressed()

Indicates whether the search engine returned a compressed result stream.

See Also:

SearchEngineBase.compressed