org.dmg.pmml

Class AssociationModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.AssociationModel

All Implemented Interfaces:

java.io.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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithmName
protected java.util.List<AssociationRule>	associationRules
protected java.lang.Double	avgNumberOfItemsPerTA
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected java.util.List<Item>	items
protected java.util.List<Itemset>	itemsets
protected java.lang.Integer	lengthLimit
protected LocalTransformations	localTransformations
protected java.lang.Integer	maxNumberOfItemsPerTA
protected java.lang.Double	minimumConfidence
protected java.lang.Double	minimumSupport
protected MiningSchema	miningSchema
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected java.lang.Integer	numberOfItems
protected java.lang.Integer	numberOfItemsets
protected java.lang.Integer	numberOfRules
protected java.lang.Integer	numberOfTransactions
protected Output	output
protected java.lang.Boolean	scorable

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
java.util.List<AssociationRule>	getAssociationRules() Gets the value of the associationRules property.
java.lang.Double	getAvgNumberOfItemsPerTA() Gets the value of the avgNumberOfItemsPerTA property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
java.util.List<Item>	getItems() Gets the value of the items property.
java.util.List<Itemset>	getItemsets() Gets the value of the itemsets property.
java.lang.Integer	getLengthLimit() Gets the value of the lengthLimit property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
java.lang.Integer	getMaxNumberOfItemsPerTA() Gets the value of the maxNumberOfItemsPerTA property.
java.lang.Double	getMinimumConfidence() Gets the value of the minimumConfidence property.
java.lang.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.
java.lang.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.
java.lang.Integer	getNumberOfItems() Gets the value of the numberOfItems property.
java.lang.Integer	getNumberOfItemsets() Gets the value of the numberOfItemsets property.
java.lang.Integer	getNumberOfRules() Gets the value of the numberOfRules property.
java.lang.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.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setAvgNumberOfItemsPerTA(java.lang.Double value) Sets the value of the avgNumberOfItemsPerTA property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLengthLimit(java.lang.Integer value) Sets the value of the lengthLimit property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMaxNumberOfItemsPerTA(java.lang.Integer value) Sets the value of the maxNumberOfItemsPerTA property.
void	setMinimumConfidence(java.lang.Double value) Sets the value of the minimumConfidence property.
void	setMinimumSupport(java.lang.Double value) Sets the value of the minimumSupport property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
void	setModelName(java.lang.String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNumberOfItems(java.lang.Integer value) Sets the value of the numberOfItems property.
void	setNumberOfItemsets(java.lang.Integer value) Sets the value of the numberOfItemsets property.
void	setNumberOfRules(java.lang.Integer value) Sets the value of the numberOfRules property.
void	setNumberOfTransactions(java.lang.Integer value) Sets the value of the numberOfTransactions property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets targets) Sets the value of the targets property.
AssociationModel	withAlgorithmName(java.lang.String value)
AssociationModel	withAssociationRules(AssociationRule... values)
AssociationModel	withAssociationRules(java.util.Collection<AssociationRule> values)
AssociationModel	withAvgNumberOfItemsPerTA(java.lang.Double value)
AssociationModel	withExtensions(java.util.Collection<Extension> values)
AssociationModel	withExtensions(Extension... values)
AssociationModel	withFunctionName(MiningFunctionType value)
AssociationModel	withItems(java.util.Collection<Item> values)
AssociationModel	withItems(Item... values)
AssociationModel	withItemsets(java.util.Collection<Itemset> values)
AssociationModel	withItemsets(Itemset... values)
AssociationModel	withLengthLimit(java.lang.Integer value)
AssociationModel	withLocalTransformations(LocalTransformations value)
AssociationModel	withMaxNumberOfItemsPerTA(java.lang.Integer value)
AssociationModel	withMinimumConfidence(java.lang.Double value)
AssociationModel	withMinimumSupport(java.lang.Double value)
AssociationModel	withMiningSchema(MiningSchema value)
AssociationModel	withModelName(java.lang.String value)
AssociationModel	withModelStats(ModelStats value)
AssociationModel	withModelVerification(ModelVerification value)
AssociationModel	withNumberOfItems(java.lang.Integer value)
AssociationModel	withNumberOfItemsets(java.lang.Integer value)
AssociationModel	withNumberOfRules(java.lang.Integer value)
AssociationModel	withNumberOfTransactions(java.lang.Integer value)
AssociationModel	withOutput(Output value)
AssociationModel	withScorable(java.lang.Boolean 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

modelName

protected java.lang.String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected java.lang.String algorithmName

numberOfTransactions

protected java.lang.Integer numberOfTransactions

maxNumberOfItemsPerTA

protected java.lang.Integer maxNumberOfItemsPerTA

avgNumberOfItemsPerTA

protected java.lang.Double avgNumberOfItemsPerTA

minimumSupport

protected java.lang.Double minimumSupport

minimumConfidence

protected java.lang.Double minimumConfidence

lengthLimit

protected java.lang.Integer lengthLimit

numberOfItems

protected java.lang.Integer numberOfItems

numberOfItemsets

protected java.lang.Integer numberOfItemsets

numberOfRules

protected java.lang.Integer numberOfRules

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

localTransformations

protected LocalTransformations localTransformations

items

protected java.util.List<Item> items

itemsets

protected java.util.List<Itemset> itemsets

associationRules

protected java.util.List<AssociationRule> associationRules

modelVerification

protected ModelVerification modelVerification

Constructor Detail

AssociationModel

public AssociationModel()

AssociationModel

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

Method Detail

getModelName

public java.lang.String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(java.lang.String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - 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 void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public java.lang.String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(java.lang.String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getNumberOfTransactions

public java.lang.Integer getNumberOfTransactions()

Gets the value of the numberOfTransactions property.

Returns:

possible object is String

setNumberOfTransactions

public void setNumberOfTransactions(java.lang.Integer value)

Sets the value of the numberOfTransactions property.

Parameters:

value - allowed object is String

getMaxNumberOfItemsPerTA

public java.lang.Integer getMaxNumberOfItemsPerTA()

Gets the value of the maxNumberOfItemsPerTA property.

Returns:

possible object is String

setMaxNumberOfItemsPerTA

public void setMaxNumberOfItemsPerTA(java.lang.Integer value)

Sets the value of the maxNumberOfItemsPerTA property.

Parameters:

value - allowed object is String

getAvgNumberOfItemsPerTA

public java.lang.Double getAvgNumberOfItemsPerTA()

Gets the value of the avgNumberOfItemsPerTA property.

Returns:

possible object is Double

setAvgNumberOfItemsPerTA

public void setAvgNumberOfItemsPerTA(java.lang.Double value)

Sets the value of the avgNumberOfItemsPerTA property.

Parameters:

value - allowed object is Double

getMinimumSupport

public java.lang.Double getMinimumSupport()

Gets the value of the minimumSupport property.

Returns:

possible object is String

setMinimumSupport

public void setMinimumSupport(java.lang.Double value)

Sets the value of the minimumSupport property.

Parameters:

value - allowed object is String

getMinimumConfidence

public java.lang.Double getMinimumConfidence()

Gets the value of the minimumConfidence property.

Returns:

possible object is String

setMinimumConfidence

public void setMinimumConfidence(java.lang.Double value)

Sets the value of the minimumConfidence property.

Parameters:

value - allowed object is String

getLengthLimit

public java.lang.Integer getLengthLimit()

Gets the value of the lengthLimit property.

Returns:

possible object is String

setLengthLimit

public void setLengthLimit(java.lang.Integer value)

Sets the value of the lengthLimit property.

Parameters:

value - allowed object is String

getNumberOfItems

public java.lang.Integer getNumberOfItems()

Gets the value of the numberOfItems property.

Returns:

possible object is String

setNumberOfItems

public void setNumberOfItems(java.lang.Integer value)

Sets the value of the numberOfItems property.

Parameters:

value - allowed object is String

getNumberOfItemsets

public java.lang.Integer getNumberOfItemsets()

Gets the value of the numberOfItemsets property.

Returns:

possible object is String

setNumberOfItemsets

public void setNumberOfItemsets(java.lang.Integer value)

Sets the value of the numberOfItemsets property.

Parameters:

value - allowed object is String

getNumberOfRules

public java.lang.Integer getNumberOfRules()

Gets the value of the numberOfRules property.

Returns:

possible object is String

setNumberOfRules

public void setNumberOfRules(java.lang.Integer value)

Sets the value of the numberOfRules property.

Parameters:

value - 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 void setScorable(java.lang.Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

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

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - 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 void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - 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 void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - 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 void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - allowed object is LocalTransformations

getItems

public java.util.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 java.util.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 java.util.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 void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public AssociationModel withModelName(java.lang.String value)

withFunctionName

public AssociationModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public AssociationModel withAlgorithmName(java.lang.String value)

withNumberOfTransactions

public AssociationModel withNumberOfTransactions(java.lang.Integer value)

withMaxNumberOfItemsPerTA

public AssociationModel withMaxNumberOfItemsPerTA(java.lang.Integer value)

withAvgNumberOfItemsPerTA

public AssociationModel withAvgNumberOfItemsPerTA(java.lang.Double value)

withMinimumSupport

public AssociationModel withMinimumSupport(java.lang.Double value)

withMinimumConfidence

public AssociationModel withMinimumConfidence(java.lang.Double value)

withLengthLimit

public AssociationModel withLengthLimit(java.lang.Integer value)

withNumberOfItems

public AssociationModel withNumberOfItems(java.lang.Integer value)

withNumberOfItemsets

public AssociationModel withNumberOfItemsets(java.lang.Integer value)

withNumberOfRules

public AssociationModel withNumberOfRules(java.lang.Integer value)

withScorable

public AssociationModel withScorable(java.lang.Boolean value)

withExtensions

public AssociationModel withExtensions(Extension... values)

withExtensions

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

withMiningSchema

public AssociationModel withMiningSchema(MiningSchema value)

withOutput

public AssociationModel withOutput(Output value)

withModelStats

public AssociationModel withModelStats(ModelStats value)

withLocalTransformations

public AssociationModel withLocalTransformations(LocalTransformations value)

withItems

public AssociationModel withItems(Item... values)

withItems

public AssociationModel withItems(java.util.Collection<Item> values)

withItemsets

public AssociationModel withItemsets(Itemset... values)

withItemsets

public AssociationModel withItemsets(java.util.Collection<Itemset> values)

withAssociationRules

public AssociationModel withAssociationRules(AssociationRule... values)

withAssociationRules

public AssociationModel withAssociationRules(java.util.Collection<AssociationRule> values)

withModelVerification

public AssociationModel withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasItems

public boolean hasItems()

hasItemsets

public boolean hasItemsets()

hasAssociationRules

public boolean hasAssociationRules()

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

setModelExplanation

public void setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

setTargets

public void setTargets(Targets targets)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable