BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder (Carrot2 v3.17.0-SNAPSHOT API Documentation (JavaDoc))

java.lang.Object
- org.carrot2.clustering.kmeans.BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder

Enclosing class:

BisectingKMeansClusteringAlgorithmDescriptor
```
public static class BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder
extends Object
```
Attribute map builder for the BisectingKMeansClusteringAlgorithm 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.

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 AttributeBuilder(Map<String,Object> map)
Creates a builder backed by the provided map.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`clusterCount(int value)` The number of clusters to create.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`clusterCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)` The number of clusters to create.
`List<Cluster>`	`clusters()`
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value)`
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`documents(List<Document> value)`
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`labelCount(int value)` Label count.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`labelCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)` Label count.
`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.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`maxIterations(int value)` The maximum number of k-means iterations to perform.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`maxIterations(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)` The maximum number of k-means iterations to perform.
`MultilingualClusteringDescriptor.AttributeBuilder`	`multilingualClustering()` Returns an attribute builder for the nested `MultilingualClustering` component, backed by the same attribute map as the current builder.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`partitionCount(int value)` Partition count.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`partitionCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)` Partition count.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`preprocessingPipeline(Class<?> clazz)` Common preprocessing tasks handler.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value)` Common preprocessing tasks handler.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`preprocessingPipeline(IPreprocessingPipeline value)` Common preprocessing tasks handler.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`useDimensionalityReduction(boolean value)` Use dimensionality reduction.
`BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder`	`useDimensionalityReduction(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)` Use dimensionality reduction.

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
  - AttributeBuilder
```
protected AttributeBuilder(Map<String,Object> map)
```
    Creates a builder backed by the provided map.
- Method Detail
  - documents
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder documents(List<Document> value)
```
    See Also:
    
    BisectingKMeansClusteringAlgorithm.documents
  - documents
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder documents(org.carrot2.util.attribute.IObjectFactory<? extends List<Document>> value)
```
    See Also:
    
    BisectingKMeansClusteringAlgorithm.documents
  - clusters
```
public List<Cluster> clusters()
```
    See Also:
    
    BisectingKMeansClusteringAlgorithm.clusters
  - clusterCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder clusterCount(int value)
```
    The number of clusters to create. The algorithm will create at most the specified number of clusters.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.clusterCount
  - clusterCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder clusterCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
```
    The number of clusters to create. The algorithm will create at most the specified number of clusters.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.clusterCount
  - maxIterations
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder maxIterations(int value)
```
    The maximum number of k-means iterations to perform.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.maxIterations
  - maxIterations
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder maxIterations(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
```
    The maximum number of k-means iterations to perform.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.maxIterations
  - useDimensionalityReduction
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder useDimensionalityReduction(boolean value)
```
    Use dimensionality reduction. If true, k-means will be applied on the dimensionality-reduced term-document matrix with the number of dimensions being equal to twice the number of requested clusters. If the number of dimensions is lower than the number of input documents, reduction will not be performed. If false, the k-means will be performed directly on the original term-document matrix.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.useDimensionalityReduction
  - useDimensionalityReduction
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder useDimensionalityReduction(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)
```
    Use dimensionality reduction. If true, k-means will be applied on the dimensionality-reduced term-document matrix with the number of dimensions being equal to twice the number of requested clusters. If the number of dimensions is lower than the number of input documents, reduction will not be performed. If false, the k-means will be performed directly on the original term-document matrix.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.useDimensionalityReduction
  - partitionCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder partitionCount(int value)
```
    Partition count. The number of partitions to create at each k-means clustering iteration.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.partitionCount
  - partitionCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder partitionCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
```
    Partition count. The number of partitions to create at each k-means clustering iteration.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.partitionCount
  - labelCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder labelCount(int value)
```
    Label count. The minimum number of labels to return for each cluster.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.labelCount
  - labelCount
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder labelCount(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
```
    Label count. The minimum number of labels to return for each cluster.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.labelCount
  - preprocessingPipeline
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(IPreprocessingPipeline value)
```
    Common preprocessing tasks handler.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.preprocessingPipeline
  - preprocessingPipeline
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(Class<?> clazz)
```
    Common preprocessing tasks handler. A class that extends org.carrot2.text.preprocessing.pipeline.IPreprocessingPipeline or appropriate IObjectFactory.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.preprocessingPipeline
  - preprocessingPipeline
```
public BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder preprocessingPipeline(org.carrot2.util.attribute.IObjectFactory<? extends IPreprocessingPipeline> value)
```
    Common preprocessing tasks handler.
    
    See Also:
    
    BisectingKMeansClusteringAlgorithm.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.
  - 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.

Class BisectingKMeansClusteringAlgorithmDescriptor.AttributeBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

map

Constructor Detail

AttributeBuilder

Method Detail

documents

documents

clusters

clusterCount

clusterCount

maxIterations

maxIterations

useDimensionalityReduction

useDimensionalityReduction

partitionCount

partitionCount

labelCount

labelCount

preprocessingPipeline

preprocessingPipeline

preprocessingPipeline

matrixBuilder

matrixReducer

labelFormatter

multilingualClustering