org.jpmml.evaluator

Class FieldValue

java.lang.Object

org.jpmml.evaluator.FieldValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FieldValue>

Direct Known Subclasses:

CategoricalValue, ContinuousValue, OrdinalValue

public abstract class FieldValue
extends java.lang.Object
implements java.lang.Comparable<FieldValue>, java.io.Serializable

A field value representation that meets the requirements of PMML type system.

Type information has two components to it:

• Operational type. Determines supported type equality and type comparison operations.
• Data type. Determines supported type conversions.

A field value is created after a field. It may be later refined by transformations and functions.

See Also:

FieldValueUtil, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	asBoolean()
org.joda.time.DateTime	asDateTime()
java.lang.Double	asDouble() Getting the value of a field as Double: FieldValue value = ...; Double result = value.asDouble(); Getting the value of a field as double: FieldValue value = ...; double result = (value.asNumber()).doubleValue();
java.lang.Integer	asInteger()
org.joda.time.LocalDate	asLocalDate()
org.joda.time.LocalDateTime	asLocalDateTime()
org.joda.time.LocalTime	asLocalTime()
java.lang.Number	asNumber()
java.lang.String	asString()
int	compareTo(FieldValue that)
int	compareTo(HasParsedValue<?> hasParsedValue)
int	compareTo(org.dmg.pmml.HasValue<?> hasValue) Calculates the order between this value and the reference value.
int	compareToString(java.lang.String string)
int	compareToValue(FieldValue value) A value-safe replacement for compareTo(FieldValue)
boolean	equals(HasParsedValue<?> hasParsedValue)
boolean	equals(org.dmg.pmml.HasValue<?> hasValue) Checks if this value is equal to the reference value.
boolean	equals(java.lang.Object object)
boolean	equalsString(java.lang.String string)
boolean	equalsValue(FieldValue value) A value-safe replacement for #equals(FieldValue).
org.dmg.pmml.DataType	getDataType()
<V> V	getMapping(HasParsedValueMapping<V> hasParsedValueMapping)
abstract org.dmg.pmml.OpType	getOpType()
java.lang.Object	getValue()
int	hashCode()
int	indexInStrings(java.lang.Iterable<java.lang.String> strings)
int	indexInValues(java.lang.Iterable<FieldValue> values)
boolean	isIn(HasParsedValueSet<?> hasParsedValueSet)
boolean	isIn(org.dmg.pmml.HasValueSet<?> hasValueSet) Checks if this value is contained in the set of reference values.
java.lang.Object	parseValue(java.lang.String string)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getOpType

public abstract org.dmg.pmml.OpType getOpType()

equals

public boolean equals(org.dmg.pmml.HasValue<?> hasValue)

Checks if this value is equal to the reference value.

equals

public boolean equals(HasParsedValue<?> hasParsedValue)

isIn

public boolean isIn(org.dmg.pmml.HasValueSet<?> hasValueSet)

Checks if this value is contained in the set of reference values.

isIn

public boolean isIn(HasParsedValueSet<?> hasParsedValueSet)

compareTo

public int compareTo(org.dmg.pmml.HasValue<?> hasValue)

Calculates the order between this value and the reference value.

compareTo

public int compareTo(HasParsedValue<?> hasParsedValue)

equalsString

public boolean equalsString(java.lang.String string)

equalsValue

public boolean equalsValue(FieldValue value)

A value-safe replacement for #equals(FieldValue).

indexInStrings

public int indexInStrings(java.lang.Iterable<java.lang.String> strings)

indexInValues

public int indexInValues(java.lang.Iterable<FieldValue> values)

compareToString

public int compareToString(java.lang.String string)

compareToValue

public int compareToValue(FieldValue value)

A value-safe replacement for compareTo(FieldValue)

parseValue

public java.lang.Object parseValue(java.lang.String string)

getMapping

public <V> V getMapping(HasParsedValueMapping<V> hasParsedValueMapping)

asString

public java.lang.String asString()

asInteger

public java.lang.Integer asInteger()

asNumber

public java.lang.Number asNumber()

asDouble

public java.lang.Double asDouble()

Getting the value of a field as Double:

 FieldValue value = ...;
 Double result = value.asDouble();
 

Getting the value of a field as double:

 FieldValue value = ...;
 double result = (value.asNumber()).doubleValue();
 

See Also:

asNumber()

asBoolean

public java.lang.Boolean asBoolean()

asLocalDateTime

public org.joda.time.LocalDateTime asLocalDateTime()

asLocalDate

public org.joda.time.LocalDate asLocalDate()

asLocalTime

public org.joda.time.LocalTime asLocalTime()

asDateTime

public org.joda.time.DateTime asDateTime()

compareTo

public int compareTo(FieldValue that)

Specified by:

compareTo in interface java.lang.Comparable<FieldValue>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDataType

public org.dmg.pmml.DataType getDataType()

getValue

public java.lang.Object getValue()