org.carrot2.core.attribute
Class CommonAttributes

java.lang.Object
  org.carrot2.core.attribute.CommonAttributes

public final class CommonAttributes
extends Object

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

Field Summary

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

public int start

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

Attribute label:

Start Index

Attribute level:

Advanced

Attribute group:

Search query

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).

Attribute label:

Results

Attribute level:

Basic

Attribute group:

Search query

query

public String query

Query to perform.

Attribute label:

Query

Attribute level:

Basic

Attribute group:

Search query

resultsTotal

public Long resultsTotal

Estimated total number of matching documents.

Attribute label:

Total Results

Attribute group:

Search request information

documents

public List<Document> documents

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

Attribute label:

Documents

Attribute level:

Basic

Attribute group:

Documents

clusters

public List<Cluster> clusters

Clusters created by the clustering algorithm.

Attribute label:

Clusters

Attribute level:

Basic

Attribute group:

Clusters

processingTimeTotal

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.

Attribute label:

Total Processing Time

Attribute group:

Processing status

processingTimeSource

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.

Attribute label:

Data Source Processing Time

Attribute group:

Data source status

processingTimeAlgorithm

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.

Attribute label:

Clustering Algorithm Processing Time

Attribute group:

Clustering algorithm status

processingResultTitle

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.

Attribute label:

Title

Attribute level:

Advanced

Attribute group:

Search request information