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

@Bindable(prefix="FubDocumentSource",
          inherit=CommonAttributes.class)
public class FubDocumentSource
extends ProcessingComponentBase
implements IDocumentSource

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

Field Summary

Fields

Modifier and Type	Field and Description
List<Document>	documents
boolean	includeDocumentsWithoutTopic Include documents without topics.
int	minTopicSize Minimum topic size.
String	query
protected static String	TOPIC_ID Group name.
Set<Object>	topicIds Topics and subtopics covered in the output documents.

Constructor Summary

Constructors

Constructor and Description
FubDocumentSource()

Method Summary

Methods

Modifier and Type	Method and Description
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

TOPIC_ID

protected static final String TOPIC_ID

Group name.

See Also:

Constant Field Values

documents

@Processing
@Output
@Attribute(key="documents",
           inherit=true)
@Internal
public List<Document> documents

topicIds

@Processing
@Output
@Attribute
@Group(value="Topic ID")
@Level(value=ADVANCED)
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.

query

@Processing
@Output
@Attribute(key="query",
           inherit=true)
public String query

minTopicSize

@Input
@Processing
@Attribute
@IntRange(min=1)
@Group(value="Filtering")
@Level(value=MEDIUM)
public int minTopicSize

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

includeDocumentsWithoutTopic

@Input
@Processing
@Attribute
@Group(value="Filtering")
@Level(value=MEDIUM)
public boolean includeDocumentsWithoutTopic

Include documents without topics.

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