org.dmg.pmml

Class AssociationModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.AssociationModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class AssociationModel
extends Model
implements HasExtensions

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"/>
       </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

Constructor Summary

Constructors

Constructor and Description
AssociationModel()
AssociationModel(MiningFunctionType functionName, Integer numberOfTransactions, Double minimumSupport, Double minimumConfidence, Integer numberOfItems, Integer numberOfItemsets, Integer numberOfRules, MiningSchema miningSchema)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
AssociationModel	addAssociationRules(AssociationRule... associationRules)
AssociationModel	addExtensions(Extension... extensions)
AssociationModel	addItems(Item... items)
AssociationModel	addItemsets(Itemset... itemsets)
String	getAlgorithmName() Gets the value of the algorithmName property.
List<AssociationRule>	getAssociationRules() Gets the value of the associationRules property.
Double	getAvgNumberOfItemsPerTA() Gets the value of the avgNumberOfItemsPerTA property.
List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
List<Item>	getItems() Gets the value of the items property.
List<Itemset>	getItemsets() Gets the value of the itemsets property.
Integer	getLengthLimit() Gets the value of the lengthLimit property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
Integer	getMaxNumberOfItemsPerTA() Gets the value of the maxNumberOfItemsPerTA property.
Double	getMinimumConfidence() Gets the value of the minimumConfidence property.
Double	getMinimumSupport() Gets the value of the minimumSupport property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
String	getModelName() Gets the value of the modelName property.
ModelStats	getModelStats() Gets the value of the modelStats property.
ModelVerification	getModelVerification() Gets the value of the modelVerification property.
Integer	getNumberOfItems() Gets the value of the numberOfItems property.
Integer	getNumberOfItemsets() Gets the value of the numberOfItemsets property.
Integer	getNumberOfRules() Gets the value of the numberOfRules property.
Integer	getNumberOfTransactions() Gets the value of the numberOfTransactions property.
Output	getOutput() Gets the value of the output property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasAssociationRules()
boolean	hasExtensions()
boolean	hasItems()
boolean	hasItemsets()
boolean	isScorable() Gets the value of the scorable property.
AssociationModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
AssociationModel	setAvgNumberOfItemsPerTA(Double avgNumberOfItemsPerTA) Sets the value of the avgNumberOfItemsPerTA property.
AssociationModel	setFunctionName(MiningFunctionType functionName) Sets the value of the functionName property.
AssociationModel	setLengthLimit(Integer lengthLimit) Sets the value of the lengthLimit property.
AssociationModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
AssociationModel	setMaxNumberOfItemsPerTA(Integer maxNumberOfItemsPerTA) Sets the value of the maxNumberOfItemsPerTA property.
AssociationModel	setMinimumConfidence(Double minimumConfidence) Sets the value of the minimumConfidence property.
AssociationModel	setMinimumSupport(Double minimumSupport) Sets the value of the minimumSupport property.
AssociationModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
AssociationModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
AssociationModel	setModelName(String modelName) Sets the value of the modelName property.
AssociationModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
AssociationModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
AssociationModel	setNumberOfItems(Integer numberOfItems) Sets the value of the numberOfItems property.
AssociationModel	setNumberOfItemsets(Integer numberOfItemsets) Sets the value of the numberOfItemsets property.
AssociationModel	setNumberOfRules(Integer numberOfRules) Sets the value of the numberOfRules property.
AssociationModel	setNumberOfTransactions(Integer numberOfTransactions) Sets the value of the numberOfTransactions property.
AssociationModel	setOutput(Output output) Sets the value of the output property.
AssociationModel	setScorable(Boolean scorable) Sets the value of the scorable property.
AssociationModel	setTargets(Targets targets) Sets the value of the targets property.

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

Constructor Detail

AssociationModel

public AssociationModel()

AssociationModel

public AssociationModel(MiningFunctionType functionName,
                Integer numberOfTransactions,
                Double minimumSupport,
                Double minimumConfidence,
                Integer numberOfItems,
                Integer numberOfItemsets,
                Integer numberOfRules,
                MiningSchema miningSchema)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public AssociationModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public AssociationModel setFunctionName(MiningFunctionType functionName)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

functionName - allowed object is MiningFunctionType

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public AssociationModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getNumberOfTransactions

public Integer getNumberOfTransactions()

Gets the value of the numberOfTransactions property.

Returns:

possible object is String

setNumberOfTransactions

public AssociationModel setNumberOfTransactions(Integer numberOfTransactions)

Sets the value of the numberOfTransactions property.

Parameters:

numberOfTransactions - allowed object is String

getMaxNumberOfItemsPerTA

public Integer getMaxNumberOfItemsPerTA()

Gets the value of the maxNumberOfItemsPerTA property.

Returns:

possible object is String

setMaxNumberOfItemsPerTA

public AssociationModel setMaxNumberOfItemsPerTA(Integer maxNumberOfItemsPerTA)

Sets the value of the maxNumberOfItemsPerTA property.

Parameters:

maxNumberOfItemsPerTA - allowed object is String

getAvgNumberOfItemsPerTA

public Double getAvgNumberOfItemsPerTA()

Gets the value of the avgNumberOfItemsPerTA property.

Returns:

possible object is Double

setAvgNumberOfItemsPerTA

public AssociationModel setAvgNumberOfItemsPerTA(Double avgNumberOfItemsPerTA)

Sets the value of the avgNumberOfItemsPerTA property.

Parameters:

avgNumberOfItemsPerTA - allowed object is Double

getMinimumSupport

public Double getMinimumSupport()

Gets the value of the minimumSupport property.

Returns:

possible object is String

setMinimumSupport

public AssociationModel setMinimumSupport(Double minimumSupport)

Sets the value of the minimumSupport property.

Parameters:

minimumSupport - allowed object is String

getMinimumConfidence

public Double getMinimumConfidence()

Gets the value of the minimumConfidence property.

Returns:

possible object is String

setMinimumConfidence

public AssociationModel setMinimumConfidence(Double minimumConfidence)

Sets the value of the minimumConfidence property.

Parameters:

minimumConfidence - allowed object is String

getLengthLimit

public Integer getLengthLimit()

Gets the value of the lengthLimit property.

Returns:

possible object is String

setLengthLimit

public AssociationModel setLengthLimit(Integer lengthLimit)

Sets the value of the lengthLimit property.

Parameters:

lengthLimit - allowed object is String

getNumberOfItems

public Integer getNumberOfItems()

Gets the value of the numberOfItems property.

Returns:

possible object is String

setNumberOfItems

public AssociationModel setNumberOfItems(Integer numberOfItems)

Sets the value of the numberOfItems property.

Parameters:

numberOfItems - allowed object is String

getNumberOfItemsets

public Integer getNumberOfItemsets()

Gets the value of the numberOfItemsets property.

Returns:

possible object is String

setNumberOfItemsets

public AssociationModel setNumberOfItemsets(Integer numberOfItemsets)

Sets the value of the numberOfItemsets property.

Parameters:

numberOfItemsets - allowed object is String

getNumberOfRules

public Integer getNumberOfRules()

Gets the value of the numberOfRules property.

Returns:

possible object is String

setNumberOfRules

public AssociationModel setNumberOfRules(Integer numberOfRules)

Sets the value of the numberOfRules property.

Parameters:

numberOfRules - allowed object is String

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public AssociationModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

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

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public AssociationModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public AssociationModel setOutput(Output output)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

output - allowed object is Output

getModelStats

public ModelStats getModelStats()

Gets the value of the modelStats property.

Specified by:

getModelStats in class Model

Returns:

possible object is ModelStats

setModelStats

public AssociationModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public AssociationModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getItems

public List<Item> getItems()

Gets the value of the items 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 items property.

For example, to add a new item, do as follows:

    getItems().add(newItem);
 

Objects of the following type(s) are allowed in the list Item

getItemsets

public List<Itemset> getItemsets()

Gets the value of the itemsets 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 itemsets property.

For example, to add a new item, do as follows:

    getItemsets().add(newItem);
 

Objects of the following type(s) are allowed in the list Itemset

getAssociationRules

public List<AssociationRule> getAssociationRules()

Gets the value of the associationRules 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 associationRules property.

For example, to add a new item, do as follows:

    getAssociationRules().add(newItem);
 

Objects of the following type(s) are allowed in the list AssociationRule

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public AssociationModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public AssociationModel addExtensions(Extension... extensions)

hasItems

public boolean hasItems()

addItems

public AssociationModel addItems(Item... items)

hasItemsets

public boolean hasItemsets()

addItemsets

public AssociationModel addItemsets(Itemset... itemsets)

hasAssociationRules

public boolean hasAssociationRules()

addAssociationRules

public AssociationModel addAssociationRules(AssociationRule... associationRules)

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Throws:

UnsupportedOperationException - Always.

setModelExplanation

public AssociationModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Throws:

UnsupportedOperationException - Always.

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Throws:

UnsupportedOperationException - Always.

setTargets

public AssociationModel setTargets(Targets targets)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Throws:

UnsupportedOperationException - Always.

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable