org.carrot2.core.attribute

Class CommonAttributes

java.lang.Object

org.carrot2.core.attribute.CommonAttributes

@Bindable
public final class CommonAttributes
extends Object

Attributes shared and inherited by many clustering algorithms. Extracted for consistency.

Field Summary

Fields

Modifier and Type	Field and Description
List<Cluster>	clusters Clusters created by the clustering algorithm.
List<Document>	documents Documents returned by the search engine/ document retrieval system or documents passed as input to the clustering algorithm.
String	processingResultTitle Processing result title.
Long	processingTimeAlgorithm Algorithm processing time in milliseconds.
Long	processingTimeSource Data source processing time in milliseconds.
Long	processingTimeTotal Total processing time in milliseconds.
String	query Query to perform.
int	results Maximum number of documents/ search results to fetch.
Long	resultsTotal Estimated total number of matching documents.
int	start Index of the first document/ search result to fetch.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

start

@Input
 @Attribute(key="start")
 @Level(value=ADVANCED)
 @Group(value="Search query")
 @Label(value="Start index")
public int start

Index of the first document/ search result to fetch. The index starts at zero.

results

@Input
 @Attribute(key="results")
 @Level(value=BASIC)
 @Group(value="Search query")
 @Label(value="Results")
public int results

Maximum number of documents/ search results to fetch. The query hint can be used by clustering algorithms to avoid creating trivial clusters (combination of query words).

query

@Input
 @Attribute(key="query")
 @Level(value=BASIC)
 @Group(value="Search query")
 @Label(value="Query")
public String query

Query to perform.

resultsTotal

@Output
 @Attribute(key="results-total")
 @Label(value="Total results")
 @Group(value="Search result information")
public Long resultsTotal

Estimated total number of matching documents.

documents

@Input
 @Output
 @Attribute(key="documents")
 @Label(value="Documents")
 @Level(value=BASIC)
 @Group(value="Documents")
public List<Document> documents

Documents returned by the search engine/ document retrieval system or documents passed as input to the clustering algorithm.

clusters

@Output
 @Attribute(key="clusters")
 @Label(value="Clusters")
 @Level(value=BASIC)
 @Group(value="Search result information")
public List<Cluster> clusters

Clusters created by the clustering algorithm.

processingTimeTotal

@Output
 @Attribute(key="processing-time-total")
 @Label(value="Total processing time")
 @Level(value=BASIC)
 @Group(value="Search result information")
public Long processingTimeTotal

Total processing time in milliseconds. A sum of processing times of all components in the chain. Total processing time may be greater than the sum of processingTimeTotal and processingTimeAlgorithm.

processingTimeSource

@Output
 @Attribute(key="processing-time-source")
 @Label(value="Data source processing time")
 @Level(value=BASIC)
 @Group(value="Search result information")
public Long processingTimeSource

Data source processing time in milliseconds. A sum of processing times of all IDocumentSources in the chain, including the IProcessingComponent.beforeProcessing() and IProcessingComponent.afterProcessing() hooks.

processingTimeAlgorithm

@Output
 @Attribute(key="processing-time-algorithm")
 @Label(value="Clustering algorithm processing time")
 @Level(value=BASIC)
 @Group(value="Search result information")
public Long processingTimeAlgorithm

Algorithm processing time in milliseconds. A sum of processing times of all IClusteringAlgorithms in the chain, including the IProcessingComponent.beforeProcessing() and IProcessingComponent.afterProcessing() hooks.

processingResultTitle

@Output
 @Attribute(key="processing-result.title")
 @Label(value="Title")
 @Level(value=BASIC)
 @Group(value="Search result information")
public String processingResultTitle

Processing result title. A typical title for a processing result will be the query used to fetch documents from that source. For certain document sources the query may not be needed (on-disk XML, feed of syndicated news); in such cases, the input component should set its title properly for visual interfaces such as the workbench.