AssociationRule (JPMML class model 1.1.6 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.Entity
  - - org.dmg.pmml.AssociationRule

All Implemented Interfaces:: com.sun.xml.bind.Locatable, Serializable, HasExtensions, HasId, Visitable

public class AssociationRule
extends Entity
implements com.sun.xml.bind.Locatable, HasExtensions, HasId

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="antecedent" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="consequent" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="support" use="required" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
       <attribute name="confidence" use="required" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
       <attribute name="lift" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="leverage" type="{http://www.w3.org/2001/XMLSchema}float" />
       <attribute name="affinity" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Double`	`affinity`
`protected String`	`antecedent`
`protected Double`	`confidence`
`protected String`	`consequent`
`protected List<Extension>`	`extensions`
`protected String`	`id`
`protected Double`	`leverage`
`protected Double`	`lift`
`protected Locator`	`locator`
`protected Double`	`support`

Constructor Summary

Constructors
Constructor and Description
`AssociationRule()`
`AssociationRule(String antecedent, String consequent, Double support, Double confidence)`

Method Summary

Methods
Modifier and Type	Method and Description
`VisitorAction`	`accept(Visitor visitor)`
`Double`	`getAffinity()` Gets the value of the affinity property.
`String`	`getAntecedent()` Gets the value of the antecedent property.
`Double`	`getConfidence()` Gets the value of the confidence property.
`String`	`getConsequent()` Gets the value of the consequent property.
`List<Extension>`	`getExtensions()` Gets the value of the extensions property.
`String`	`getId()` Gets the value of the id property.
`Double`	`getLeverage()` Gets the value of the leverage property.
`Double`	`getLift()` Gets the value of the lift property.
`Double`	`getSupport()` Gets the value of the support property.
`void`	`setAffinity(Double value)` Sets the value of the affinity property.
`void`	`setAntecedent(String value)` Sets the value of the antecedent property.
`void`	`setConfidence(Double value)` Sets the value of the confidence property.
`void`	`setConsequent(String value)` Sets the value of the consequent property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setLeverage(Double value)` Sets the value of the leverage property.
`void`	`setLift(Double value)` Sets the value of the lift property.
`void`	`setSourceLocation(Locator newLocator)`
`void`	`setSupport(Double value)` Sets the value of the support property.
`Locator`	`sourceLocation()`
`AssociationRule`	`withAffinity(Double value)`
`AssociationRule`	`withAntecedent(String value)`
`AssociationRule`	`withConfidence(Double value)`
`AssociationRule`	`withConsequent(String value)`
`AssociationRule`	`withExtensions(Collection<Extension> values)`
`AssociationRule`	`withExtensions(Extension... values)`
`AssociationRule`	`withId(String value)`
`AssociationRule`	`withLeverage(Double value)`
`AssociationRule`	`withLift(Double value)`
`AssociationRule`	`withSupport(Double value)`

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

- Field Detail
  - extensions
```
protected List<Extension> extensions
```
  - antecedent
```
protected String antecedent
```
  - consequent
```
protected String consequent
```
  - support
```
protected Double support
```
  - confidence
```
protected Double confidence
```
  - lift
```
protected Double lift
```
  - leverage
```
protected Double leverage
```
  - affinity
```
protected Double affinity
```
  - id
```
protected String id
```
  - locator
```
protected Locator locator
```
- Constructor Detail
  - AssociationRule
```
public AssociationRule()
```
  - AssociationRule
```
public AssociationRule(String antecedent,
               String consequent,
               Double support,
               Double confidence)
```
- Method Detail
  - getExtensions
```
public List<Extension> getExtensions()
```
    Gets the value of the extensions property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.
    For example, to add a new item, do as follows:
```
    getExtensions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Extension
    Specified by:
    
    getExtensions in interface HasExtensions
  - getAntecedent
```
public String getAntecedent()
```
    Gets the value of the antecedent property.
    
    Returns:
    possible object is String
  - setAntecedent
```
public void setAntecedent(String value)
```
    Sets the value of the antecedent property.
    
    Parameters:
    value - allowed object is String
  - getConsequent
```
public String getConsequent()
```
    Gets the value of the consequent property.
    
    Returns:
    possible object is String
  - setConsequent
```
public void setConsequent(String value)
```
    Sets the value of the consequent property.
    
    Parameters:
    value - allowed object is String
  - getSupport
```
public Double getSupport()
```
    Gets the value of the support property.
    
    Returns:
    possible object is String
  - setSupport
```
public void setSupport(Double value)
```
    Sets the value of the support property.
    
    Parameters:
    value - allowed object is String
  - getConfidence
```
public Double getConfidence()
```
    Gets the value of the confidence property.
    
    Returns:
    possible object is String
  - setConfidence
```
public void setConfidence(Double value)
```
    Sets the value of the confidence property.
    
    Parameters:
    value - allowed object is String
  - getLift
```
public Double getLift()
```
    Gets the value of the lift property.
    
    Returns:
    possible object is String
  - setLift
```
public void setLift(Double value)
```
    Sets the value of the lift property.
    
    Parameters:
    value - allowed object is String
  - getLeverage
```
public Double getLeverage()
```
    Gets the value of the leverage property.
    
    Returns:
    possible object is String
  - setLeverage
```
public void setLeverage(Double value)
```
    Sets the value of the leverage property.
    
    Parameters:
    value - allowed object is String
  - getAffinity
```
public Double getAffinity()
```
    Gets the value of the affinity property.
    
    Returns:
    possible object is String
  - setAffinity
```
public void setAffinity(Double value)
```
    Sets the value of the affinity property.
    
    Parameters:
    value - allowed object is String
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Specified by:
    
    getId in interface HasId
    
    Specified by:
    
    getId in class Entity
    
    Returns:
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Specified by:
    
    setId in interface HasId
    
    Specified by:
    
    setId in class Entity
    
    Parameters:
    value - allowed object is String
  - withExtensions
```
public AssociationRule withExtensions(Extension... values)
```
  - withExtensions
```
public AssociationRule withExtensions(Collection<Extension> values)
```
  - withAntecedent
```
public AssociationRule withAntecedent(String value)
```
  - withConsequent
```
public AssociationRule withConsequent(String value)
```
  - withSupport
```
public AssociationRule withSupport(Double value)
```
  - withConfidence
```
public AssociationRule withConfidence(Double value)
```
  - withLift
```
public AssociationRule withLift(Double value)
```
  - withLeverage
```
public AssociationRule withLeverage(Double value)
```
  - withAffinity
```
public AssociationRule withAffinity(Double value)
```
  - withId
```
public AssociationRule withId(String value)
```
  - sourceLocation
```
public Locator sourceLocation()
```
    Specified by:
    
    sourceLocation in interface com.sun.xml.bind.Locatable
    
    Specified by:
    
    sourceLocation in class PMMLObject
  - setSourceLocation
```
public void setSourceLocation(Locator newLocator)
```
    Specified by:
    
    setSourceLocation in class PMMLObject
  - accept
```
public VisitorAction accept(Visitor visitor)
```
    Specified by:
    
    accept in interface Visitable

Class AssociationRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensions

antecedent

consequent

support

confidence

lift

leverage

affinity

id

locator

Constructor Detail

AssociationRule

AssociationRule

Method Detail

getExtensions

getAntecedent

setAntecedent

getConsequent

setConsequent

getSupport

setSupport

getConfidence

setConfidence

getLift

setLift

getLeverage

setLeverage

getAffinity

setAffinity

getId

setId

withExtensions

withExtensions

withAntecedent

withConsequent

withSupport

withConfidence

withLift

withLeverage

withAffinity

withId

sourceLocation

setSourceLocation

accept