org.dmg.pmml

Class AssociationRule

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Entity

org.dmg.pmml.AssociationRule

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasId, HasLocator, Visitable

public class AssociationRule
extends Entity
implements 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 java.lang.Double	affinity
protected java.lang.String	antecedent
protected java.lang.Double	confidence
protected java.lang.String	consequent
protected java.util.List<Extension>	extensions
protected java.lang.String	id
protected java.lang.Double	leverage
protected java.lang.Double	lift
protected java.lang.Double	support

Constructor Summary

Constructors

Constructor and Description
AssociationRule()
AssociationRule(java.lang.String antecedent, java.lang.String consequent, java.lang.Double support, java.lang.Double confidence)

Method Summary

Methods

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

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

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

Field Detail

antecedent

protected java.lang.String antecedent

consequent

protected java.lang.String consequent

support

protected java.lang.Double support

confidence

protected java.lang.Double confidence

lift

protected java.lang.Double lift

leverage

protected java.lang.Double leverage

affinity

protected java.lang.Double affinity

id

protected java.lang.String id

extensions

protected java.util.List<Extension> extensions

Constructor Detail

AssociationRule

public AssociationRule()

AssociationRule

public AssociationRule(java.lang.String antecedent,
               java.lang.String consequent,
               java.lang.Double support,
               java.lang.Double confidence)

Method Detail

getAntecedent

public java.lang.String getAntecedent()

Gets the value of the antecedent property.

Returns:

possible object is String

setAntecedent

public void setAntecedent(java.lang.String value)

Sets the value of the antecedent property.

Parameters:

value - allowed object is String

getConsequent

public java.lang.String getConsequent()

Gets the value of the consequent property.

Returns:

possible object is String

setConsequent

public void setConsequent(java.lang.String value)

Sets the value of the consequent property.

Parameters:

value - allowed object is String

getSupport

public java.lang.Double getSupport()

Gets the value of the support property.

Returns:

possible object is String

setSupport

public void setSupport(java.lang.Double value)

Sets the value of the support property.

Parameters:

value - allowed object is String

getConfidence

public java.lang.Double getConfidence()

Gets the value of the confidence property.

Returns:

possible object is String

setConfidence

public void setConfidence(java.lang.Double value)

Sets the value of the confidence property.

Parameters:

value - allowed object is String

getLift

public java.lang.Double getLift()

Gets the value of the lift property.

Returns:

possible object is String

setLift

public void setLift(java.lang.Double value)

Sets the value of the lift property.

Parameters:

value - allowed object is String

getLeverage

public java.lang.Double getLeverage()

Gets the value of the leverage property.

Returns:

possible object is String

setLeverage

public void setLeverage(java.lang.Double value)

Sets the value of the leverage property.

Parameters:

value - allowed object is String

getAffinity

public java.lang.Double getAffinity()

Gets the value of the affinity property.

Returns:

possible object is String

setAffinity

public void setAffinity(java.lang.Double value)

Sets the value of the affinity property.

Parameters:

value - allowed object is String

getId

public java.lang.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(java.lang.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

getExtensions

public java.util.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

withAntecedent

public AssociationRule withAntecedent(java.lang.String value)

withConsequent

public AssociationRule withConsequent(java.lang.String value)

withSupport

public AssociationRule withSupport(java.lang.Double value)

withConfidence

public AssociationRule withConfidence(java.lang.Double value)

withLift

public AssociationRule withLift(java.lang.Double value)

withLeverage

public AssociationRule withLeverage(java.lang.Double value)

withAffinity

public AssociationRule withAffinity(java.lang.Double value)

withId

public AssociationRule withId(java.lang.String value)

withExtensions

public AssociationRule withExtensions(Extension... values)

withExtensions

public AssociationRule withExtensions(java.util.Collection<Extension> values)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable