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, 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_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Item" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Itemset" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}AssociationRule" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}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_3}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_3}INT-NUMBER" />
       <attribute name="maxNumberOfItemsPerTA" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="avgNumberOfItemsPerTA" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
       <attribute name="minimumSupport" use="required" type="{http://www.dmg.org/PMML-4_3}PROB-NUMBER" />
       <attribute name="minimumConfidence" use="required" type="{http://www.dmg.org/PMML-4_3}PROB-NUMBER" />
       <attribute name="lengthLimit" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="numberOfItems" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="numberOfItemsets" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="numberOfRules" use="required" type="{http://www.dmg.org/PMML-4_3}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(MiningFunction miningFunction, int numberOfTransactions, double minimumSupport, double minimumConfidence, int numberOfItems, int numberOfItemsets, int 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.
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.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema 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.
int	getNumberOfItems() Gets the value of the numberOfItems property.
int	getNumberOfItemsets() Gets the value of the numberOfItemsets property.
int	getNumberOfRules() Gets the value of the numberOfRules property.
int	getNumberOfTransactions() Gets the value of the numberOfTransactions property.
Output	getOutput() Gets the value of the output 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	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	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
AssociationModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema 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(int numberOfItems) Sets the value of the numberOfItems property.
AssociationModel	setNumberOfItemsets(int numberOfItemsets) Sets the value of the numberOfItemsets property.
AssociationModel	setNumberOfRules(int numberOfRules) Sets the value of the numberOfRules property.
AssociationModel	setNumberOfTransactions(int 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.

Methods inherited from class org.dmg.pmml.Model

getModelExplanation, getTargets, setModelExplanation, setTargets

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

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(MiningFunction miningFunction,
                int numberOfTransactions,
                double minimumSupport,
                double minimumConfidence,
                int numberOfItems,
                int numberOfItemsets,
                int 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

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public AssociationModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

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 int getNumberOfTransactions()

Gets the value of the numberOfTransactions property.

setNumberOfTransactions

public AssociationModel setNumberOfTransactions(int numberOfTransactions)

Sets the value of the numberOfTransactions property.

getMaxNumberOfItemsPerTA

public Integer getMaxNumberOfItemsPerTA()

Gets the value of the maxNumberOfItemsPerTA property.

Returns:

possible object is Integer

setMaxNumberOfItemsPerTA

public AssociationModel setMaxNumberOfItemsPerTA(Integer maxNumberOfItemsPerTA)

Sets the value of the maxNumberOfItemsPerTA property.

Parameters:

maxNumberOfItemsPerTA - allowed object is Integer

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.

setMinimumSupport

public AssociationModel setMinimumSupport(double minimumSupport)

Sets the value of the minimumSupport property.

getMinimumConfidence

public double getMinimumConfidence()

Gets the value of the minimumConfidence property.

setMinimumConfidence

public AssociationModel setMinimumConfidence(double minimumConfidence)

Sets the value of the minimumConfidence property.

getLengthLimit

public Integer getLengthLimit()

Gets the value of the lengthLimit property.

Returns:

possible object is Integer

setLengthLimit

public AssociationModel setLengthLimit(Integer lengthLimit)

Sets the value of the lengthLimit property.

Parameters:

lengthLimit - allowed object is Integer

getNumberOfItems

public int getNumberOfItems()

Gets the value of the numberOfItems property.

setNumberOfItems

public AssociationModel setNumberOfItems(int numberOfItems)

Sets the value of the numberOfItems property.

getNumberOfItemsets

public int getNumberOfItemsets()

Gets the value of the numberOfItemsets property.

setNumberOfItemsets

public AssociationModel setNumberOfItemsets(int numberOfItemsets)

Sets the value of the numberOfItemsets property.

getNumberOfRules

public int getNumberOfRules()

Gets the value of the numberOfRules property.

setNumberOfRules

public AssociationModel setNumberOfRules(int numberOfRules)

Sets the value of the numberOfRules property.

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.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public AssociationModel setOutput(Output output)

Sets the value of the output property.

Overrides:

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.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public AssociationModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

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)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable