class DataField extends AbstractField with PmmlElement
Defines a field as used in mining models. It specifies the types and value ranges.
- Alphabetic
- By Inheritance
- DataField
- PmmlElement
- HasExtensions
- AbstractField
- Field
- Attribute
- ValueIndexer
- HasIntervals
- HasValidValues
- HasInvalidValues
- HasMissingValues
- HasLabels
- HasOpType
- HasDataType
- DataTypeLike
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DataField(name: String)
- new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, interval: Interval, values: Array[Value])
- new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, interval: Interval)
- new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, values: Array[Value])
- new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, intervals: Array[Interval] = Array.empty, values: Array[Value] = Array.empty, taxonomy: Option[String] = None, isCyclic: Boolean = true)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- var _attribute: Attribute
An internal attribute could be changed.
An internal attribute could be changed.
- Attributes
- protected
- Definition Classes
- AbstractField
- var _index: Int
Index of the field in the input series.
Index of the field in the input series.
- Attributes
- protected
- Definition Classes
- AbstractField
- var _referenced: Boolean
A flag if the field is referenced in the model.
A flag if the field is referenced in the model.
- Attributes
- protected
- Definition Classes
- AbstractField
- def accepts(other: DataType): Boolean
Returns true if
otheris an acceptable input type for a function that expects this.Returns true if
otheris an acceptable input type for a function that expects this.- Definition Classes
- DataTypeLike
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def attrType: AttributeType
Attribute type.
- def attribute: Attribute
Attribute of the field.
Attribute of the field.
- Definition Classes
- AbstractField → Field
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val dataType: DataType
Returns the data type of field.
Returns the data type of field.
- Definition Classes
- DataField → DataTypeLike
- def decode(index: Int): DataVal
- Definition Classes
- Field → ValueIndexer
- val displayName: Option[String]
Display name of the field.
- def encode(value: DataVal): Double
- Definition Classes
- Field → ValueIndexer
- def encode(series: Series): Double
Encodes the value of the field in the input series.
Encodes the value of the field in the input series.
- Definition Classes
- Field
- def encode(value: Any): Double
- Definition Classes
- ValueIndexer
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extensions: Seq[Extension]
- Definition Classes
- HasExtensions
- def fieldType: FieldType
Field type.
- def get(series: Series): DataVal
Retrieve its value from the specified series, return null if missing
Retrieve its value from the specified series, return null if missing
- Definition Classes
- AbstractField → Field
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDouble(series: Series): Double
Retrieve its value as double from the specified series, return Double.NaN if missing.
Retrieve its value as double from the specified series, return Double.NaN if missing.
- Definition Classes
- Field
- def getDoubleVal(series: Series): DoubleVal
- Definition Classes
- Field
- def getLabel(value: DataVal): Option[String]
- def hasExtensions: Boolean
- Definition Classes
- HasExtensions
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def index: Int
Index of the field in the input series.
Index of the field in the input series.
- Definition Classes
- AbstractField → Field
- Annotations
- @inline()
- def indexDefined: Boolean
Tests if the index of this field is defined
Tests if the index of this field is defined
- Definition Classes
- Field
- def index_=(i: Int): Unit
Sets the index of this field.
Sets the index of this field.
- Definition Classes
- AbstractField → Field
- val intervals: Array[Interval]
- Definition Classes
- DataField → Field → HasIntervals
- def invalidValues: Set[DataVal]
- Definition Classes
- Field → HasInvalidValues
- def isBinary: Boolean
Tests whether this field is binary, that is categorical and it contains exactly two valid values.
Tests whether this field is binary, that is categorical and it contains exactly two valid values.
- Definition Classes
- Field → HasValidValues
- def isCategorical: Boolean
Tests whether this field is categorical (nominal or ordinal).
Tests whether this field is categorical (nominal or ordinal).
- Definition Classes
- HasOpType
- def isContinuous: Boolean
Tests whether this field is continuous.
Tests whether this field is continuous.
- Definition Classes
- HasOpType
- val isCyclic: Boolean
- def isDataField: Boolean
Tests if the field is a data field.
Tests if the field is a data field.
- Definition Classes
- Field
- def isDate: Boolean
- Definition Classes
- Field → DataTypeLike
- def isDateTime: Boolean
- Definition Classes
- DataTypeLike
- def isDerivedField: Boolean
Tests if the field is a derived field.
Tests if the field is a derived field.
- Definition Classes
- Field
- def isDouble: Boolean
- Definition Classes
- Field → DataTypeLike
- def isFloat: Boolean
- Definition Classes
- Field → DataTypeLike
- def isIn(value: Any): Boolean
- Definition Classes
- HasIntervals
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isInvalidValue(value: DataVal): Boolean
- Definition Classes
- Field → HasInvalidValues
- def isInvalidValue(value: Any): Boolean
- Definition Classes
- HasInvalidValues
- def isMissing(series: Series): Boolean
Tests if its value is missing from the specified series.
Tests if its value is missing from the specified series.
- Definition Classes
- Field
- def isMissingValue(value: DataVal): Boolean
- Definition Classes
- Field → HasMissingValues
- def isMissingValue(value: Any): Boolean
- Definition Classes
- HasMissingValues
- def isMutable: Boolean
- def isNominal: Boolean
Tests whether this field is nominal.
Tests whether this field is nominal.
- Definition Classes
- HasOpType
- def isNumeric: Boolean
- Definition Classes
- Field → DataTypeLike
- def isOrdinal: Boolean
Tests whether this field is ordinal.
Tests whether this field is ordinal.
- Definition Classes
- HasOpType
- lazy val isPlain: Boolean
- def isReal: Boolean
- Definition Classes
- DataTypeLike
- def isString: Boolean
- Definition Classes
- Field → DataTypeLike
- def isTime: Boolean
- Definition Classes
- Field → DataTypeLike
- def isTimestamp: Boolean
- Definition Classes
- Field → DataTypeLike
- def isValidValue(value: DataVal): Boolean
- Definition Classes
- Field → HasValidValues
- def isValidValue(value: Any): Boolean
- Definition Classes
- HasValidValues
- def labels: Map[DataVal, String]
- def missingValues: Set[DataVal]
- Definition Classes
- Field → HasMissingValues
- val name: String
Name of the field.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def numCategories: Int
- Definition Classes
- Field → HasValidValues
- val opType: OpType
Operational type.
- def referenced: Boolean
Tests if the field is referenced in the model element.
Tests if the field is referenced in the model element.
- Definition Classes
- AbstractField → Field
- def referenced_=(r: Boolean): Unit
Sets the referenced flag of the field.
Sets the referenced flag of the field.
- Definition Classes
- AbstractField → Field
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val taxonomy: Option[String]
- def toAttribute: Attribute
- def toImmutable: DataField.this.type
Converts to an immutable attribute if it's mutable.
Converts to an immutable attribute if it's mutable.
- Definition Classes
- AbstractField → Field
- def toString(): String
- Definition Classes
- AnyRef → Any
- def toVal(s: String): DataVal
Converts a string to the corresponding value based on its data type.
Converts a string to the corresponding value based on its data type.
- Definition Classes
- Field
- Exceptions thrown
java.lang.NumberFormatException- If the string does not contain a parsable number if dataType is numeric
- def toValOption(s: String): Option[DataVal]
Converts a string to the corresponding value based on its data type.
Converts a string to the corresponding value based on its data type.
- returns
None if any error occurs
- Definition Classes
- Field
- def validValues: Array[DataVal]
- Definition Classes
- Field → HasValidValues
- val values: Array[Value]
- def valuesAsString: String
- Definition Classes
- Attribute
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)