AssociationModel (Drools :: PMML - Compiler 6.3.0.CR1 API)

java.lang.Object
- org.dmg.pmml.pmml_4_2.descr.AssociationModel

All Implemented Interfaces:: Serializable

public class AssociationModel
extends Object
implements Serializable

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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Item" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Itemset" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}AssociationRule" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelVerification" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="modelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="functionName" use="required" type="{http://www.dmg.org/PMML-4_2}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="numberOfTransactions" use="required" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="maxNumberOfItemsPerTA" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="avgNumberOfItemsPerTA" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="minimumSupport" use="required" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
       <attribute name="minimumConfidence" use="required" type="{http://www.dmg.org/PMML-4_2}PROB-NUMBER" />
       <attribute name="lengthLimit" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="numberOfItems" use="required" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="numberOfItemsets" use="required" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="numberOfRules" use="required" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`algorithmName`
`protected Double`	`avgNumberOfItemsPerTA`
`protected List<Serializable>`	`extensionsAndMiningSchemasAndOutputs`
`protected MININGFUNCTION`	`functionName`
`protected Boolean`	`isScorable`
`protected BigInteger`	`lengthLimit`
`protected BigInteger`	`maxNumberOfItemsPerTA`
`protected BigDecimal`	`minimumConfidence`
`protected BigDecimal`	`minimumSupport`
`protected String`	`modelName`
`protected BigInteger`	`numberOfItems`
`protected BigInteger`	`numberOfItemsets`
`protected BigInteger`	`numberOfRules`
`protected BigInteger`	`numberOfTransactions`

Constructor Summary

Constructors
Constructor and Description

AssociationModel()

Constructors
Constructor and Description
`AssociationModel()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAlgorithmName()` Gets the value of the algorithmName property.
`Double`	`getAvgNumberOfItemsPerTA()` Gets the value of the avgNumberOfItemsPerTA property.
`List<Serializable>`	`getExtensionsAndMiningSchemasAndOutputs()` Gets the value of the extensionsAndMiningSchemasAndOutputs property.
`MININGFUNCTION`	`getFunctionName()` Gets the value of the functionName property.
`BigInteger`	`getLengthLimit()` Gets the value of the lengthLimit property.
`BigInteger`	`getMaxNumberOfItemsPerTA()` Gets the value of the maxNumberOfItemsPerTA property.
`BigDecimal`	`getMinimumConfidence()` Gets the value of the minimumConfidence property.
`BigDecimal`	`getMinimumSupport()` Gets the value of the minimumSupport property.
`String`	`getModelName()` Gets the value of the modelName property.
`BigInteger`	`getNumberOfItems()` Gets the value of the numberOfItems property.
`BigInteger`	`getNumberOfItemsets()` Gets the value of the numberOfItemsets property.
`BigInteger`	`getNumberOfRules()` Gets the value of the numberOfRules property.
`BigInteger`	`getNumberOfTransactions()` Gets the value of the numberOfTransactions property.
`boolean`	`isIsScorable()` Gets the value of the isScorable property.
`void`	`setAlgorithmName(String value)` Sets the value of the algorithmName property.
`void`	`setAvgNumberOfItemsPerTA(Double value)` Sets the value of the avgNumberOfItemsPerTA property.
`void`	`setFunctionName(MININGFUNCTION value)` Sets the value of the functionName property.
`void`	`setIsScorable(Boolean value)` Sets the value of the isScorable property.
`void`	`setLengthLimit(BigInteger value)` Sets the value of the lengthLimit property.
`void`	`setMaxNumberOfItemsPerTA(BigInteger value)` Sets the value of the maxNumberOfItemsPerTA property.
`void`	`setMinimumConfidence(BigDecimal value)` Sets the value of the minimumConfidence property.
`void`	`setMinimumSupport(BigDecimal value)` Sets the value of the minimumSupport property.
`void`	`setModelName(String value)` Sets the value of the modelName property.
`void`	`setNumberOfItems(BigInteger value)` Sets the value of the numberOfItems property.
`void`	`setNumberOfItemsets(BigInteger value)` Sets the value of the numberOfItemsets property.
`void`	`setNumberOfRules(BigInteger value)` Sets the value of the numberOfRules property.
`void`	`setNumberOfTransactions(BigInteger value)` Sets the value of the numberOfTransactions property.

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

- Field Detail
  - extensionsAndMiningSchemasAndOutputs
```
protected List<Serializable> extensionsAndMiningSchemasAndOutputs
```
  - modelName
```
protected String modelName
```
  - functionName
```
protected MININGFUNCTION functionName
```
  - algorithmName
```
protected String algorithmName
```
  - numberOfTransactions
```
protected BigInteger numberOfTransactions
```
  - maxNumberOfItemsPerTA
```
protected BigInteger maxNumberOfItemsPerTA
```
  - avgNumberOfItemsPerTA
```
protected Double avgNumberOfItemsPerTA
```
  - minimumSupport
```
protected BigDecimal minimumSupport
```
  - minimumConfidence
```
protected BigDecimal minimumConfidence
```
  - lengthLimit
```
protected BigInteger lengthLimit
```
  - numberOfItems
```
protected BigInteger numberOfItems
```
  - numberOfItemsets
```
protected BigInteger numberOfItemsets
```
  - numberOfRules
```
protected BigInteger numberOfRules
```
  - isScorable
```
protected Boolean isScorable
```
- Constructor Detail
  - AssociationModel
```
public AssociationModel()
```
- Method Detail
  - getExtensionsAndMiningSchemasAndOutputs
```
public List<Serializable> getExtensionsAndMiningSchemasAndOutputs()
```
    Gets the value of the extensionsAndMiningSchemasAndOutputs 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 extensionsAndMiningSchemasAndOutputs property.
    For example, to add a new item, do as follows:
```
    getExtensionsAndMiningSchemasAndOutputs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ModelStats MiningSchema ModelVerification Item Itemset Output Extension LocalTransformations AssociationRule
  - getModelName
```
public String getModelName()
```
    Gets the value of the modelName property.
    
    Returns:
    possible object is String
  - setModelName
```
public void setModelName(String value)
```
    Sets the value of the modelName property.
    
    Parameters:
    value - allowed object is String
  - getFunctionName
```
public MININGFUNCTION getFunctionName()
```
    Gets the value of the functionName property.
    
    Returns:
    possible object is MININGFUNCTION
  - setFunctionName
```
public void setFunctionName(MININGFUNCTION value)
```
    Sets the value of the functionName property.
    
    Parameters:
    value - allowed object is MININGFUNCTION
  - getAlgorithmName
```
public String getAlgorithmName()
```
    Gets the value of the algorithmName property.
    
    Returns:
    possible object is String
  - setAlgorithmName
```
public void setAlgorithmName(String value)
```
    Sets the value of the algorithmName property.
    
    Parameters:
    value - allowed object is String
  - getNumberOfTransactions
```
public BigInteger getNumberOfTransactions()
```
    Gets the value of the numberOfTransactions property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfTransactions
```
public void setNumberOfTransactions(BigInteger value)
```
    Sets the value of the numberOfTransactions property.
    
    Parameters:
    value - allowed object is BigInteger
  - getMaxNumberOfItemsPerTA
```
public BigInteger getMaxNumberOfItemsPerTA()
```
    Gets the value of the maxNumberOfItemsPerTA property.
    
    Returns:
    possible object is BigInteger
  - setMaxNumberOfItemsPerTA
```
public void setMaxNumberOfItemsPerTA(BigInteger value)
```
    Sets the value of the maxNumberOfItemsPerTA property.
    
    Parameters:
    value - allowed object is BigInteger
  - getAvgNumberOfItemsPerTA
```
public Double getAvgNumberOfItemsPerTA()
```
    Gets the value of the avgNumberOfItemsPerTA property.
    
    Returns:
    possible object is Double
  - setAvgNumberOfItemsPerTA
```
public void setAvgNumberOfItemsPerTA(Double value)
```
    Sets the value of the avgNumberOfItemsPerTA property.
    
    Parameters:
    value - allowed object is Double
  - getMinimumSupport
```
public BigDecimal getMinimumSupport()
```
    Gets the value of the minimumSupport property.
    
    Returns:
    possible object is BigDecimal
  - setMinimumSupport
```
public void setMinimumSupport(BigDecimal value)
```
    Sets the value of the minimumSupport property.
    
    Parameters:
    value - allowed object is BigDecimal
  - getMinimumConfidence
```
public BigDecimal getMinimumConfidence()
```
    Gets the value of the minimumConfidence property.
    
    Returns:
    possible object is BigDecimal
  - setMinimumConfidence
```
public void setMinimumConfidence(BigDecimal value)
```
    Sets the value of the minimumConfidence property.
    
    Parameters:
    value - allowed object is BigDecimal
  - getLengthLimit
```
public BigInteger getLengthLimit()
```
    Gets the value of the lengthLimit property.
    
    Returns:
    possible object is BigInteger
  - setLengthLimit
```
public void setLengthLimit(BigInteger value)
```
    Sets the value of the lengthLimit property.
    
    Parameters:
    value - allowed object is BigInteger
  - getNumberOfItems
```
public BigInteger getNumberOfItems()
```
    Gets the value of the numberOfItems property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfItems
```
public void setNumberOfItems(BigInteger value)
```
    Sets the value of the numberOfItems property.
    
    Parameters:
    value - allowed object is BigInteger
  - getNumberOfItemsets
```
public BigInteger getNumberOfItemsets()
```
    Gets the value of the numberOfItemsets property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfItemsets
```
public void setNumberOfItemsets(BigInteger value)
```
    Sets the value of the numberOfItemsets property.
    
    Parameters:
    value - allowed object is BigInteger
  - getNumberOfRules
```
public BigInteger getNumberOfRules()
```
    Gets the value of the numberOfRules property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfRules
```
public void setNumberOfRules(BigInteger value)
```
    Sets the value of the numberOfRules property.
    
    Parameters:
    value - allowed object is BigInteger
  - isIsScorable
```
public boolean isIsScorable()
```
    Gets the value of the isScorable property.
    
    Returns:
    possible object is Boolean
  - setIsScorable
```
public void setIsScorable(Boolean value)
```
    Sets the value of the isScorable property.
    
    Parameters:
    value - allowed object is Boolean

Class AssociationModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensionsAndMiningSchemasAndOutputs

modelName

functionName

algorithmName

numberOfTransactions

maxNumberOfItemsPerTA

avgNumberOfItemsPerTA

minimumSupport

minimumConfidence

lengthLimit

numberOfItems

numberOfItemsets

numberOfRules

isScorable

Constructor Detail

AssociationModel

Method Detail

getExtensionsAndMiningSchemasAndOutputs

getModelName

setModelName

getFunctionName

setFunctionName

getAlgorithmName

setAlgorithmName

getNumberOfTransactions

setNumberOfTransactions

getMaxNumberOfItemsPerTA

setMaxNumberOfItemsPerTA

getAvgNumberOfItemsPerTA

setAvgNumberOfItemsPerTA

getMinimumSupport

setMinimumSupport

getMinimumConfidence

setMinimumConfidence

getLengthLimit

setLengthLimit

getNumberOfItems

setNumberOfItems

getNumberOfItemsets

setNumberOfItemsets

getNumberOfRules

setNumberOfRules

isIsScorable

setIsScorable