org.carrot2.source.ambient
Class FubDocumentSource

java.lang.Object
  org.carrot2.core.ProcessingComponentBase
      org.carrot2.source.ambient.FubDocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

Direct Known Subclasses:

AmbientDocumentSource, Odp239DocumentSource

public class FubDocumentSource
extends ProcessingComponentBase
implements IDocumentSource

A base document source for test collections developed at Fondazione Ugo Bordoni.

Field Summary

List<Document>	documents
boolean	includeDocumentsWithoutTopic Include documents without topics.
int	minTopicSize Minimum topic size.
String	query
Set<Object>	topicIds Topics and subtopics covered in the output documents.

Constructor Summary

FubDocumentSource()

Method Summary

protected void

processInternal(org.carrot2.source.ambient.FubTestCollection data, int topicId, int requestedResults)

Methods inherited from class org.carrot2.core.ProcessingComponentBase

afterProcessing, beforeProcessing, dispose, getContext, getSharedExecutor, init, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.carrot2.core.IProcessingComponent

afterProcessing, beforeProcessing, dispose, init, process

Field Detail

documents

public List<Document> documents

topicIds

public Set<Object> topicIds

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

Attribute level:

Advanced

Attribute group:

Topic ID

query

public String query

minTopicSize

public int minTopicSize

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

Attribute level:

Medium

Attribute group:

Filtering

includeDocumentsWithoutTopic

public boolean includeDocumentsWithoutTopic

Include documents without topics.

Attribute level:

Medium

Attribute group:

Filtering

Constructor Detail

FubDocumentSource

public FubDocumentSource()

Method Detail

processInternal

protected void processInternal(org.carrot2.source.ambient.FubTestCollection data,
                               int topicId,
                               int requestedResults)
                        throws ProcessingException

Throws:

ProcessingException