org.dmg.pmml.sequence

Class SequenceModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.sequence.SequenceModel

All Implemented Interfaces:

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_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}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Constraints" 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}SetPredicate" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Sequence" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_3}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_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="numberOfTransactions" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="maxNumberOfItemsPerTransaction" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="avgNumberOfItemsPerTransaction" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
       <attribute name="numberOfTransactionGroups" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="maxNumberOfTAsPerTAGroup" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="avgNumberOfTAsPerTAGroup" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
       <attribute name="minimumSupport" use="required" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
       <attribute name="minimumConfidence" use="required" type="{http://www.dmg.org/PMML-4_3}REAL-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="numberOfSets" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="numberOfSequences" 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="timeWindowWidth" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="minimumTime" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="maximumTime" 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
SequenceModel()
SequenceModel(MiningFunction miningFunction, double minimumSupport, double minimumConfidence, int numberOfItems, int numberOfSets, int numberOfSequences, int numberOfRules, MiningSchema miningSchema, List<Sequence> sequences)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
SequenceModel	addExtensions(Extension... extensions)
SequenceModel	addItems(Item... items)
SequenceModel	addItemsets(Itemset... itemsets)
SequenceModel	addSequenceRules(SequenceRule... sequenceRules)
SequenceModel	addSequences(Sequence... sequences)
SequenceModel	addSetPredicates(SetPredicate... setPredicates)
String	getAlgorithmName() Gets the value of the algorithmName property.
Double	getAvgNumberOfItemsPerTransaction() Gets the value of the avgNumberOfItemsPerTransaction property.
Double	getAvgNumberOfTAsPerTAGroup() Gets the value of the avgNumberOfTAsPerTAGroup property.
Constraints	getConstraints() Gets the value of the constraints 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	getMaximumTime() Gets the value of the maximumTime property.
Integer	getMaxNumberOfItemsPerTransaction() Gets the value of the maxNumberOfItemsPerTransaction property.
Integer	getMaxNumberOfTAsPerTAGroup() Gets the value of the maxNumberOfTAsPerTAGroup property.
double	getMinimumConfidence() Gets the value of the minimumConfidence property.
double	getMinimumSupport() Gets the value of the minimumSupport property.
Integer	getMinimumTime() Gets the value of the minimumTime 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.
int	getNumberOfItems() Gets the value of the numberOfItems property.
int	getNumberOfRules() Gets the value of the numberOfRules property.
int	getNumberOfSequences() Gets the value of the numberOfSequences property.
int	getNumberOfSets() Gets the value of the numberOfSets property.
Integer	getNumberOfTransactionGroups() Gets the value of the numberOfTransactionGroups property.
Integer	getNumberOfTransactions() Gets the value of the numberOfTransactions property.
List<SequenceRule>	getSequenceRules() Gets the value of the sequenceRules property.
List<Sequence>	getSequences() Gets the value of the sequences property.
List<SetPredicate>	getSetPredicates() Gets the value of the setPredicates property.
Integer	getTimeWindowWidth() Gets the value of the timeWindowWidth property.
boolean	hasExtensions()
boolean	hasItems()
boolean	hasItemsets()
boolean	hasSequenceRules()
boolean	hasSequences()
boolean	hasSetPredicates()
boolean	isScorable() Gets the value of the scorable property.
SequenceModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
SequenceModel	setAvgNumberOfItemsPerTransaction(Double avgNumberOfItemsPerTransaction) Sets the value of the avgNumberOfItemsPerTransaction property.
SequenceModel	setAvgNumberOfTAsPerTAGroup(Double avgNumberOfTAsPerTAGroup) Sets the value of the avgNumberOfTAsPerTAGroup property.
SequenceModel	setConstraints(Constraints constraints) Sets the value of the constraints property.
SequenceModel	setLengthLimit(Integer lengthLimit) Sets the value of the lengthLimit property.
SequenceModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
SequenceModel	setMaximumTime(Integer maximumTime) Sets the value of the maximumTime property.
SequenceModel	setMaxNumberOfItemsPerTransaction(Integer maxNumberOfItemsPerTransaction) Sets the value of the maxNumberOfItemsPerTransaction property.
SequenceModel	setMaxNumberOfTAsPerTAGroup(Integer maxNumberOfTAsPerTAGroup) Sets the value of the maxNumberOfTAsPerTAGroup property.
SequenceModel	setMinimumConfidence(double minimumConfidence) Sets the value of the minimumConfidence property.
SequenceModel	setMinimumSupport(double minimumSupport) Sets the value of the minimumSupport property.
SequenceModel	setMinimumTime(Integer minimumTime) Sets the value of the minimumTime property.
SequenceModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
SequenceModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
SequenceModel	setModelName(String modelName) Sets the value of the modelName property.
SequenceModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
SequenceModel	setNumberOfItems(int numberOfItems) Sets the value of the numberOfItems property.
SequenceModel	setNumberOfRules(int numberOfRules) Sets the value of the numberOfRules property.
SequenceModel	setNumberOfSequences(int numberOfSequences) Sets the value of the numberOfSequences property.
SequenceModel	setNumberOfSets(int numberOfSets) Sets the value of the numberOfSets property.
SequenceModel	setNumberOfTransactionGroups(Integer numberOfTransactionGroups) Sets the value of the numberOfTransactionGroups property.
SequenceModel	setNumberOfTransactions(Integer numberOfTransactions) Sets the value of the numberOfTransactions property.
SequenceModel	setScorable(Boolean scorable) Sets the value of the scorable property.
SequenceModel	setTimeWindowWidth(Integer timeWindowWidth) Sets the value of the timeWindowWidth property.

Methods inherited from class org.dmg.pmml.Model

getModelExplanation, getModelVerification, getOutput, getTargets, setModelExplanation, setModelVerification, setOutput, 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

SequenceModel

public SequenceModel()

SequenceModel

public SequenceModel(MiningFunction miningFunction,
             double minimumSupport,
             double minimumConfidence,
             int numberOfItems,
             int numberOfSets,
             int numberOfSequences,
             int numberOfRules,
             MiningSchema miningSchema,
             List<Sequence> sequences)

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 SequenceModel 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 SequenceModel 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 SequenceModel 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 Integer

setNumberOfTransactions

public SequenceModel setNumberOfTransactions(Integer numberOfTransactions)

Sets the value of the numberOfTransactions property.

Parameters:

numberOfTransactions - allowed object is Integer

getMaxNumberOfItemsPerTransaction

public Integer getMaxNumberOfItemsPerTransaction()

Gets the value of the maxNumberOfItemsPerTransaction property.

Returns:

possible object is Integer

setMaxNumberOfItemsPerTransaction

public SequenceModel setMaxNumberOfItemsPerTransaction(Integer maxNumberOfItemsPerTransaction)

Sets the value of the maxNumberOfItemsPerTransaction property.

Parameters:

maxNumberOfItemsPerTransaction - allowed object is Integer

getAvgNumberOfItemsPerTransaction

public Double getAvgNumberOfItemsPerTransaction()

Gets the value of the avgNumberOfItemsPerTransaction property.

Returns:

possible object is Double

setAvgNumberOfItemsPerTransaction

public SequenceModel setAvgNumberOfItemsPerTransaction(Double avgNumberOfItemsPerTransaction)

Sets the value of the avgNumberOfItemsPerTransaction property.

Parameters:

avgNumberOfItemsPerTransaction - allowed object is Double

getNumberOfTransactionGroups

public Integer getNumberOfTransactionGroups()

Gets the value of the numberOfTransactionGroups property.

Returns:

possible object is Integer

setNumberOfTransactionGroups

public SequenceModel setNumberOfTransactionGroups(Integer numberOfTransactionGroups)

Sets the value of the numberOfTransactionGroups property.

Parameters:

numberOfTransactionGroups - allowed object is Integer

getMaxNumberOfTAsPerTAGroup

public Integer getMaxNumberOfTAsPerTAGroup()

Gets the value of the maxNumberOfTAsPerTAGroup property.

Returns:

possible object is Integer

setMaxNumberOfTAsPerTAGroup

public SequenceModel setMaxNumberOfTAsPerTAGroup(Integer maxNumberOfTAsPerTAGroup)

Sets the value of the maxNumberOfTAsPerTAGroup property.

Parameters:

maxNumberOfTAsPerTAGroup - allowed object is Integer

getAvgNumberOfTAsPerTAGroup

public Double getAvgNumberOfTAsPerTAGroup()

Gets the value of the avgNumberOfTAsPerTAGroup property.

Returns:

possible object is Double

setAvgNumberOfTAsPerTAGroup

public SequenceModel setAvgNumberOfTAsPerTAGroup(Double avgNumberOfTAsPerTAGroup)

Sets the value of the avgNumberOfTAsPerTAGroup property.

Parameters:

avgNumberOfTAsPerTAGroup - allowed object is Double

getMinimumSupport

public double getMinimumSupport()

Gets the value of the minimumSupport property.

setMinimumSupport

public SequenceModel setMinimumSupport(double minimumSupport)

Sets the value of the minimumSupport property.

getMinimumConfidence

public double getMinimumConfidence()

Gets the value of the minimumConfidence property.

setMinimumConfidence

public SequenceModel 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 SequenceModel 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 SequenceModel setNumberOfItems(int numberOfItems)

Sets the value of the numberOfItems property.

getNumberOfSets

public int getNumberOfSets()

Gets the value of the numberOfSets property.

setNumberOfSets

public SequenceModel setNumberOfSets(int numberOfSets)

Sets the value of the numberOfSets property.

getNumberOfSequences

public int getNumberOfSequences()

Gets the value of the numberOfSequences property.

setNumberOfSequences

public SequenceModel setNumberOfSequences(int numberOfSequences)

Sets the value of the numberOfSequences property.

getNumberOfRules

public int getNumberOfRules()

Gets the value of the numberOfRules property.

setNumberOfRules

public SequenceModel setNumberOfRules(int numberOfRules)

Sets the value of the numberOfRules property.

getTimeWindowWidth

public Integer getTimeWindowWidth()

Gets the value of the timeWindowWidth property.

Returns:

possible object is Integer

setTimeWindowWidth

public SequenceModel setTimeWindowWidth(Integer timeWindowWidth)

Sets the value of the timeWindowWidth property.

Parameters:

timeWindowWidth - allowed object is Integer

getMinimumTime

public Integer getMinimumTime()

Gets the value of the minimumTime property.

Returns:

possible object is Integer

setMinimumTime

public SequenceModel setMinimumTime(Integer minimumTime)

Sets the value of the minimumTime property.

Parameters:

minimumTime - allowed object is Integer

getMaximumTime

public Integer getMaximumTime()

Gets the value of the maximumTime property.

Returns:

possible object is Integer

setMaximumTime

public SequenceModel setMaximumTime(Integer maximumTime)

Sets the value of the maximumTime property.

Parameters:

maximumTime - allowed object is Integer

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public SequenceModel 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 SequenceModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - 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 SequenceModel 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 SequenceModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getConstraints

public Constraints getConstraints()

Gets the value of the constraints property.

Returns:

possible object is Constraints

setConstraints

public SequenceModel setConstraints(Constraints constraints)

Sets the value of the constraints property.

Parameters:

constraints - allowed object is Constraints

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

getSetPredicates

public 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 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 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

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public SequenceModel addExtensions(Extension... extensions)

hasItems

public boolean hasItems()

addItems

public SequenceModel addItems(Item... items)

hasItemsets

public boolean hasItemsets()

addItemsets

public SequenceModel addItemsets(Itemset... itemsets)

hasSetPredicates

public boolean hasSetPredicates()

addSetPredicates

public SequenceModel addSetPredicates(SetPredicate... setPredicates)

hasSequences

public boolean hasSequences()

addSequences

public SequenceModel addSequences(Sequence... sequences)

hasSequenceRules

public boolean hasSequenceRules()

addSequenceRules

public SequenceModel addSequenceRules(SequenceRule... sequenceRules)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable