org.jpmml.evaluator

Class FieldValue

java.lang.Object

org.jpmml.evaluator.FieldValue

All Implemented Interfaces:

Serializable, Comparable<FieldValue>

Direct Known Subclasses:

CategoricalValue, ContinuousValue, OrdinalValue

public abstract class FieldValue
extends Object
implements Comparable<FieldValue>, 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
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	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(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(Object object)
boolean	equalsString(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()
Object	getValue()
int	hashCode()
int	indexInStrings(Iterable<String> strings)
int	indexInValues(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.
Object	parseValue(String string)
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(String string)

equalsValue

public boolean equalsValue(FieldValue value)

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

indexInStrings

public int indexInStrings(Iterable<String> strings)

indexInValues

public int indexInValues(Iterable<FieldValue> values)

compareToString

public int compareToString(String string)

compareToValue

public int compareToValue(FieldValue value)

A value-safe replacement for compareTo(FieldValue)

parseValue

public Object parseValue(String string)

getMapping

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

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

compareTo

public int compareTo(FieldValue that)

Specified by:

compareTo in interface Comparable<FieldValue>

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