Class

org.pmml4s.transformations

DerivedField

Related Doc: package transformations

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

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

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

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. var _attribute: Attribute

    Permalink

    An internal attribute could be changed.

    An internal attribute could be changed.

    Attributes
    protected
    Definition Classes
    AbstractField
  5. var _index: Int

    Permalink

    Index of the field in the input series.

    Index of the field in the input series.

    Attributes
    protected
    Definition Classes
    AbstractField
  6. var _referenced: Boolean

    Permalink

    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
  7. def accepts(other: DataType): Boolean

    Permalink

    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
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def attrType: AttributeType

    Permalink

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  10. def attribute: Attribute

    Permalink

    Attribute of the field.

    Attribute of the field.

    Definition Classes
    AbstractFieldField
  11. def categories: Array[Any]

    Permalink
    Definition Classes
    Expression
  12. def children: Array[Expression]

    Permalink
    Definition Classes
    DerivedFieldExpression
  13. def clone(): AnyRef

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

    Permalink

    Returns the data type of field.

    Returns the data type of field.

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

    Permalink
    Definition Classes
    FieldValueIndexer
  16. def deeval(input: Any): Any

    Permalink
    Definition Classes
    DerivedFieldExpression
  17. val displayName: Option[String]

    Permalink

    Display name of the field.

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

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

    Permalink
    Definition Classes
    FieldValueIndexer
  19. def encode(series: Series): Double

    Permalink

    Encodes the value of the field in the input series.

    Encodes the value of the field in the input series.

    Definition Classes
    Field
  20. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink

    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
  23. def eval(value: Any): Any

    Permalink
    Definition Classes
    Expression
  24. val expr: Expression

    Permalink
  25. def extensions: Seq[Extension]

    Permalink
    Definition Classes
    HasExtensions
  26. def fieldType: FieldType

    Permalink

    Field type.

    Field type.

    Definition Classes
    DerivedFieldDataFieldField
  27. def finalize(): Unit

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getDataField: Option[Field]

    Permalink
    Definition Classes
    DerivedFieldExpression
  31. def getDouble(series: Series): Double

    Permalink

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

    Permalink
    Definition Classes
    FieldHasLabels
  33. def hasExtensions: Boolean

    Permalink
    Definition Classes
    HasExtensions
  34. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  35. def index: Int

    Permalink

    Index of the field in the input series.

    Index of the field in the input series.

    Definition Classes
    AbstractFieldField
  36. def indexDefined: Boolean

    Permalink

    Tests if the index of this field is defined

    Tests if the index of this field is defined

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

    Permalink

    Sets the index of this field.

    Sets the index of this field.

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

    Permalink
    Definition Classes
    DataFieldFieldHasIntervals
  39. def invalidValues: Set[Any]

    Permalink
    Definition Classes
    FieldHasInvalidValues
  40. def isBinary: Boolean

    Permalink

    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
  41. def isCategorical: Boolean

    Permalink

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

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

    Definition Classes
    HasOpType
  42. def isContinuous: Boolean

    Permalink

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  43. val isCyclic: Boolean

    Permalink
    Definition Classes
    DataField
  44. def isDataField: Boolean

    Permalink

    Tests if the field is a data field.

    Tests if the field is a data field.

    Definition Classes
    Field
  45. def isDate: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  46. def isDateTime: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  47. def isDerivedField: Boolean

    Permalink

    Tests if the field is a derived field.

    Tests if the field is a derived field.

    Definition Classes
    Field
  48. def isDouble: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  49. def isFloat: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  50. def isIn(value: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  52. def isInvalidValue(value: Any): Boolean

    Permalink
    Definition Classes
    FieldHasInvalidValues
  53. def isMissing(series: Series): Boolean

    Permalink

    Tests if its value is missing from the specified series.

    Tests if its value is missing from the specified series.

    Definition Classes
    Field
  54. def isMissingValue(value: Any): Boolean

    Permalink
    Definition Classes
    FieldHasMissingValues
  55. def isMutable: Boolean

    Permalink
    Definition Classes
    FieldAttribute
  56. def isNominal: Boolean

    Permalink

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  57. def isNumeric: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  58. def isOrdinal: Boolean

    Permalink

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  59. def isReal: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  60. def isString: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  61. def isSysMissing(value: Any): Boolean

    Permalink
    Definition Classes
    HasMissingValues
  62. def isTime: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  63. def isTimestamp: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  64. def isValidValue(value: Any): Boolean

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

    Permalink
    Definition Classes
    FieldHasLabels
  66. def missingValues: Set[Any]

    Permalink
    Definition Classes
    FieldHasMissingValues
  67. val name: String

    Permalink

    Name of the field.

    Name of the field.

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

    Permalink
    Definition Classes
    AnyRef
  69. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  70. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  71. def numCategories: Int

    Permalink
    Definition Classes
    FieldHasValidValues
  72. val opType: OpType

    Permalink

    Operational type.

    Operational type.

    Definition Classes
    DerivedFieldDataFieldHasOpType
  73. def referenced: Boolean

    Permalink

    Tests if the field is referenced in the model element.

    Tests if the field is referenced in the model element.

    Definition Classes
    AbstractFieldField
  74. def referenced_=(r: Boolean): Unit

    Permalink

    Sets the referenced flag of the field.

    Sets the referenced flag of the field.

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

    Permalink
    Definition Classes
    AnyRef
  76. val taxonomy: Option[String]

    Permalink
    Definition Classes
    DataField
  77. def toAttribute: Attribute

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

    Permalink

    Converts to an immutable attribute if it's mutable.

    Converts to an immutable attribute if it's mutable.

    Definition Classes
    AbstractFieldField
  79. def toString(): String

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

    Permalink

    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

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

    Permalink

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

    Permalink
    Definition Classes
    FieldHasValidValues
  83. val values: Array[Value]

    Permalink
    Definition Classes
    DerivedFieldDataField
  84. def valuesAsString: String

    Permalink
    Definition Classes
    Attribute
  85. final def wait(): Unit

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

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

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

    Permalink

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