org.jpmml.evaluator

Class FieldValue

java.lang.Object

org.jpmml.evaluator.FieldValue

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CategoricalValue, ContinuousValue, OrdinalValue

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

Constructor Summary

Constructors

Constructor and Description
FieldValue(org.dmg.pmml.DataType dataType, Object value)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	asBoolean()
org.joda.time.DateTime	asDateTime()
Integer	asInteger()
org.joda.time.LocalDate	asLocalDate()
org.joda.time.LocalDateTime	asLocalDateTime()
org.joda.time.LocalTime	asLocalTime()
Number	asNumber()
String	asString()
int	compareToString(String string) Calculates the order between this value and the reference value.
int	compareToValue(FieldValue value)
boolean	equals(Object object)
boolean	equalsAnyString(Iterable<String> strings)
boolean	equalsAnyValue(Iterable<FieldValue> values)
boolean	equalsString(String string) Checks if this value is equal to the reference value.
boolean	equalsValue(FieldValue value)
org.dmg.pmml.DataType	getDataType()
abstract org.dmg.pmml.OpType	getOpType()
Object	getValue()
int	hashCode()
protected Object	parseValue(String string)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValue

public FieldValue(org.dmg.pmml.DataType dataType,
          Object value)

Method Detail

getOpType

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

equalsString

public boolean equalsString(String string)

Checks if this value is equal to the reference value.

Parameters:

string - The reference value.

equalsAnyString

public boolean equalsAnyString(Iterable<String> strings)

equalsValue

public boolean equalsValue(FieldValue value)

equalsAnyValue

public boolean equalsAnyValue(Iterable<FieldValue> values)

compareToString

public int compareToString(String string)

Calculates the order between this value and the reference value.

Parameters:

string - The reference value.

compareToValue

public int compareToValue(FieldValue value)

parseValue

protected Object parseValue(String string)

asString

public String asString()

asInteger

public Integer asInteger()

asNumber

public Number asNumber()

asBoolean

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

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

getDataType

public org.dmg.pmml.DataType getDataType()

getValue

public Object getValue()