org.carrot2.clustering.lingo

Class LingoClusteringAlgorithmDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.clustering.lingo.LingoClusteringAlgorithmDescriptor.AttributeBuilder

Enclosing class:

LingoClusteringAlgorithmDescriptor

public static class LingoClusteringAlgorithmDescriptor.AttributeBuilder
extends Object

Attribute map builder for the LingoClusteringAlgorithm component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LingoClusteringAlgorithmDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
ClusterBuilderDescriptor.AttributeBuilder	clusterBuilder() Returns an attribute builder for the nested ClusterBuilder component, backed by the same attribute map as the current builder.
List<Cluster>	clusters()
LingoClusteringAlgorithmDescriptor.AttributeBuilder	desiredClusterCountBase(int value) Desired cluster count base.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	desiredClusterCountBase(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Desired cluster count base.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value) Documents to cluster.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	documents(List<Document> value) Documents to cluster.
LabelFormatterDescriptor.AttributeBuilder	labelFormatter() Returns an attribute builder for the nested LabelFormatter component, backed by the same attribute map as the current builder.
TermDocumentMatrixBuilderDescriptor.AttributeBuilder	matrixBuilder() Returns an attribute builder for the nested TermDocumentMatrixBuilder component, backed by the same attribute map as the current builder.
TermDocumentMatrixReducerDescriptor.AttributeBuilder	matrixReducer() Returns an attribute builder for the nested TermDocumentMatrixReducer component, backed by the same attribute map as the current builder.
MultilingualClusteringDescriptor.AttributeBuilder	multilingualClustering() Returns an attribute builder for the nested MultilingualClustering component, backed by the same attribute map as the current builder.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(Class<?> clazz) Common preprocessing tasks handler, contains bindable attributes.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value) Common preprocessing tasks handler, contains bindable attributes.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	preprocessingPipeline(IPreprocessingPipeline value) Common preprocessing tasks handler, contains bindable attributes.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	query(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Query that produced the documents.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	query(String value) Query that produced the documents.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	scoreWeight(double value) Balance between cluster score and size during cluster sorting.
LingoClusteringAlgorithmDescriptor.AttributeBuilder	scoreWeight(org.carrot2.util.attribute.IObjectFactory<? extends Double> value) Balance between cluster score and size during cluster sorting.

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

LingoClusteringAlgorithmDescriptor.AttributeBuilder

protected LingoClusteringAlgorithmDescriptor.AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

query

public LingoClusteringAlgorithmDescriptor.AttributeBuilder query(String value)

Query that produced the documents. The query will help the algorithm to create better clusters. Therefore, providing the query is optional but desirable.

See Also:

LingoClusteringAlgorithm.query

query

public LingoClusteringAlgorithmDescriptor.AttributeBuilder query(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Query that produced the documents. The query will help the algorithm to create better clusters. Therefore, providing the query is optional but desirable.

See Also:

LingoClusteringAlgorithm.query

documents

public LingoClusteringAlgorithmDescriptor.AttributeBuilder documents(List<Document> value)

Documents to cluster.

See Also:

LingoClusteringAlgorithm.documents

documents

public LingoClusteringAlgorithmDescriptor.AttributeBuilder documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value)

Documents to cluster.

See Also:

LingoClusteringAlgorithm.documents

clusters

public List<Cluster> clusters()

See Also:

LingoClusteringAlgorithm.clusters

scoreWeight

public LingoClusteringAlgorithmDescriptor.AttributeBuilder scoreWeight(double value)

Balance between cluster score and size during cluster sorting. Value equal to 0.0 will cause Lingo to sort clusters based only on cluster size. Value equal to 1.0 will cause Lingo to sort clusters based only on cluster score.

See Also:

LingoClusteringAlgorithm.scoreWeight

scoreWeight

public LingoClusteringAlgorithmDescriptor.AttributeBuilder scoreWeight(org.carrot2.util.attribute.IObjectFactory<? extends Double> value)

Balance between cluster score and size during cluster sorting. Value equal to 0.0 will cause Lingo to sort clusters based only on cluster size. Value equal to 1.0 will cause Lingo to sort clusters based only on cluster score.

See Also:

LingoClusteringAlgorithm.scoreWeight

desiredClusterCountBase

public LingoClusteringAlgorithmDescriptor.AttributeBuilder desiredClusterCountBase(int value)

Desired cluster count base. Base factor used to calculate the number of clusters based on the number of documents on input. The larger the value, the more clusters will be created. The number of clusters created by the algorithm will be proportional to the cluster count base, but not in a linear way.

See Also:

LingoClusteringAlgorithm.desiredClusterCountBase

desiredClusterCountBase

public LingoClusteringAlgorithmDescriptor.AttributeBuilder desiredClusterCountBase(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Desired cluster count base. Base factor used to calculate the number of clusters based on the number of documents on input. The larger the value, the more clusters will be created. The number of clusters created by the algorithm will be proportional to the cluster count base, but not in a linear way.

See Also:

LingoClusteringAlgorithm.desiredClusterCountBase

preprocessingPipeline

public LingoClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(IPreprocessingPipeline value)

Common preprocessing tasks handler, contains bindable attributes.

See Also:

LingoClusteringAlgorithm.preprocessingPipeline

preprocessingPipeline

public LingoClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(Class<?> clazz)

Common preprocessing tasks handler, contains bindable attributes. A class that extends org.carrot2.text.preprocessing.pipeline.IPreprocessingPipeline or appropriate IObjectFactory.

See Also:

LingoClusteringAlgorithm.preprocessingPipeline

preprocessingPipeline

public LingoClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value)

Common preprocessing tasks handler, contains bindable attributes.

See Also:

LingoClusteringAlgorithm.preprocessingPipeline

matrixBuilder

public TermDocumentMatrixBuilderDescriptor.AttributeBuilder matrixBuilder()

Returns an attribute builder for the nested TermDocumentMatrixBuilder component, backed by the same attribute map as the current builder.

matrixReducer

public TermDocumentMatrixReducerDescriptor.AttributeBuilder matrixReducer()

Returns an attribute builder for the nested TermDocumentMatrixReducer component, backed by the same attribute map as the current builder.

clusterBuilder

public ClusterBuilderDescriptor.AttributeBuilder clusterBuilder()

Returns an attribute builder for the nested ClusterBuilder component, backed by the same attribute map as the current builder.

labelFormatter

public LabelFormatterDescriptor.AttributeBuilder labelFormatter()

Returns an attribute builder for the nested LabelFormatter component, backed by the same attribute map as the current builder.

multilingualClustering

public MultilingualClusteringDescriptor.AttributeBuilder multilingualClustering()

Returns an attribute builder for the nested MultilingualClustering component, backed by the same attribute map as the current builder.