Module datarush.analytics

Package com.pervasive.datarush.analytics.cluster

Class ClusteringField

java.lang.Object

com.pervasive.datarush.analytics.cluster.ClusteringField

public class ClusteringField
extends Object

Corresponds to the ClusteringField PMML element.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusteringField.Builder	Builder for ClusteringField instances.

Method Summary

Modifier and Type	Method	Description
static ClusteringField.Builder	builder(String field, CompareFunction compareFunction)	Creates a builder that builds ClusteringField instances.
CompareFunction	getCompareFunction()	Gets the CompareFunction of this ClusteringField.
String	getField()	Gets the name of the field referenced by this ClusteringField.
double	getFieldWeight()	Gets the weight of this ClusteringField.
double	getSimilarityScale()	Gets the similarity scale of this ClusteringField
boolean	isCenterField()	Gets whether this field is a ClusteringField.

Methods inherited from class java.lang.Object

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

Method Detail

getField

public String getField()

Gets the name of the field referenced by this ClusteringField.

Returns:

the name of the field referenced by this ClusteringField

isCenterField

public boolean isCenterField()

Gets whether this field is a ClusteringField.

Returns:

true, if this field is a center field, false otherwise

getFieldWeight

public double getFieldWeight()

Gets the weight of this ClusteringField.

Returns:

the weight of this ClusteringField

getSimilarityScale

public double getSimilarityScale()

Gets the similarity scale of this ClusteringField

Returns:

the similarity scale of this ClusteringField

getCompareFunction

public CompareFunction getCompareFunction()

Gets the CompareFunction of this ClusteringField.

Returns:

the CompareFunction of this ClusteringField

builder

public static ClusteringField.Builder builder(String field,
                                              CompareFunction compareFunction)

Creates a builder that builds ClusteringField instances. The parameters field and compare function are required parameters. For other parameters defaults will be used: created fields will be center fields, field weight will be set to 1.0, similarity scale will be set to Double.NaN.

Parameters:

field - the referenced field, must not be null or empty

compareFunction - the CompareFunction for this field, must not be null

Returns:

ClusteringField.Builder