Class/Object

org.pmml4s.metadata

OutputField

Related Docs: object OutputField | package metadata

Permalink

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
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] = None, value: Option[Any] = 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] = None, isFinalResult: Boolean = true, decisions: Option[Decisions] = None, expr: Option[Expression] = None)

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

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def attrType: AttributeType

    Permalink

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  11. def attribute: Attribute

    Permalink

    Attribute of the field.

    Attribute of the field.

    Definition Classes
    AbstractFieldField
  12. def clone(): AnyRef

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

    Permalink
  14. val dataType: DataType

    Permalink

    Returns the data type of field.

    Returns the data type of field.

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

    Permalink
  16. def decode(index: Int): Any

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

    Permalink

    Display name of the field.

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

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

    Permalink
  23. def extensions: Seq[Extension]

    Permalink
    Definition Classes
    HasExtensions
  24. val feature: ResultFeature

    Permalink
  25. def fieldType: FieldType

    Permalink

    Field type.

    Field type.

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

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

    Permalink
    Definition Classes
    FieldHasLabels
  30. def hasExtensions: Boolean

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

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

    Permalink

    Index of the field in the input series.

    Index of the field in the input series.

    Definition Classes
    AbstractFieldField
  33. 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
  34. def index_=(i: Int): Unit

    Permalink

    Sets the index of this field.

    Sets the index of this field.

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

    Permalink
    Definition Classes
    FieldHasIntervals
  36. def invalidValues: Set[Any]

    Permalink
    Definition Classes
    FieldHasInvalidValues
  37. 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
  38. 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
  39. def isContinuous: Boolean

    Permalink

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  40. def isDataField: Boolean

    Permalink

    Tests if the field is a data field.

    Tests if the field is a data field.

    Definition Classes
    Field
  41. def isDate: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  42. def isDateTime: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  43. def isDerivedField: Boolean

    Permalink

    Tests if the field is a derived field.

    Tests if the field is a derived field.

    Definition Classes
    Field
  44. def isDouble: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  45. val isFinalResult: Boolean

    Permalink
  46. def isFloat: Boolean

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

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

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

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

    Permalink
    Definition Classes
    FieldHasMissingValues
  52. val isMultiValued: Boolean

    Permalink
  53. def isMutable: Boolean

    Permalink
    Definition Classes
    FieldAttribute
  54. def isNominal: Boolean

    Permalink

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  55. def isNumeric: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  56. def isOrdinal: Boolean

    Permalink

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  57. def isReal: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  58. def isString: Boolean

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

    Permalink
    Definition Classes
    HasMissingValues
  60. def isTime: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  61. def isTimestamp: Boolean

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

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

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

    Permalink
    Definition Classes
    FieldHasMissingValues
  65. val name: String

    Permalink

    Name of the field.

    Name of the field.

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

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

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

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

    Permalink
    Definition Classes
    FieldHasValidValues
  70. val opType: OpType

    Permalink

    Operational type.

    Operational type.

    Definition Classes
    OutputFieldHasOpType
  71. val rank: Int

    Permalink
  72. val rankBasis: RankBasis

    Permalink
  73. val rankOrder: RankOrder

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

    Permalink

    Sets the referenced flag of the field.

    Sets the referenced flag of the field.

    Definition Classes
    AbstractFieldField
  76. val ruleFeature: RuleFeature

    Permalink
  77. val segmentId: Option[String]

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

    Permalink
    Definition Classes
    AnyRef
  79. val targetField: Option[String]

    Permalink
  80. def toAttribute: Attribute

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

    Permalink

    Converts to an immutable attribute if it's mutable.

    Converts to an immutable attribute if it's mutable.

    Definition Classes
    AbstractFieldField
  82. def toString(): String

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

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

    Permalink
    Definition Classes
    FieldHasValidValues
  86. val value: Option[Any]

    Permalink
  87. def valuesAsString: String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    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