org.pmml4s.transformations

DerivedField

class DerivedField extends DataField with Expression

Provides a common element for the various mappings. They can also appear at several places in the definition of specific models such as neural network or Naive Bayes models. Transformed fields have a name such that statistics and the model can refer to these fields.

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

Instance Constructors

  1. new DerivedField(name: String, expr: Expression)

  2. new DerivedField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, expr: Expression)

  3. new DerivedField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, values: Array[Value], expr: Expression)

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 categories: Array[Any]

    Definition Classes
    Expression
  14. def children: Array[Expression]

    Definition Classes
    DerivedFieldExpression
  15. def clone(): AnyRef

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

    Returns the data type of field.

    Returns the data type of field.

    Definition Classes
    DerivedFieldDataFieldDataTypeLike
  17. def decode(index: Int): Any

    Definition Classes
    FieldValueIndexer
  18. def deeval(input: Any): Any

    Definition Classes
    DerivedFieldExpression
  19. val displayName: Option[String]

    Display name of the field.

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

    Definition Classes
    DerivedFieldDataFieldField
  20. def encode(value: Any): Double

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

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

    Definition Classes
    AnyRef → Any
  24. def eval(series: Series): Any

    Returns the result of evaluating this expression on a given input Series

    Returns the result of evaluating this expression on a given input Series

    Definition Classes
    DerivedFieldExpressionEvaluator
  25. def eval(value: Any): Any

    Definition Classes
    Expression
  26. val expr: Expression

  27. def extensions: Seq[Extension]

    Definition Classes
    HasExtensions
  28. def fieldType: FieldType

    Field type.

    Field type.

    Definition Classes
    DerivedFieldDataFieldField
  29. 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
    DerivedFieldAbstractFieldField
  30. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  31. def getDataField: Option[Field]

    Definition Classes
    DerivedFieldExpression
  32. 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
  33. def getLabel(value: Any): Option[String]

    Definition Classes
    FieldHasLabels
  34. def hasExtensions: Boolean

    Definition Classes
    HasExtensions
  35. def hashCode(): Int

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  36. def index: Int

    Index of the field in the input series.

    Index of the field in the input series.

    Definition Classes
    AbstractFieldField
  37. def indexDefined: Boolean

    Tests if the index of this field is defined

    Tests if the index of this field is defined

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

    Sets the index of this field.

    Sets the index of this field.

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

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

    Definition Classes
    FieldHasInvalidValues
  41. 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
  42. def isCategorical: Boolean

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

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

    Definition Classes
    HasOpType
  43. def isContinuous: Boolean

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  44. val isCyclic: Boolean

    Definition Classes
    DataField
  45. def isDataField: Boolean

    Tests if the field is a data field.

    Tests if the field is a data field.

    Definition Classes
    Field
  46. def isDate: Boolean

    Definition Classes
    FieldDataTypeLike
  47. def isDateTime: Boolean

    Definition Classes
    DataTypeLike
  48. def isDerivedField: Boolean

    Tests if the field is a derived field.

    Tests if the field is a derived field.

    Definition Classes
    Field
  49. def isDouble: Boolean

    Definition Classes
    FieldDataTypeLike
  50. def isFloat: Boolean

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

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

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

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

    Definition Classes
    FieldHasMissingValues
  56. def isMutable: Boolean

    Definition Classes
    FieldAttribute
  57. def isNominal: Boolean

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  58. def isNumeric: Boolean

    Definition Classes
    FieldDataTypeLike
  59. def isOrdinal: Boolean

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  60. def isReal: Boolean

    Definition Classes
    DataTypeLike
  61. def isString: Boolean

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

    Definition Classes
    HasMissingValues
  63. def isTime: Boolean

    Definition Classes
    FieldDataTypeLike
  64. def isTimestamp: Boolean

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

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

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

    Definition Classes
    FieldHasMissingValues
  68. val name: String

    Name of the field.

    Name of the field.

    Definition Classes
    DerivedFieldDataFieldField
  69. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  71. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  72. def numCategories: Int

    Definition Classes
    FieldHasValidValues
  73. val opType: OpType

    Operational type.

    Operational type.

    Definition Classes
    DerivedFieldDataFieldHasOpType
  74. 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
  75. def referenced_=(r: Boolean): Unit

    Sets the referenced flag of the field.

    Sets the referenced flag of the field.

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

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

    Definition Classes
    DataField
  78. def toAttribute: Attribute

    Definition Classes
    FieldAttribute
  79. def toImmutable(): DerivedField.this.type

    Converts to an immutable attribute if it's mutable.

    Converts to an immutable attribute if it's mutable.

    Definition Classes
    AbstractFieldField
  80. def toString(): String

    Definition Classes
    AnyRef → Any
  81. 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

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

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

    Definition Classes
    DerivedFieldDataField
  85. def valuesAsString: String

    Definition Classes
    Attribute
  86. final def wait(arg0: Long, arg1: Int): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. def write(series: Series, mutableSeries: MutableSeries, pos: Int): Any

Deprecated Value Members

  1. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Expression

Inherited from Evaluator

Inherited from DataField

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