Class

org.pmml4s.metadata

Field

Related Doc: package metadata

Permalink

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

Instance Constructors

  1. new Field()

    Permalink

Abstract Value Members

  1. abstract def dataType: DataType

    Permalink

    Returns the data type of field.

    Returns the data type of field.

    Definition Classes
    DataTypeLike
  2. abstract def fieldType: FieldType

    Permalink

    Field type.

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

    Permalink

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

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

    Permalink

    Sets the index of this field.

  5. abstract def name: String

    Permalink

    Name of the field.

  6. abstract def opType: OpType

    Permalink

    Operational type.

    Operational type.

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

    Permalink

    Sets the referenced flag of the field.

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

    Permalink
    Definition Classes
    Any
  6. def attrType: AttributeType

    Permalink

    Attribute type.

    Attribute type.

    Definition Classes
    FieldAttribute
  7. def attribute: Attribute

    Permalink

    Attribute of the field.

  8. def clone(): AnyRef

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

    Permalink
    Definition Classes
    FieldValueIndexer
  10. def displayName: Option[String]

    Permalink

    Display name of the field.

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

  11. def encode(value: Any): Double

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

    Permalink

    Encodes the value of the field in the input series.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def getDouble(series: Series): Double

    Permalink

    Retrieve its value as double from the specified series, return Double.NaN if missing.

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

    Permalink
    Definition Classes
    FieldHasLabels
  18. def hashCode(): Int

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

    Permalink

    Index of the field in the input series.

  20. def indexDefined: Boolean

    Permalink

    Tests if the index of this field is defined

  21. def intervals: Array[Interval]

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

    Permalink
    Definition Classes
    FieldHasInvalidValues
  23. 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
  24. 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
  25. def isContinuous: Boolean

    Permalink

    Tests whether this field is continuous.

    Tests whether this field is continuous.

    Definition Classes
    HasOpType
  26. def isDataField: Boolean

    Permalink

    Tests if the field is a data field.

  27. def isDate: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  28. def isDateTime: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  29. def isDerivedField: Boolean

    Permalink

    Tests if the field is a derived field.

  30. def isDouble: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  31. def isFloat: Boolean

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

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

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

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

    Permalink

    Tests if its value is missing from the specified series.

  36. def isMissingValue(value: Any): Boolean

    Permalink
    Definition Classes
    FieldHasMissingValues
  37. def isMutable: Boolean

    Permalink
    Definition Classes
    FieldAttribute
  38. def isNominal: Boolean

    Permalink

    Tests whether this field is nominal.

    Tests whether this field is nominal.

    Definition Classes
    HasOpType
  39. def isNumeric: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  40. def isOrdinal: Boolean

    Permalink

    Tests whether this field is ordinal.

    Tests whether this field is ordinal.

    Definition Classes
    HasOpType
  41. def isReal: Boolean

    Permalink
    Definition Classes
    DataTypeLike
  42. def isString: Boolean

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

    Permalink
    Definition Classes
    HasMissingValues
  44. def isTime: Boolean

    Permalink
    Definition Classes
    FieldDataTypeLike
  45. def isTimestamp: Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    FieldHasValidValues
  53. def referenced: Boolean

    Permalink

    Tests if the field is referenced in the model element.

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

    Permalink
    Definition Classes
    AnyRef
  55. def toAttribute: Attribute

    Permalink
    Definition Classes
    FieldAttribute
  56. def toImmutable(): Field

    Permalink

    Converts to an immutable attribute if it's mutable.

  57. def toString(): String

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

    Exceptions thrown

    java.lang.NumberFormatException - If the string does not contain a parsable number if dataType is numeric

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

  60. def validValues: Array[Any]

    Permalink
    Definition Classes
    FieldHasValidValues
  61. def valuesAsString: String

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. 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 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