org.pmml4s.metadata

DataField

class DataField extends AbstractField with PmmlElement

Defines a field as used in mining models. It specifies the types and value ranges.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DataField
  2. PmmlElement
  3. HasExtensions
  4. AbstractField
  5. Field
  6. Attribute
  7. ValueIndexer
  8. HasIntervals
  9. HasValidValues
  10. HasInvalidValues
  11. HasMissingValues
  12. HasLabels
  13. HasOpType
  14. HasDataType
  15. DataTypeLike
  16. Serializable
  17. Serializable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DataField(name: String)

  2. new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, interval: Interval, values: Array[Value])

  3. new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, interval: Interval)

  4. new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, values: Array[Value])

  5. new DataField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, intervals: Array[Interval] = ..., values: Array[Value] = ..., taxonomy: Option[String] = scala.None, isCyclic: Boolean = true)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. var _attribute: Attribute

    An internal attribute could be changed.

    An internal attribute could be changed.

    Attributes
    protected
    Definition Classes
    AbstractField
  7. var _index: Int

    Index of the field in the input series.

    Index of the field in the input series.

    Attributes
    protected
    Definition Classes
    AbstractField
  8. 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
  9. def accepts(other: DataType): Boolean

    Returns true if other is an acceptable input type for a function that expects this.

    Returns true if other is an acceptable input type for a function that expects this.

    Definition Classes
    DataTypeLike
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def attrType: AttributeType

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  12. def attribute: Attribute

    Attribute of the field.

    Attribute of the field.

    Definition Classes
    AbstractFieldField
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. val dataType: DataType

    Returns the data type of field.

    Returns the data type of field.

    Definition Classes
    DataFieldDataTypeLike
  15. def decode(index: Int): Any

    Definition Classes
    FieldValueIndexer
  16. val displayName: Option[String]

    Display name of the field.

    Display name of the field. None if it is not set.

    Definition Classes
    DataFieldField
  17. def encode(value: Any): Double

    Definition Classes
    FieldValueIndexer
  18. 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
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. def extensions: Seq[Extension]

    Definition Classes
    HasExtensions
  22. def fieldType: FieldType

    Field type.

    Field type.

    Definition Classes
    DataFieldField
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def get(series: Series): Any

    Retrieve its value from the specified series, return null if missing

    Retrieve its value from the specified series, return null if missing

    Definition Classes
    AbstractFieldField
  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  26. def getDouble(series: Series): Double

    Retrieve its value as double from the specified series, return Double.

    Retrieve its value as double from the specified series, return Double.NaN if missing.

    Definition Classes
    Field
  27. def getLabel(value: Any): Option[String]

    Definition Classes
    FieldHasLabels
  28. def hasExtensions: Boolean

    Definition Classes
    HasExtensions
  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  30. def index: Int

    Index of the field in the input series.

    Index of the field in the input series.

    Definition Classes
    AbstractFieldField
  31. def indexDefined: Boolean

    Tests if the index of this field is defined

    Tests if the index of this field is defined

    Definition Classes
    Field
  32. def index_=(i: Int): Unit

    Sets the index of this field.

    Sets the index of this field.

    Definition Classes
    AbstractFieldField
  33. val intervals: Array[Interval]

    Definition Classes
    DataFieldFieldHasIntervals
  34. def invalidValues: Set[Any]

    Definition Classes
    FieldHasInvalidValues
  35. 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
    FieldHasValidValues
  36. def isCategorical: Boolean

    Tests whether this field is categorical (nominal or ordinal).

    Tests whether this field is categorical (nominal or ordinal).

    Definition Classes
    HasOpType
  37. def isContinuous: Boolean

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  38. val isCyclic: Boolean

  39. def isDataField: Boolean

    Tests if the field is a data field.

    Tests if the field is a data field.

    Definition Classes
    Field
  40. def isDate: Boolean

    Definition Classes
    FieldDataTypeLike
  41. def isDateTime: Boolean

    Definition Classes
    DataTypeLike
  42. def isDerivedField: Boolean

    Tests if the field is a derived field.

    Tests if the field is a derived field.

    Definition Classes
    Field
  43. def isDouble: Boolean

    Definition Classes
    FieldDataTypeLike
  44. def isFloat: Boolean

    Definition Classes
    FieldDataTypeLike
  45. def isIn(value: Any): Boolean

    Definition Classes
    HasIntervals
  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  47. def isInvalidValue(value: Any): Boolean

    Definition Classes
    FieldHasInvalidValues
  48. 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
  49. def isMissingValue(value: Any): Boolean

    Definition Classes
    FieldHasMissingValues
  50. def isMutable: Boolean

    Definition Classes
    FieldAttribute
  51. def isNominal: Boolean

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  52. def isNumeric: Boolean

    Definition Classes
    FieldDataTypeLike
  53. def isOrdinal: Boolean

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  54. def isReal: Boolean

    Definition Classes
    DataTypeLike
  55. def isString: Boolean

    Definition Classes
    FieldDataTypeLike
  56. def isSysMissing(value: Any): Boolean

    Definition Classes
    HasMissingValues
  57. def isTime: Boolean

    Definition Classes
    FieldDataTypeLike
  58. def isTimestamp: Boolean

    Definition Classes
    FieldDataTypeLike
  59. def isValidValue(value: Any): Boolean

    Definition Classes
    FieldHasValidValues
  60. def labels: Map[Any, String]

    Definition Classes
    FieldHasLabels
  61. def missingValues: Set[Any]

    Definition Classes
    FieldHasMissingValues
  62. val name: String

    Name of the field.

    Name of the field.

    Definition Classes
    DataFieldField
  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  64. final def notify(): Unit

    Definition Classes
    AnyRef
  65. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  66. def numCategories: Int

    Definition Classes
    FieldHasValidValues
  67. val opType: OpType

    Operational type.

    Operational type.

    Definition Classes
    DataFieldHasOpType
  68. 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
    AbstractFieldField
  69. def referenced_=(r: Boolean): Unit

    Sets the referenced flag of the field.

    Sets the referenced flag of the field.

    Definition Classes
    AbstractFieldField
  70. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  71. val taxonomy: Option[String]

  72. def toAttribute: Attribute

    Definition Classes
    FieldAttribute
  73. 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
    AbstractFieldField
  74. def toString(): String

    Definition Classes
    AnyRef → Any
  75. def toVal(s: String): Any

    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

  76. def toValOption(s: String): Option[Any]

    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
  77. def validValues: Array[Any]

    Definition Classes
    FieldHasValidValues
  78. val values: Array[Value]

  79. def valuesAsString: String

    Definition Classes
    Attribute
  80. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PmmlElement

Inherited from HasExtensions

Inherited from AbstractField

Inherited from Field

Inherited from Attribute

Inherited from ValueIndexer

Inherited from HasIntervals

Inherited from HasValidValues

Inherited from HasInvalidValues

Inherited from HasMissingValues

Inherited from HasLabels

Inherited from HasOpType

Inherited from HasDataType

Inherited from DataTypeLike

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped