org.jpmml.evaluator

Class FieldValue

java.lang.Object

org.jpmml.evaluator.FieldValue

All Implemented Interfaces:

Serializable, TypeInfo

Direct Known Subclasses:

CollectionValue, ScalarValue

public abstract class FieldValue
extends Object
implements TypeInfo, 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

Modifier and Type	Method and Description
Boolean	asBoolean()
Collection<?>	asCollection()
org.jpmml.model.temporals.Date	asDate()
org.jpmml.model.temporals.DateTime	asDateTime()
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();
Float	asFloat()
org.jpmml.model.temporals.Instant<?>	asInstant()
Integer	asInteger()
Number	asNumber()
String	asString()
org.jpmml.model.temporals.Time	asTime()
FieldValue	cast(org.dmg.pmml.HasType<?> hasType)
FieldValue	cast(TypeInfo typeInfo)
int	compareTo(org.dmg.pmml.HasValue<?> hasValue) Calculates the order between this value and the reference value.
abstract int	compareToValue(FieldValue value)
abstract int	compareToValue(Object value)
static FieldValue	create(org.dmg.pmml.OpType opType, org.dmg.pmml.DataType dataType, Object value)
static FieldValue	create(TypeInfo typeInfo, Object value)
boolean	equals(org.dmg.pmml.HasValue<?> hasValue) Checks if this value is equal to the reference value.
boolean	equals(Object object)
boolean	equalsValue(FieldValue value)
boolean	equalsValue(Object value)
org.dmg.pmml.DataType	getDataType()
Object	getValue()
int	hashCode()
boolean	isIn(Collection<FieldValue> values)
boolean	isIn(org.dmg.pmml.HasValueSet<?> hasValueSet) Checks if this value is contained in the set of reference values.
abstract boolean	isValid()
String	toString()
protected org.jpmml.model.ToStringHelper	toStringHelper()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.evaluator.TypeInfo

getOpType, getOrdering

Method Detail

isValid

public abstract boolean isValid()

compareToValue

public abstract int compareToValue(Object value)

compareToValue

public abstract int compareToValue(FieldValue value)

cast

public FieldValue cast(org.dmg.pmml.HasType<?> hasType)

cast

public FieldValue cast(TypeInfo typeInfo)

compareTo

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

Calculates the order between this value and the reference value.

equals

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

Checks if this value is equal to the reference value.

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(Collection<FieldValue> values)

equalsValue

public boolean equalsValue(Object value)

equalsValue

public boolean equalsValue(FieldValue value)

asCollection

public Collection<?> asCollection()

asString

public String asString()

asNumber

public Number asNumber()

asInteger

public Integer asInteger()

asFloat

public Float asFloat()

asDouble

public 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 Boolean asBoolean()

asDate

public org.jpmml.model.temporals.Date asDate()

asTime

public org.jpmml.model.temporals.Time asTime()

asDateTime

public org.jpmml.model.temporals.DateTime asDateTime()

asInstant

public org.jpmml.model.temporals.Instant<?> asInstant()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringHelper

protected org.jpmml.model.ToStringHelper toStringHelper()

getDataType

public org.dmg.pmml.DataType getDataType()

Specified by:

getDataType in interface TypeInfo

getValue

public Object getValue()

create

public static FieldValue create(org.dmg.pmml.OpType opType,
                                org.dmg.pmml.DataType dataType,
                                Object value)

create

public static FieldValue create(TypeInfo typeInfo,
                                Object value)