org.carrot2.source.ambient

Class AmbientDocumentSource

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.source.ambient.FubDocumentSource

org.carrot2.source.ambient.AmbientDocumentSource

All Implemented Interfaces:

IDocumentSource, IProcessingComponent

@Bindable(prefix="AmbientDocumentSource",
          inherit=CommonAttributes.class)
public class AmbientDocumentSource
extends FubDocumentSource

Serves documents from the Ambient test set. Ambient (AMBIgous ENTries) is a data set designed for evaluating subtopic information retrieval. It consists of 44 topics, each with a set of subtopics and a list of 100 ranked documents. For more information, please see Ambient home page.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmbientDocumentSource.AmbientTopic All available Ambient topics.

Field Summary

Fields

Modifier and Type	Field and Description
int	results
long	resultsTotal
AmbientDocumentSource.AmbientTopic	topic Ambient Topic.

Fields inherited from class org.carrot2.source.ambient.FubDocumentSource

documents, includeDocumentsWithoutTopic, minTopicSize, query, TOPIC_ID, topicIds

Constructor Summary

Constructors

Constructor and Description
AmbientDocumentSource()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getTopicLabel(String topicId)
void	process() Performs the processing required to fulfill the request.

Methods inherited from class org.carrot2.source.ambient.FubDocumentSource

processInternal

Methods inherited from class org.carrot2.core.ProcessingComponentBase

afterProcessing, beforeProcessing, dispose, getContext, getSharedExecutor, init

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

Field Detail

topic

@Input
@Processing
@Attribute
@Required
@Group(value="Topic ID")
@Level(value=BASIC)
public AmbientDocumentSource.AmbientTopic topic

Ambient Topic. The Ambient Topic to load documents from.

results

@Processing
@Input
@Attribute(key="results",
           inherit=true)
@IntRange(min=1,
          max=100)
public int results

resultsTotal

@Processing
@Output
@Attribute(key="results-total",
           inherit=true)
public long resultsTotal

Constructor Detail

AmbientDocumentSource

public AmbientDocumentSource()

Method Detail

process

public void process()
             throws ProcessingException

Description copied from interface: IProcessingComponent

Performs the processing required to fulfill the request. This method is called once per request.

Specified by:

process in interface IProcessingComponent

Overrides:

process in class ProcessingComponentBase

Throws:

ProcessingException - when processing failed. If thrown, the IProcessingComponent.afterProcessing() method will be called and the component will be ready to accept further requests or to be disposed of. Finally, the exception will be rethrown from the controller method that caused the component to perform processing.

getTopicLabel

public static String getTopicLabel(String topicId)