org.carrot2.clustering.synthetic

Class ByFieldClusteringAlgorithm

java.lang.Object

org.carrot2.core.ProcessingComponentBase

org.carrot2.clustering.synthetic.ByFieldClusteringAlgorithm

All Implemented Interfaces:

IClusteringAlgorithm, IProcessingComponent

@Bindable(prefix="ByAttributeClusteringAlgorithm",
          inherit=CommonAttributes.class)
@Label(value="By Attribute Clustering")
public class ByFieldClusteringAlgorithm
extends ProcessingComponentBase
implements IClusteringAlgorithm

Clusters documents into a flat structure based on the values of some field of the documents. By default the Document.SOURCES field is used.

Field Summary

Fields

Modifier and Type	Field and Description
List<Cluster>	clusters Clusters created by the algorithm.
List<Document>	documents Documents to cluster.
String	fieldName Name of the field to cluster by.

Constructor Summary

Constructors

Constructor and Description
ByFieldClusteringAlgorithm()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildClusterLabel(Object fieldValue) Builds cluster label based on the field value.
void	process() Performs by URL clustering.

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

documents

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

Documents to cluster.

clusters

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

Clusters created by the algorithm.

fieldName

@Processing
@Input
@Attribute
@Required
@Level(value=BASIC)
@Group(value="Fields")
@Label(value="Field name")
public String fieldName

Name of the field to cluster by. Each non-null scalar field value with distinct hash code will give rise to a single cluster, named using the value returned by buildClusterLabel(Object). If the field value is a collection, the document will be assigned to all clusters corresponding to the values in the collection. Note that arrays will not be 'unfolded' in this way.

Constructor Detail

ByFieldClusteringAlgorithm

public ByFieldClusteringAlgorithm()

Method Detail

process

public void process()
             throws ProcessingException

Performs by URL clustering.

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.

buildClusterLabel

protected String buildClusterLabel(Object fieldValue)

Builds cluster label based on the field value. This implementation returns fieldValue.toString().