org.dmg.pmml

Class RuleSetModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.RuleSetModel

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class RuleSetModel
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}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}RuleSet"/>
         <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="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<Extension>	extensions
protected MiningFunctionType	functionName
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected ModelExplanation	modelExplanation
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected Output	output
protected RuleSet	ruleSet
protected java.lang.Boolean	scorable
protected Targets	targets

Constructor Summary

Constructors

Constructor and Description
RuleSetModel()
RuleSetModel(MiningFunctionType functionName, MiningSchema miningSchema, RuleSet ruleSet)

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<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations 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.
Output	getOutput() Gets the value of the output property.
RuleSet	getRuleSet() Gets the value of the ruleSet property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setModelExplanation(ModelExplanation value) 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	setOutput(Output value) Sets the value of the output property.
void	setRuleSet(RuleSet value) Sets the value of the ruleSet property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets value) Sets the value of the targets property.
RuleSetModel	withAlgorithmName(java.lang.String value)
RuleSetModel	withExtensions(java.util.Collection<Extension> values)
RuleSetModel	withExtensions(Extension... values)
RuleSetModel	withFunctionName(MiningFunctionType value)
RuleSetModel	withLocalTransformations(LocalTransformations value)
RuleSetModel	withMiningSchema(MiningSchema value)
RuleSetModel	withModelExplanation(ModelExplanation value)
RuleSetModel	withModelName(java.lang.String value)
RuleSetModel	withModelStats(ModelStats value)
RuleSetModel	withModelVerification(ModelVerification value)
RuleSetModel	withOutput(Output value)
RuleSetModel	withRuleSet(RuleSet value)
RuleSetModel	withScorable(java.lang.Boolean value)
RuleSetModel	withTargets(Targets 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

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

modelExplanation

protected ModelExplanation modelExplanation

targets

protected Targets targets

localTransformations

protected LocalTransformations localTransformations

ruleSet

protected RuleSet ruleSet

modelVerification

protected ModelVerification modelVerification

Constructor Detail

RuleSetModel

public RuleSetModel()

RuleSetModel

public RuleSetModel(MiningFunctionType functionName,
            MiningSchema miningSchema,
            RuleSet ruleSet)

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

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

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Parameters:

value - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public void setTargets(Targets value)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Parameters:

value - allowed object is Targets

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

getRuleSet

public RuleSet getRuleSet()

Gets the value of the ruleSet property.

Returns:

possible object is RuleSet

setRuleSet

public void setRuleSet(RuleSet value)

Sets the value of the ruleSet property.

Parameters:

value - allowed object is RuleSet

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 RuleSetModel withModelName(java.lang.String value)

withFunctionName

public RuleSetModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public RuleSetModel withAlgorithmName(java.lang.String value)

withScorable

public RuleSetModel withScorable(java.lang.Boolean value)

withExtensions

public RuleSetModel withExtensions(Extension... values)

withExtensions

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

withMiningSchema

public RuleSetModel withMiningSchema(MiningSchema value)

withOutput

public RuleSetModel withOutput(Output value)

withModelStats

public RuleSetModel withModelStats(ModelStats value)

withModelExplanation

public RuleSetModel withModelExplanation(ModelExplanation value)

withTargets

public RuleSetModel withTargets(Targets value)

withLocalTransformations

public RuleSetModel withLocalTransformations(LocalTransformations value)

withRuleSet

public RuleSetModel withRuleSet(RuleSet value)

withModelVerification

public RuleSetModel withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable