oracle.dmt.odm.rule
Class RuleAnnotation

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.rule.RuleAnnotation

All Implemented Interfaces:

java.io.Serializable

public class RuleAnnotation

extends MiningObject

An instance of RuleAnnotation supports extensible annotations on a MiningRule. A RuleAnnotation consists of an annotation type and a value, for example, probability and .75.

See Also:

Serialized Form

Constructor Summary

RuleAnnotation(RuleAnnotationType type, java.lang.String value)
Creates an instance of RuleAnnotation with a RuleAnnoationType and its value.

Method Summary

RuleAnnotationType	getAnnotationType() Returns the rule annotation type.
java.lang.String	getValue() Returns the value of the rule annotation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleAnnotation

public RuleAnnotation(RuleAnnotationType type,
                      java.lang.String value)
               throws InvalidArgumentException,
ODMException

Creates an instance of RuleAnnotation with a RuleAnnoationType and its value.

Parameters:

type - A RuleAnnotationType

value - The value of the annotation

Throws:

InvalidArgumentException - when type or value is null.

ODMException - when value is longer than 1024 characters.

Method Detail

getAnnotationType

public RuleAnnotationType getAnnotationType()

Returns the rule annotation type.

Returns:

RuleAnnotationType - The rule annotation type

getValue

public java.lang.String getValue()

Returns the value of the rule annotation.

Returns:

String - The value of the rule annotation