ClusteringField.Builder (Dataflow Library Distribution Project 8.2.0-176 API)

java.lang.Object
- com.pervasive.datarush.analytics.cluster.ClusteringField.Builder

Enclosing class:

ClusteringField
```
public static class ClusteringField.Builder
extends Object
```
Builder for ClusteringField instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ClusteringField`	`build()`	Verifies the previously set values and builds a `ClusteringField` instance based on these values.
`ClusteringField.Builder`	`fieldWeight(double fieldWeight)`	Returns a builder that builds `ClusteringField` instances with the provided field weight and other parameters set to the previously provided values.
`ClusteringField.Builder`	`isCenterField(boolean isCenterField)`	Returns a builder that builds `ClusteringField` instances with the provided center field flag and other parameters set to the previously provided values.
`ClusteringField.Builder`	`similarityScale(double similarityScale)`	Returns a builder that builds `ClusteringField` instances with the provided similarity scale and other parameters set to the previously provided values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isCenterField
```
public ClusteringField.Builder isCenterField(boolean isCenterField)
```
    Returns a builder that builds ClusteringField instances with the provided center field flag and other parameters set to the previously provided values.
    
    Parameters:
    
    isCenterField - the center field flag
    
    Returns:
    
    ClusteringField.Builder
  - fieldWeight
```
public ClusteringField.Builder fieldWeight(double fieldWeight)
```
    Returns a builder that builds ClusteringField instances with the provided field weight and other parameters set to the previously provided values.
    
    Parameters:
    
    fieldWeight - the weight of this field, must not be Double.NaN, Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY
    
    Returns:
    
    ClusteringField.Builder
  - similarityScale
```
public ClusteringField.Builder similarityScale(double similarityScale)
```
    Returns a builder that builds ClusteringField instances with the provided similarity scale and other parameters set to the previously provided values.
    
    Parameters:
    
    similarityScale - the similarity scale of this field
    
    Returns:
    
    ClusteringField.Builder
  - build
```
public ClusteringField build()
```
    Verifies the previously set values and builds a ClusteringField instance based on these values.
    
    Returns:
    
    ClusteringField