org.dmg.pmml

Class SequenceModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.SequenceModel

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class SequenceModel
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}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Constraints" 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}SetPredicate" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Sequence" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_2}SequenceRule" 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" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="maxNumberOfItemsPerTransaction" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="avgNumberOfItemsPerTransaction" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="numberOfTransactionGroups" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="maxNumberOfTAsPerTAGroup" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="avgNumberOfTAsPerTAGroup" type="{http://www.dmg.org/PMML-4_2}REAL-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.lang.Double	avgNumberOfItemsPerTransaction
protected java.lang.Double	avgNumberOfTAsPerTAGroup
protected Constraints	constraints
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected java.util.List<Item>	items
protected java.util.List<Itemset>	itemsets
protected LocalTransformations	localTransformations
protected java.lang.Integer	maxNumberOfItemsPerTransaction
protected java.lang.Integer	maxNumberOfTAsPerTAGroup
protected MiningSchema	miningSchema
protected java.lang.String	modelName
protected ModelStats	modelStats
protected java.lang.Integer	numberOfTransactionGroups
protected java.lang.Integer	numberOfTransactions
protected java.lang.Boolean	scorable
protected java.util.List<SequenceRule>	sequenceRules
protected java.util.List<Sequence>	sequences
protected java.util.List<SetPredicate>	setPredicates

Constructor Summary

Constructors

Constructor and Description
SequenceModel()
SequenceModel(MiningFunctionType functionName, MiningSchema miningSchema, java.util.List<Sequence> sequences)

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.lang.Double	getAvgNumberOfItemsPerTransaction() Gets the value of the avgNumberOfItemsPerTransaction property.
java.lang.Double	getAvgNumberOfTAsPerTAGroup() Gets the value of the avgNumberOfTAsPerTAGroup property.
Constraints	getConstraints() Gets the value of the constraints 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.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
java.lang.Integer	getMaxNumberOfItemsPerTransaction() Gets the value of the maxNumberOfItemsPerTransaction property.
java.lang.Integer	getMaxNumberOfTAsPerTAGroup() Gets the value of the maxNumberOfTAsPerTAGroup 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	getNumberOfTransactionGroups() Gets the value of the numberOfTransactionGroups property.
java.lang.Integer	getNumberOfTransactions() Gets the value of the numberOfTransactions property.
Output	getOutput() Gets the value of the output property.
java.util.List<SequenceRule>	getSequenceRules() Gets the value of the sequenceRules property.
java.util.List<Sequence>	getSequences() Gets the value of the sequences property.
java.util.List<SetPredicate>	getSetPredicates() Gets the value of the setPredicates property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasExtensions()
boolean	hasItems()
boolean	hasItemsets()
boolean	hasSequenceRules()
boolean	hasSequences()
boolean	hasSetPredicates()
boolean	isScorable() Gets the value of the scorable property.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setAvgNumberOfItemsPerTransaction(java.lang.Double value) Sets the value of the avgNumberOfItemsPerTransaction property.
void	setAvgNumberOfTAsPerTAGroup(java.lang.Double value) Sets the value of the avgNumberOfTAsPerTAGroup property.
void	setConstraints(Constraints value) Sets the value of the constraints property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMaxNumberOfItemsPerTransaction(java.lang.Integer value) Sets the value of the maxNumberOfItemsPerTransaction property.
void	setMaxNumberOfTAsPerTAGroup(java.lang.Integer value) Sets the value of the maxNumberOfTAsPerTAGroup 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 modelVerification) Sets the value of the modelVerification property.
void	setNumberOfTransactionGroups(java.lang.Integer value) Sets the value of the numberOfTransactionGroups property.
void	setNumberOfTransactions(java.lang.Integer value) Sets the value of the numberOfTransactions property.
void	setOutput(Output output) 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.
SequenceModel	withAlgorithmName(java.lang.String value)
SequenceModel	withAvgNumberOfItemsPerTransaction(java.lang.Double value)
SequenceModel	withAvgNumberOfTAsPerTAGroup(java.lang.Double value)
SequenceModel	withConstraints(Constraints value)
SequenceModel	withExtensions(java.util.Collection<Extension> values)
SequenceModel	withExtensions(Extension... values)
SequenceModel	withFunctionName(MiningFunctionType value)
SequenceModel	withItems(java.util.Collection<Item> values)
SequenceModel	withItems(Item... values)
SequenceModel	withItemsets(java.util.Collection<Itemset> values)
SequenceModel	withItemsets(Itemset... values)
SequenceModel	withLocalTransformations(LocalTransformations value)
SequenceModel	withMaxNumberOfItemsPerTransaction(java.lang.Integer value)
SequenceModel	withMaxNumberOfTAsPerTAGroup(java.lang.Integer value)
SequenceModel	withMiningSchema(MiningSchema value)
SequenceModel	withModelName(java.lang.String value)
SequenceModel	withModelStats(ModelStats value)
SequenceModel	withNumberOfTransactionGroups(java.lang.Integer value)
SequenceModel	withNumberOfTransactions(java.lang.Integer value)
SequenceModel	withScorable(java.lang.Boolean value)
SequenceModel	withSequenceRules(java.util.Collection<SequenceRule> values)
SequenceModel	withSequenceRules(SequenceRule... values)
SequenceModel	withSequences(java.util.Collection<Sequence> values)
SequenceModel	withSequences(Sequence... values)
SequenceModel	withSetPredicates(java.util.Collection<SetPredicate> values)
SequenceModel	withSetPredicates(SetPredicate... values)

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

maxNumberOfItemsPerTransaction

protected java.lang.Integer maxNumberOfItemsPerTransaction

avgNumberOfItemsPerTransaction

protected java.lang.Double avgNumberOfItemsPerTransaction

numberOfTransactionGroups

protected java.lang.Integer numberOfTransactionGroups

maxNumberOfTAsPerTAGroup

protected java.lang.Integer maxNumberOfTAsPerTAGroup

avgNumberOfTAsPerTAGroup

protected java.lang.Double avgNumberOfTAsPerTAGroup

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

modelStats

protected ModelStats modelStats

localTransformations

protected LocalTransformations localTransformations

constraints

protected Constraints constraints

items

protected java.util.List<Item> items

itemsets

protected java.util.List<Itemset> itemsets

setPredicates

protected java.util.List<SetPredicate> setPredicates

sequences

protected java.util.List<Sequence> sequences

sequenceRules

protected java.util.List<SequenceRule> sequenceRules

Constructor Detail

SequenceModel

public SequenceModel()

SequenceModel

public SequenceModel(MiningFunctionType functionName,
             MiningSchema miningSchema,
             java.util.List<Sequence> sequences)

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

getMaxNumberOfItemsPerTransaction

public java.lang.Integer getMaxNumberOfItemsPerTransaction()

Gets the value of the maxNumberOfItemsPerTransaction property.

Returns:

possible object is String

setMaxNumberOfItemsPerTransaction

public void setMaxNumberOfItemsPerTransaction(java.lang.Integer value)

Sets the value of the maxNumberOfItemsPerTransaction property.

Parameters:

value - allowed object is String

getAvgNumberOfItemsPerTransaction

public java.lang.Double getAvgNumberOfItemsPerTransaction()

Gets the value of the avgNumberOfItemsPerTransaction property.

Returns:

possible object is Double

setAvgNumberOfItemsPerTransaction

public void setAvgNumberOfItemsPerTransaction(java.lang.Double value)

Sets the value of the avgNumberOfItemsPerTransaction property.

Parameters:

value - allowed object is Double

getNumberOfTransactionGroups

public java.lang.Integer getNumberOfTransactionGroups()

Gets the value of the numberOfTransactionGroups property.

Returns:

possible object is String

setNumberOfTransactionGroups

public void setNumberOfTransactionGroups(java.lang.Integer value)

Sets the value of the numberOfTransactionGroups property.

Parameters:

value - allowed object is String

getMaxNumberOfTAsPerTAGroup

public java.lang.Integer getMaxNumberOfTAsPerTAGroup()

Gets the value of the maxNumberOfTAsPerTAGroup property.

Returns:

possible object is String

setMaxNumberOfTAsPerTAGroup

public void setMaxNumberOfTAsPerTAGroup(java.lang.Integer value)

Sets the value of the maxNumberOfTAsPerTAGroup property.

Parameters:

value - allowed object is String

getAvgNumberOfTAsPerTAGroup

public java.lang.Double getAvgNumberOfTAsPerTAGroup()

Gets the value of the avgNumberOfTAsPerTAGroup property.

Returns:

possible object is Double

setAvgNumberOfTAsPerTAGroup

public void setAvgNumberOfTAsPerTAGroup(java.lang.Double value)

Sets the value of the avgNumberOfTAsPerTAGroup property.

Parameters:

value - allowed object is Double

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

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

getConstraints

public Constraints getConstraints()

Gets the value of the constraints property.

Returns:

possible object is Constraints

setConstraints

public void setConstraints(Constraints value)

Sets the value of the constraints property.

Parameters:

value - allowed object is Constraints

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

getSetPredicates

public java.util.List<SetPredicate> getSetPredicates()

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

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

    getSetPredicates().add(newItem);
 

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

getSequences

public java.util.List<Sequence> getSequences()

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

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

    getSequences().add(newItem);
 

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

getSequenceRules

public java.util.List<SequenceRule> getSequenceRules()

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

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

    getSequenceRules().add(newItem);
 

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

withModelName

public SequenceModel withModelName(java.lang.String value)

withFunctionName

public SequenceModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public SequenceModel withAlgorithmName(java.lang.String value)

withNumberOfTransactions

public SequenceModel withNumberOfTransactions(java.lang.Integer value)

withMaxNumberOfItemsPerTransaction

public SequenceModel withMaxNumberOfItemsPerTransaction(java.lang.Integer value)

withAvgNumberOfItemsPerTransaction

public SequenceModel withAvgNumberOfItemsPerTransaction(java.lang.Double value)

withNumberOfTransactionGroups

public SequenceModel withNumberOfTransactionGroups(java.lang.Integer value)

withMaxNumberOfTAsPerTAGroup

public SequenceModel withMaxNumberOfTAsPerTAGroup(java.lang.Integer value)

withAvgNumberOfTAsPerTAGroup

public SequenceModel withAvgNumberOfTAsPerTAGroup(java.lang.Double value)

withScorable

public SequenceModel withScorable(java.lang.Boolean value)

withExtensions

public SequenceModel withExtensions(Extension... values)

withExtensions

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

withMiningSchema

public SequenceModel withMiningSchema(MiningSchema value)

withModelStats

public SequenceModel withModelStats(ModelStats value)

withLocalTransformations

public SequenceModel withLocalTransformations(LocalTransformations value)

withConstraints

public SequenceModel withConstraints(Constraints value)

withItems

public SequenceModel withItems(Item... values)

withItems

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

withItemsets

public SequenceModel withItemsets(Itemset... values)

withItemsets

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

withSetPredicates

public SequenceModel withSetPredicates(SetPredicate... values)

withSetPredicates

public SequenceModel withSetPredicates(java.util.Collection<SetPredicate> values)

withSequences

public SequenceModel withSequences(Sequence... values)

withSequences

public SequenceModel withSequences(java.util.Collection<Sequence> values)

withSequenceRules

public SequenceModel withSequenceRules(SequenceRule... values)

withSequenceRules

public SequenceModel withSequenceRules(java.util.Collection<SequenceRule> values)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasItems

public boolean hasItems()

hasItemsets

public boolean hasItemsets()

hasSetPredicates

public boolean hasSetPredicates()

hasSequences

public boolean hasSequences()

hasSequenceRules

public boolean hasSequenceRules()

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.

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

setModelVerification

public void setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

setOutput

public void setOutput(Output output)

Sets the value of the output property.

Specified by:

setOutput 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