com.attivio.sdk.search.fields

Class StandardScore

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.StandardScore

All Implemented Interfaces:

Serializable, Cloneable

public class StandardScore
extends UnaryFieldExpression

Standard Score FieldExpression.

Computes the Standard Score (or z-score) for a numeric value given the specified population mean and standard deviation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.fields.FieldExpression

FieldExpression.StringMode

Field Summary

Fields inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

expression

Fields inherited from class com.attivio.sdk.search.fields.FieldExpression

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
StandardScore(FieldExpression input, double mean, double stdev)
StandardScore(FieldExpression input, double mean, double stdev, String alias)

Method Summary

Modifier and Type	Method and Description
StandardScore	clone()
protected StandardScore	clone(FieldExpression e) Create a new instance of this FieldExpression, with a different argument.
double	getMean()
double	getStandardDeviation()
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
int	hashCode()
protected boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
void	setMean(double value)
void	setStandardDeviation(double value)
protected void	toString(StringBuilder buffer, FieldExpression.StringMode mode) Writes the string representation of this field expression to buffer.

Methods inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

equalsIgnoreAlias, getExpression, getFieldName, hasChildren, isConstant, rewrite, rewriteChildren, setExpression

Methods inherited from class com.attivio.sdk.search.fields.FieldExpression

as, containsAlias, copyOf, equals, equalsIgnoreAlias, getAlias, getDefaultAlias, handleFieldExpression, isConstant, quote, rewrite, setAlias, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StandardScore

public StandardScore(FieldExpression input,
                     double mean,
                     double stdev)

StandardScore

public StandardScore(FieldExpression input,
                     double mean,
                     double stdev,
                     String alias)

Method Detail

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getMean

public double getMean()

setMean

public void setMean(double value)

getStandardDeviation

public double getStandardDeviation()

setStandardDeviation

public void setStandardDeviation(double value)

toString

protected void toString(StringBuilder buffer,
                        FieldExpression.StringMode mode)

Writes the string representation of this field expression to buffer.

NOTE: the alias will not be written to buffer by this function.

Specified by:

toString in class FieldExpression

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryFieldExpression

parametersEqual

protected boolean parametersEqual(FieldExpression other)

Returns true if other's parameters are the same as this.

Specified by:

parametersEqual in class UnaryFieldExpression

clone

public StandardScore clone()

Overrides:

clone in class UnaryFieldExpression

clone

protected StandardScore clone(FieldExpression e)

Create a new instance of this FieldExpression, with a different argument.

Overrides:

clone in class UnaryFieldExpression