org.pmml4s.metadata

OutputField

class OutputField extends AbstractField with PmmlElement

OutputField elements specify names, types and rules for calculating specific result features. This information can be used while writing an output table.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OutputField
  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 OutputField(name: String, displayName: Option[String], dataType: DataType, opType: OpType, feature: ResultFeature = ResultFeature.predictedValue, targetField: Option[String] = scala.None, value: Option[Any] = scala.None, ruleFeature: RuleFeature = RuleFeature.consequent, algorithm: Algorithm = Algorithm.exclusiveRecommendation, rank: Int = 1, rankBasis: RankBasis = RankBasis.confidence, rankOrder: RankOrder = RankOrder.descending, isMultiValued: Boolean = false, segmentId: Option[String] = scala.None, isFinalResult: Boolean = true, decisions: Option[Decisions] = scala.None, expr: Option[Expression] = scala.None)

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. val algorithm: Algorithm

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def attrType: AttributeType

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  13. def attribute: Attribute

    Attribute of the field.

    Attribute of the field.

    Definition Classes
    AbstractFieldField
  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  15. def criterion: (Algorithm, RankBasis, RankOrder)

  16. val dataType: DataType

    Returns the data type of field.

    Returns the data type of field.

    Definition Classes
    OutputFieldDataTypeLike
  17. val decisions: Option[Decisions]

  18. def decode(index: Int): Any

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

    Display name of the field.

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

    Definition Classes
    OutputFieldField
  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. val expr: Option[Expression]

  25. def extensions: Seq[Extension]

    Definition Classes
    HasExtensions
  26. val feature: ResultFeature

  27. def fieldType: FieldType

    Field type.

    Field type.

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

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  30. 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
  31. def getLabel(value: Any): Option[String]

    Definition Classes
    FieldHasLabels
  32. def hasExtensions: Boolean

    Definition Classes
    HasExtensions
  33. def hashCode(): Int

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

    Index of the field in the input series.

    Index of the field in the input series.

    Definition Classes
    AbstractFieldField
  35. def indexDefined: Boolean

    Tests if the index of this field is defined

    Tests if the index of this field is defined

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

    Sets the index of this field.

    Sets the index of this field.

    Definition Classes
    AbstractFieldField
  37. def intervals: Array[Interval]

    Definition Classes
    FieldHasIntervals
  38. def invalidValues: Set[Any]

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

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

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

    Definition Classes
    HasOpType
  41. def isContinuous: Boolean

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  42. def isDataField: Boolean

    Tests if the field is a data field.

    Tests if the field is a data field.

    Definition Classes
    Field
  43. def isDate: Boolean

    Definition Classes
    FieldDataTypeLike
  44. def isDateTime: Boolean

    Definition Classes
    DataTypeLike
  45. def isDerivedField: Boolean

    Tests if the field is a derived field.

    Tests if the field is a derived field.

    Definition Classes
    Field
  46. def isDouble: Boolean

    Definition Classes
    FieldDataTypeLike
  47. val isFinalResult: Boolean

  48. def isFloat: Boolean

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

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

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

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

    Definition Classes
    FieldHasMissingValues
  54. val isMultiValued: Boolean

  55. def isMutable: Boolean

    Definition Classes
    FieldAttribute
  56. def isNominal: Boolean

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  57. def isNumeric: Boolean

    Definition Classes
    FieldDataTypeLike
  58. def isOrdinal: Boolean

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  59. def isReal: Boolean

    Definition Classes
    DataTypeLike
  60. def isString: Boolean

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

    Definition Classes
    HasMissingValues
  62. def isTime: Boolean

    Definition Classes
    FieldDataTypeLike
  63. def isTimestamp: Boolean

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

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

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

    Definition Classes
    FieldHasMissingValues
  67. val name: String

    Name of the field.

    Name of the field.

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

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

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

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

    Definition Classes
    FieldHasValidValues
  72. val opType: OpType

    Operational type.

    Operational type.

    Definition Classes
    OutputFieldHasOpType
  73. val rank: Int

  74. val rankBasis: RankBasis

  75. val rankOrder: RankOrder

  76. 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
  77. def referenced_=(r: Boolean): Unit

    Sets the referenced flag of the field.

    Sets the referenced flag of the field.

    Definition Classes
    AbstractFieldField
  78. val ruleFeature: RuleFeature

  79. val segmentId: Option[String]

  80. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  81. val targetField: Option[String]

  82. def toAttribute: Attribute

    Definition Classes
    FieldAttribute
  83. def toImmutable(): OutputField.this.type

    Converts to an immutable attribute if it's mutable.

    Converts to an immutable attribute if it's mutable.

    Definition Classes
    AbstractFieldField
  84. def toString(): String

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

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

    Definition Classes
    FieldHasValidValues
  88. val value: Option[Any]

  89. def valuesAsString: String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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