org.carrot2.source.ambient
Class FubDocumentSourceDescriptor.AttributeBuilder

java.lang.Object
  org.carrot2.source.ambient.FubDocumentSourceDescriptor.AttributeBuilder

Direct Known Subclasses:

AmbientDocumentSourceDescriptor.AttributeBuilder, Odp239DocumentSourceDescriptor.AttributeBuilder

Enclosing class:

FubDocumentSourceDescriptor

public static class FubDocumentSourceDescriptor.AttributeBuilder
extends Object

Attribute map builder for the FubDocumentSource component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Map<String,Object>

map The attribute map populated by this builder.

Constructor Summary

protected

FubDocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

List<Document>	documents()
FubDocumentSourceDescriptor.AttributeBuilder	minTopicSize(int value) Minimum topic size.
String	query()
Set<Object>	topicIds() Topics and subtopics covered in the output documents.

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

FubDocumentSourceDescriptor.AttributeBuilder

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

Creates a builder backed by the provided map.

Method Detail

documents

public List<Document> documents()

See Also:

FubDocumentSource.documents

topicIds

public Set<Object> topicIds()

Topics and subtopics covered in the output documents. The set is computed for the output FubDocumentSource.documents and it may vary for the same main topic based e.g. on the requested number of requested results or FubDocumentSource.minTopicSize.

See Also:

FubDocumentSource.topicIds

query

public String query()

See Also:

FubDocumentSource.query

minTopicSize

public FubDocumentSourceDescriptor.AttributeBuilder minTopicSize(int value)

Minimum topic size. Documents belonging to a topic with fewer documents than minimum topic size will not be returned.

See Also:

FubDocumentSource.minTopicSize