Class

org.pmml4s.model

Attribute

Related Doc: package model

Permalink

class Attribute extends Predicate with PmmlElement

Defines input attributes for each scorecard characteristic are defined in terms of predicates. For numeric characteristics, predicates are used to implement the mapping from a range of continuous values to a partial score . For example, age range 20 to 29 may map to partial score "15". For categorical characteristics, predicates are used to implement the mapping of categorical values to partial scores. Note that while predicates will not (typically) overlap, the Scoring Procedure requires the ordering of Attributes to be respected, and that the first matching Attribute shall determine the partial scored value.

Linear Supertypes
Predicate, PmmlElement, Serializable, Serializable, HasExtensions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Attribute
  2. Predicate
  3. PmmlElement
  4. Serializable
  5. Serializable
  6. HasExtensions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Attribute(reasonCode: Option[String], partialScore: Option[Double], predicate: Predicate, complexPartialScore: Option[ComplexPartialScore])

    Permalink

    reasonCode

    Defines the attribute's reason code. If the reasonCode attribute is used in this level, it takes precedence over the reasonCode attribute associated with the Characteristic element.

    partialScore

    Defines the score points awarded to the Attribute. Note that attribute partialScore is optional. A partial score is required though to be specified for every Attribute. Either it needs to be defined through the partialScore attribute or through the ComplexPartialScore element as defined below.

    predicate

    The condition upon which the mapping between input attribute and partial score takes place. For more details on PREDICATE see the section on predicates in TreeModel for an explanation on how predicates are described and evaluated. In scorecard models, all the predicates defining the Attributes for a particular Characteristic must all reference a single field.

    complexPartialScore

    Used to implement complex point allocation of the score points awarded to the Attribute . To be used in lieu of attribute partialScore. If both are defined, element ComplexPartialScore takes precedence over attribute partialScore for computing the score points awarded to the Attribute. Whenever element ComplexPartialScore is used, the actual partial score is the value returned by the EXPRESSION (see Transformations for more information).

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val complexPartialScore: Option[ComplexPartialScore]

    Permalink

    Used to implement complex point allocation of the score points awarded to the Attribute .

    Used to implement complex point allocation of the score points awarded to the Attribute . To be used in lieu of attribute partialScore. If both are defined, element ComplexPartialScore takes precedence over attribute partialScore for computing the score points awarded to the Attribute. Whenever element ComplexPartialScore is used, the actual partial score is the value returned by the EXPRESSION (see Transformations for more information).

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

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

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

    Permalink

    Evaluates the predicate.

    Evaluates the predicate.

    Definition Classes
    AttributePredicate
  10. def extensions: Seq[Extension]

    Permalink
    Definition Classes
    HasExtensions
  11. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hasExtensions: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. val partialScore: Option[Double]

    Permalink

    Defines the score points awarded to the Attribute.

    Defines the score points awarded to the Attribute. Note that attribute partialScore is optional. A partial score is required though to be specified for every Attribute. Either it needs to be defined through the partialScore attribute or through the ComplexPartialScore element as defined below.

  20. val predicate: Predicate

    Permalink

    The condition upon which the mapping between input attribute and partial score takes place.

    The condition upon which the mapping between input attribute and partial score takes place. For more details on PREDICATE see the section on predicates in TreeModel for an explanation on how predicates are described and evaluated. In scorecard models, all the predicates defining the Attributes for a particular Characteristic must all reference a single field.

  21. val reasonCode: Option[String]

    Permalink

    Defines the attribute's reason code.

    Defines the attribute's reason code. If the reasonCode attribute is used in this level, it takes precedence over the reasonCode attribute associated with the Characteristic element.

  22. def score(series: Series): Double

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

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

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

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

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

Inherited from Predicate

Inherited from PmmlElement

Inherited from Serializable

Inherited from Serializable

Inherited from HasExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped