org.pmml4s.metadata

Field

abstract class Field extends HasDataType with HasOpType with Attribute

Abstract class for field in a PMML.

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

Instance Constructors

  1. new Field()

Abstract Value Members

  1. abstract def dataType: DataType

    Returns the data type of field.

    Returns the data type of field.

    Definition Classes
    DataTypeLike
  2. abstract def fieldType: FieldType

    Field type.

  3. abstract def get(series: Series): Any

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

  4. abstract def index_=(i: Int): Unit

    Sets the index of this field.

  5. abstract def name: String

    Name of the field.

  6. abstract def opType: OpType

    Operational type.

    Operational type.

    Definition Classes
    HasOpType
  7. abstract def referenced_=(r: Boolean): Unit

    Sets the referenced flag of the field.

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

    Definition Classes
    Any
  8. def attrType: AttributeType

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  9. def attribute: Attribute

    Attribute of the field.

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def decode(index: Int): Any

    Definition Classes
    FieldValueIndexer
  12. def displayName: Option[String]

    Display name of the field.

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

  13. def encode(value: Any): Double

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

    Encodes the value of the field in the input series.

  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

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

  20. def getLabel(value: Any): Option[String]

    Definition Classes
    FieldHasLabels
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def index: Int

    Index of the field in the input series.

  23. def indexDefined: Boolean

    Tests if the index of this field is defined

  24. def intervals: Array[Interval]

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

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

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

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

    Definition Classes
    HasOpType
  28. def isContinuous: Boolean

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  29. def isDataField: Boolean

    Tests if the field is a data field.

  30. def isDate: Boolean

    Definition Classes
    DataTypeLike
  31. def isDateTime: Boolean

    Definition Classes
    DataTypeLike
  32. def isDerivedField: Boolean

    Tests if the field is a derived field.

  33. def isDouble: Boolean

    Definition Classes
    DataTypeLike
  34. def isFloat: Boolean

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

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

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

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

    Tests if its value is missing from the specified series.

  39. def isMissingValue(value: Any): Boolean

    Definition Classes
    FieldHasMissingValues
  40. def isMutable: Boolean

    Definition Classes
    FieldAttribute
  41. def isNominal: Boolean

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  42. def isNumeric: Boolean

    Definition Classes
    DataTypeLike
  43. def isOrdinal: Boolean

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  44. def isReal: Boolean

    Definition Classes
    DataTypeLike
  45. def isString: Boolean

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

    Definition Classes
    HasMissingValues
  47. def isTime: Boolean

    Definition Classes
    DataTypeLike
  48. def isTimestamp: Boolean

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

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

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

    Definition Classes
    FieldHasMissingValues
  52. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  55. def numCategories: Int

    Definition Classes
    FieldHasValidValues
  56. def referenced: Boolean

    Tests if the field is referenced in the model element.

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

    Definition Classes
    AnyRef
  58. def toAttribute: Attribute

    Definition Classes
    FieldAttribute
  59. def toImmutable(): Field

    Converts to an immutable attribute if it's mutable.

  60. def toString(): String

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

    Exceptions thrown
    java.lang.NumberFormatException

    - If the string does not contain a parsable number if dataType is numeric

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

  63. def validValues: Array[Any]

    Definition Classes
    FieldHasValidValues
  64. def valuesAsString: String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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