Package org.dmg.pmml.association

Class AssociationModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.association.AssociationModel

All Implemented Interfaces:

Serializable, HasExtensions<AssociationModel>, HasLocalTransformations<Model>, HasLocator, HasOutput<Model>, HasTargets<Model>, Visitable

public class AssociationModel
extends Model
implements HasExtensions<AssociationModel>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AssociationModel()
AssociationModel(MiningFunction miningFunction, Integer numberOfTransactions, Number minimumSupport, Number minimumConfidence, Integer numberOfItems, Integer numberOfItemsets, Integer numberOfRules, MiningSchema miningSchema)

Method Summary

Modifier and Type	Method	Description
VisitorAction	accept(Visitor visitor)
AssociationModel	addAssociationRules(AssociationRule... associationRules)
AssociationModel	addExtensions(Extension... extensions)
AssociationModel	addItems(Item... items)
AssociationModel	addItemsets(Itemset... itemsets)
String	getAlgorithmName()
List<AssociationRule>	getAssociationRules()
Number	getAvgNumberOfItemsPerTA()
List<Extension>	getExtensions()
List<Item>	getItems()
List<Itemset>	getItemsets()
Integer	getLengthLimit()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
Integer	getMaxNumberOfItemsPerTA()
Number	getMinimumConfidence()
Number	getMinimumSupport()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
String	getModelName()
ModelStats	getModelStats()
ModelVerification	getModelVerification()
Integer	getNumberOfItems()
Integer	getNumberOfItemsets()
Integer	getNumberOfRules()
Integer	getNumberOfTransactions()
Output	getOutput()
boolean	hasAssociationRules()
boolean	hasExtensions()
boolean	hasItems()
boolean	hasItemsets()
boolean	isScorable()
Number	requireMinimumConfidence()
Number	requireMinimumSupport()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
Integer	requireNumberOfItems()
Integer	requireNumberOfItemsets()
Integer	requireNumberOfRules()
Integer	requireNumberOfTransactions()
AssociationModel	setAlgorithmName(String algorithmName)
AssociationModel	setAvgNumberOfItemsPerTA(Number avgNumberOfItemsPerTA)
AssociationModel	setLengthLimit(Integer lengthLimit)
AssociationModel	setLocalTransformations(LocalTransformations localTransformations)
AssociationModel	setMathContext(MathContext mathContext)
AssociationModel	setMaxNumberOfItemsPerTA(Integer maxNumberOfItemsPerTA)
AssociationModel	setMinimumConfidence(Number minimumConfidence)
AssociationModel	setMinimumSupport(Number minimumSupport)
AssociationModel	setMiningFunction(MiningFunction miningFunction)
AssociationModel	setMiningSchema(MiningSchema miningSchema)
AssociationModel	setModelName(String modelName)
AssociationModel	setModelStats(ModelStats modelStats)
AssociationModel	setModelVerification(ModelVerification modelVerification)
AssociationModel	setNumberOfItems(Integer numberOfItems)
AssociationModel	setNumberOfItemsets(Integer numberOfItemsets)
AssociationModel	setNumberOfRules(Integer numberOfRules)
AssociationModel	setNumberOfTransactions(Integer numberOfTransactions)
AssociationModel	setOutput(Output output)
AssociationModel	setScorable(Boolean scorable)

Methods inherited from class org.dmg.pmml.Model

getModelExplanation, getTargets, setModelExplanation, setTargets

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, getSchemaVersion, getSchemaVersion, hasLocator, setLocator

Methods inherited from class java.lang.Object

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

Constructor Detail

AssociationModel

public AssociationModel()

AssociationModel

public AssociationModel(MiningFunction miningFunction,
                        Integer numberOfTransactions,
                        Number minimumSupport,
                        Number minimumConfidence,
                        Integer numberOfItems,
                        Integer numberOfItemsets,
                        Integer numberOfRules,
                        MiningSchema miningSchema)

Method Detail

getModelName

public String getModelName()

Specified by:

getModelName in class Model

setModelName

public AssociationModel setModelName(String modelName)

Specified by:

setModelName in class Model

requireMiningFunction

public MiningFunction requireMiningFunction()

Specified by:

requireMiningFunction in class Model

getMiningFunction

public MiningFunction getMiningFunction()

Specified by:

getMiningFunction in class Model

setMiningFunction

public AssociationModel setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public AssociationModel setAlgorithmName(String algorithmName)

Specified by:

setAlgorithmName in class Model

requireNumberOfTransactions

public Integer requireNumberOfTransactions()

getNumberOfTransactions

public Integer getNumberOfTransactions()

setNumberOfTransactions

public AssociationModel setNumberOfTransactions(Integer numberOfTransactions)

getMaxNumberOfItemsPerTA

public Integer getMaxNumberOfItemsPerTA()

setMaxNumberOfItemsPerTA

public AssociationModel setMaxNumberOfItemsPerTA(Integer maxNumberOfItemsPerTA)

getAvgNumberOfItemsPerTA

public Number getAvgNumberOfItemsPerTA()

setAvgNumberOfItemsPerTA

public AssociationModel setAvgNumberOfItemsPerTA(Number avgNumberOfItemsPerTA)

requireMinimumSupport

public Number requireMinimumSupport()

getMinimumSupport

public Number getMinimumSupport()

setMinimumSupport

public AssociationModel setMinimumSupport(Number minimumSupport)

requireMinimumConfidence

public Number requireMinimumConfidence()

getMinimumConfidence

public Number getMinimumConfidence()

setMinimumConfidence

public AssociationModel setMinimumConfidence(Number minimumConfidence)

getLengthLimit

public Integer getLengthLimit()

setLengthLimit

public AssociationModel setLengthLimit(Integer lengthLimit)

requireNumberOfItems

public Integer requireNumberOfItems()

getNumberOfItems

public Integer getNumberOfItems()

setNumberOfItems

public AssociationModel setNumberOfItems(Integer numberOfItems)

requireNumberOfItemsets

public Integer requireNumberOfItemsets()

getNumberOfItemsets

public Integer getNumberOfItemsets()

setNumberOfItemsets

public AssociationModel setNumberOfItemsets(Integer numberOfItemsets)

requireNumberOfRules

public Integer requireNumberOfRules()

getNumberOfRules

public Integer getNumberOfRules()

setNumberOfRules

public AssociationModel setNumberOfRules(Integer numberOfRules)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public AssociationModel setScorable(Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public AssociationModel setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<AssociationModel>

getExtensions

public List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<AssociationModel>

addExtensions

public AssociationModel addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<AssociationModel>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public AssociationModel setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Specified by:

getOutput in interface HasOutput<Model>

Overrides:

getOutput in class Model

setOutput

public AssociationModel setOutput(Output output)

Specified by:

setOutput in interface HasOutput<Model>

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public AssociationModel setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in interface HasLocalTransformations<Model>

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public AssociationModel setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in interface HasLocalTransformations<Model>

Specified by:

setLocalTransformations in class Model

hasItems

public boolean hasItems()

getItems

public List<Item> getItems()

addItems

public AssociationModel addItems(Item... items)

hasItemsets

public boolean hasItemsets()

getItemsets

public List<Itemset> getItemsets()

addItemsets

public AssociationModel addItemsets(Itemset... itemsets)

hasAssociationRules

public boolean hasAssociationRules()

getAssociationRules

public List<AssociationRule> getAssociationRules()

addAssociationRules

public AssociationModel addAssociationRules(AssociationRule... associationRules)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public AssociationModel setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable