KiePMMLDroolsRule (KIE :: PMML :: Models :: Drools

java.lang.Object
- org.kie.pmml.models.drools.ast.KiePMMLDroolsRule

```
public class KiePMMLDroolsRule
extends Object
```
Data-class used to store information needed to generate a Drools rule

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class KiePMMLDroolsRule.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`KiePMMLDroolsRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static KiePMMLDroolsRule.Builder`	`builder(String name, String statusToSet, List<KiePMMLOutputField> outputFields)`
`String`	`getActivationGroup()`
`String`	`getAgendaGroup()`
`List<KiePMMLFieldOperatorValue>`	`getAndConstraints()`
`String`	`getFocusedAgendaGroup()`
`String`	`getIfBreakField()`
`String`	`getIfBreakOperator()`
`Object`	`getIfBreakValue()`
`Map<String,List<Object>>`	`getInConstraints()`
`String`	`getName()`
`List<KiePMMLFieldOperatorValue>`	`getNotConstraints()`
`Map<String,List<Object>>`	`getNotInConstraints()`
`List<KiePMMLFieldOperatorValue>`	`getOrConstraints()`
`List<KiePMMLOutputField>`	`getOutputFields()`
`KiePMMLReasonCodeAndValue`	`getReasonCodeAndValue()`
`Object`	`getResult()`
`ResultCode`	`getResultCode()`
`String`	`getStatusConstraint()`
`String`	`getStatusToSet()` The status to set in the rhs (`$statusHolder.setStatus("DONE");` `update($statusHolder);`)
`Double`	`getToAccumulate()` The accumulation to set in the rhs (`$statusHolder.accumulate(_toAccumulate_);`
`List<KiePMMLFieldOperatorValue>`	`getXorConstraints()`
`boolean`	`isAccumulationResult()` It `true`, set the overall accumulation as final result
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static KiePMMLDroolsRule.Builder builder(String name,
                                                String statusToSet,
                                                List<KiePMMLOutputField> outputFields)
```
    Parameters:
    
    name - The rule name
    
    statusToSet - The status to set in the rhs' default then; e.g.:
    then
    
    $statusHolder.setStatus(statusToSet);
    
    update($statusHolder);
    
    If there is a break statement in the lhs, then the statusToSet will be applied differently if the node is a final/leaf or not.
    
    If the node is a final/leaf, the statusToSet will be applied in the default then directive, while in the default then[match] it will be set as "DONE"
    ; e.g.:
    then
    
    $statusHolder.setStatus(statusToSet);
    
    update($statusHolder);
    
    then[match]
    
    $statusHolder.setStatus("DONE");
    
    update($statusHolder);
    
    If the node is a not final/leaf, the statusToSet will be set in the then[match] directive, while in the default then it will be set as "DONE"
    ; e.g.:
    then
    
    $statusHolder.setStatus("DONE");
    
    update($statusHolder);
    
    then[match]
    
    $statusHolder.setStatus(statusToSet);
    
    update($statusHolder);
    
    Returns:
  - getName
```
public String getName()
```
  - getStatusToSet
```
public String getStatusToSet()
```
    The status to set in the rhs ($statusHolder.setStatus("DONE"); update($statusHolder);)
    
    Returns:
  - getOutputFields
```
public List<KiePMMLOutputField> getOutputFields()
```
  - getAgendaGroup
```
public String getAgendaGroup()
```
  - getActivationGroup
```
public String getActivationGroup()
```
  - getFocusedAgendaGroup
```
public String getFocusedAgendaGroup()
```
  - getStatusConstraint
```
public String getStatusConstraint()
```
  - getAndConstraints
```
public List<KiePMMLFieldOperatorValue> getAndConstraints()
```
  - getOrConstraints
```
public List<KiePMMLFieldOperatorValue> getOrConstraints()
```
  - getXorConstraints
```
public List<KiePMMLFieldOperatorValue> getXorConstraints()
```
  - getNotConstraints
```
public List<KiePMMLFieldOperatorValue> getNotConstraints()
```
  - getInConstraints
```
public Map<String,List<Object>> getInConstraints()
```
  - getNotInConstraints
```
public Map<String,List<Object>> getNotInConstraints()
```
  - getIfBreakField
```
public String getIfBreakField()
```
  - getIfBreakOperator
```
public String getIfBreakOperator()
```
  - getIfBreakValue
```
public Object getIfBreakValue()
```
  - getReasonCodeAndValue
```
public KiePMMLReasonCodeAndValue getReasonCodeAndValue()
```
  - getResultCode
```
public ResultCode getResultCode()
```
  - getResult
```
public Object getResult()
```
  - getToAccumulate
```
public Double getToAccumulate()
```
    The accumulation to set in the rhs ($statusHolder.accumulate(_toAccumulate_);
    
    Returns:
  - isAccumulationResult
```
public boolean isAccumulationResult()
```
    It true, set the overall accumulation as final result
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class KiePMMLDroolsRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getName

getStatusToSet

getOutputFields

getAgendaGroup

getActivationGroup

getFocusedAgendaGroup

getStatusConstraint

getAndConstraints

getOrConstraints

getXorConstraints

getNotConstraints

getInConstraints

getNotInConstraints

getIfBreakField

getIfBreakOperator

getIfBreakValue

getReasonCodeAndValue

getResultCode

getResult

getToAccumulate

isAccumulationResult

toString