org.carrot2.source.ambient

Class AmbientDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.ambient.FubDocumentSourceDescriptor.AttributeBuilder

org.carrot2.source.ambient.AmbientDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

AmbientDocumentSourceDescriptor

public static class AmbientDocumentSourceDescriptor.AttributeBuilder
extends FubDocumentSourceDescriptor.AttributeBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
AmbientDocumentSourceDescriptor.AttributeBuilder	results(int value)
AmbientDocumentSourceDescriptor.AttributeBuilder	results(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
long	resultsTotal()
AmbientDocumentSourceDescriptor.AttributeBuilder	topic(AmbientDocumentSource.AmbientTopic value) Ambient Topic.
AmbientDocumentSourceDescriptor.AttributeBuilder	topic(org.carrot2.util.attribute.IObjectFactory<? extends AmbientDocumentSource.AmbientTopic> value) Ambient Topic.

Methods inherited from class org.carrot2.source.ambient.FubDocumentSourceDescriptor.AttributeBuilder

documents, includeDocumentsWithoutTopic, includeDocumentsWithoutTopic, minTopicSize, minTopicSize, query, topicIds

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

AmbientDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

topic

public AmbientDocumentSourceDescriptor.AttributeBuilder topic(AmbientDocumentSource.AmbientTopic value)

Ambient Topic. The Ambient Topic to load documents from.

See Also:

AmbientDocumentSource.topic

topic

public AmbientDocumentSourceDescriptor.AttributeBuilder topic(org.carrot2.util.attribute.IObjectFactory<? extends AmbientDocumentSource.AmbientTopic> value)

Ambient Topic. The Ambient Topic to load documents from.

See Also:

AmbientDocumentSource.topic

results

public AmbientDocumentSourceDescriptor.AttributeBuilder results(int value)

See Also:

AmbientDocumentSource.results

results

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

See Also:

AmbientDocumentSource.results

resultsTotal

public long resultsTotal()

See Also:

AmbientDocumentSource.resultsTotal