GeneralRegressionModel (Drools :: PMML - Compiler 6.2.0.CR2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Drools :: PMML - Compiler 6.2.0.CR2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dmg.pmml.pmml_4_2.descr
Class GeneralRegressionModel

java.lang.Object
  org.dmg.pmml.pmml_4_2.descr.GeneralRegressionModel

All Implemented Interfaces:: Serializable

public class GeneralRegressionModel
extends Object
implements Serializable
extends Object
implements Serializable

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}ParameterList"/>
         <element ref="{http://www.dmg.org/PMML-4_2}FactorList" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}CovariateList" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}PPMatrix"/>
         <element ref="{http://www.dmg.org/PMML-4_2}PCovMatrix" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ParamMatrix"/>
         <element ref="{http://www.dmg.org/PMML-4_2}EventValues" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}BaseCumHazardTables" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelVerification" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="targetVariableName" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="modelType" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="regression"/>
             <enumeration value="generalLinear"/>
             <enumeration value="multinomialLogistic"/>
             <enumeration value="ordinalMultinomial"/>
             <enumeration value="generalizedLinear"/>
             <enumeration value="CoxRegression"/>
           </restriction>
         </simpleType>
       </attribute>
       <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="targetReferenceCategory" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="cumulativeLink" type="{http://www.dmg.org/PMML-4_2}CUMULATIVE-LINK-FUNCTION" />
       <attribute name="linkFunction" type="{http://www.dmg.org/PMML-4_2}LINK-FUNCTION" />
       <attribute name="linkParameter" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="trialsVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="trialsValue" type="{http://www.dmg.org/PMML-4_2}INT-NUMBER" />
       <attribute name="distribution">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="binomial"/>
             <enumeration value="gamma"/>
             <enumeration value="igauss"/>
             <enumeration value="negbin"/>
             <enumeration value="normal"/>
             <enumeration value="poisson"/>
             <enumeration value="tweedie"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="distParameter" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="offsetVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="offsetValue" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="modelDF" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="endTimeVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="startTimeVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="subjectIDVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="statusVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="baselineStrataVariable" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary
`protected String`	`algorithmName`
`protected String`	`baselineStrataVariable`
`protected CUMULATIVELINKFUNCTION`	`cumulativeLink`
`protected Double`	`distParameter`
`protected String`	`distribution`
`protected String`	`endTimeVariable`
`protected List<Serializable>`	`extensionsAndParamMatrixesAndPPMatrixes`
`protected MININGFUNCTION`	`functionName`
`protected Boolean`	`isScorable`
`protected LINKFUNCTION`	`linkFunction`
`protected Double`	`linkParameter`
`protected Double`	`modelDF`
`protected String`	`modelName`
`protected String`	`modelType`
`protected Double`	`offsetValue`
`protected String`	`offsetVariable`
`protected String`	`startTimeVariable`
`protected String`	`statusVariable`
`protected String`	`subjectIDVariable`
`protected String`	`targetReferenceCategory`
`protected String`	`targetVariableName`
`protected BigInteger`	`trialsValue`
`protected String`	`trialsVariable`

Constructor Summary
`GeneralRegressionModel()`

Method Summary
`String`	`getAlgorithmName()` Gets the value of the algorithmName property.
`String`	`getBaselineStrataVariable()` Gets the value of the baselineStrataVariable property.
`CUMULATIVELINKFUNCTION`	`getCumulativeLink()` Gets the value of the cumulativeLink property.
`Double`	`getDistParameter()` Gets the value of the distParameter property.
`String`	`getDistribution()` Gets the value of the distribution property.
`String`	`getEndTimeVariable()` Gets the value of the endTimeVariable property.
`List<Serializable>`	`getExtensionsAndParamMatrixesAndPPMatrixes()` Gets the value of the extensionsAndParamMatrixesAndPPMatrixes property.
`MININGFUNCTION`	`getFunctionName()` Gets the value of the functionName property.
`LINKFUNCTION`	`getLinkFunction()` Gets the value of the linkFunction property.
`Double`	`getLinkParameter()` Gets the value of the linkParameter property.
`Double`	`getModelDF()` Gets the value of the modelDF property.
`String`	`getModelName()` Gets the value of the modelName property.
`String`	`getModelType()` Gets the value of the modelType property.
`Double`	`getOffsetValue()` Gets the value of the offsetValue property.
`String`	`getOffsetVariable()` Gets the value of the offsetVariable property.
`String`	`getStartTimeVariable()` Gets the value of the startTimeVariable property.
`String`	`getStatusVariable()` Gets the value of the statusVariable property.
`String`	`getSubjectIDVariable()` Gets the value of the subjectIDVariable property.
`String`	`getTargetReferenceCategory()` Gets the value of the targetReferenceCategory property.
`String`	`getTargetVariableName()` Gets the value of the targetVariableName property.
`BigInteger`	`getTrialsValue()` Gets the value of the trialsValue property.
`String`	`getTrialsVariable()` Gets the value of the trialsVariable property.
`boolean`	`isIsScorable()` Gets the value of the isScorable property.
`void`	`setAlgorithmName(String value)` Sets the value of the algorithmName property.
`void`	`setBaselineStrataVariable(String value)` Sets the value of the baselineStrataVariable property.
`void`	`setCumulativeLink(CUMULATIVELINKFUNCTION value)` Sets the value of the cumulativeLink property.
`void`	`setDistParameter(Double value)` Sets the value of the distParameter property.
`void`	`setDistribution(String value)` Sets the value of the distribution property.
`void`	`setEndTimeVariable(String value)` Sets the value of the endTimeVariable property.
`void`	`setFunctionName(MININGFUNCTION value)` Sets the value of the functionName property.
`void`	`setIsScorable(Boolean value)` Sets the value of the isScorable property.
`void`	`setLinkFunction(LINKFUNCTION value)` Sets the value of the linkFunction property.
`void`	`setLinkParameter(Double value)` Sets the value of the linkParameter property.
`void`	`setModelDF(Double value)` Sets the value of the modelDF property.
`void`	`setModelName(String value)` Sets the value of the modelName property.
`void`	`setModelType(String value)` Sets the value of the modelType property.
`void`	`setOffsetValue(Double value)` Sets the value of the offsetValue property.
`void`	`setOffsetVariable(String value)` Sets the value of the offsetVariable property.
`void`	`setStartTimeVariable(String value)` Sets the value of the startTimeVariable property.
`void`	`setStatusVariable(String value)` Sets the value of the statusVariable property.
`void`	`setSubjectIDVariable(String value)` Sets the value of the subjectIDVariable property.
`void`	`setTargetReferenceCategory(String value)` Sets the value of the targetReferenceCategory property.
`void`	`setTargetVariableName(String value)` Sets the value of the targetVariableName property.
`void`	`setTrialsValue(BigInteger value)` Sets the value of the trialsValue property.
`void`	`setTrialsVariable(String value)` Sets the value of the trialsVariable property.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

extensionsAndParamMatrixesAndPPMatrixes

protected List<Serializable> extensionsAndParamMatrixesAndPPMatrixes

targetVariableName

protected String targetVariableName

modelType

protected String modelType

modelName

protected String modelName

functionName

protected MININGFUNCTION functionName

algorithmName

protected String algorithmName

targetReferenceCategory

protected String targetReferenceCategory

cumulativeLink

protected CUMULATIVELINKFUNCTION cumulativeLink

linkFunction

protected LINKFUNCTION linkFunction

linkParameter

protected Double linkParameter

trialsVariable

protected String trialsVariable

trialsValue

protected BigInteger trialsValue

distribution

protected String distribution

distParameter

protected Double distParameter

offsetVariable

protected String offsetVariable

offsetValue

protected Double offsetValue

modelDF

protected Double modelDF

endTimeVariable

protected String endTimeVariable

startTimeVariable

protected String startTimeVariable

subjectIDVariable

protected String subjectIDVariable

statusVariable

protected String statusVariable

baselineStrataVariable

protected String baselineStrataVariable

isScorable

protected Boolean isScorable

Constructor Detail

GeneralRegressionModel

public GeneralRegressionModel()

Method Detail

getExtensionsAndParamMatrixesAndPPMatrixes

public List<Serializable> getExtensionsAndParamMatrixesAndPPMatrixes()

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

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

    getExtensionsAndParamMatrixesAndPPMatrixes().add(newItem);

Objects of the following type(s) are allowed in the list Targets CovariateList Output MiningSchema EventValues BaseCumHazardTables FactorList ModelVerification PCovMatrix ParamMatrix ModelStats ParameterList LocalTransformations PPMatrix Extension ModelExplanation

getTargetVariableName

public String getTargetVariableName()

Gets the value of the targetVariableName property.

Returns:: possible object is String

setTargetVariableName

public void setTargetVariableName(String value)

Sets the value of the targetVariableName property.

Parameters:: value - allowed object is String

getModelType

public String getModelType()

Gets the value of the modelType property.

Returns:: possible object is String

setModelType

public void setModelType(String value)

Sets the value of the modelType property.

Parameters:: value - allowed object is String

getModelName

public String getModelName()

Gets the value of the modelName property.

Returns:: possible object is String

setModelName

public void setModelName(String value)

Sets the value of the modelName property.

Parameters:: value - allowed object is String

getFunctionName

public MININGFUNCTION getFunctionName()

Gets the value of the functionName property.

Returns:: possible object is MININGFUNCTION

setFunctionName

public void setFunctionName(MININGFUNCTION value)

Sets the value of the functionName property.

Parameters:: value - allowed object is MININGFUNCTION

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Returns:: possible object is String

setAlgorithmName

public void setAlgorithmName(String value)

Sets the value of the algorithmName property.

Parameters:: value - allowed object is String

getTargetReferenceCategory

public String getTargetReferenceCategory()

Gets the value of the targetReferenceCategory property.

Returns:: possible object is String

setTargetReferenceCategory

public void setTargetReferenceCategory(String value)

Sets the value of the targetReferenceCategory property.

Parameters:: value - allowed object is String

getCumulativeLink

public CUMULATIVELINKFUNCTION getCumulativeLink()

Gets the value of the cumulativeLink property.

Returns:: possible object is CUMULATIVELINKFUNCTION

setCumulativeLink

public void setCumulativeLink(CUMULATIVELINKFUNCTION value)

Sets the value of the cumulativeLink property.

Parameters:: value - allowed object is CUMULATIVELINKFUNCTION

getLinkFunction

public LINKFUNCTION getLinkFunction()

Gets the value of the linkFunction property.

Returns:: possible object is LINKFUNCTION

setLinkFunction

public void setLinkFunction(LINKFUNCTION value)

Sets the value of the linkFunction property.

Parameters:: value - allowed object is LINKFUNCTION

getLinkParameter

public Double getLinkParameter()

Gets the value of the linkParameter property.

Returns:: possible object is Double

setLinkParameter

public void setLinkParameter(Double value)

Sets the value of the linkParameter property.

Parameters:: value - allowed object is Double

getTrialsVariable

public String getTrialsVariable()

Gets the value of the trialsVariable property.

Returns:: possible object is String

setTrialsVariable

public void setTrialsVariable(String value)

Sets the value of the trialsVariable property.

Parameters:: value - allowed object is String

getTrialsValue

public BigInteger getTrialsValue()

Gets the value of the trialsValue property.

Returns:: possible object is BigInteger

setTrialsValue

public void setTrialsValue(BigInteger value)

Sets the value of the trialsValue property.

Parameters:: value - allowed object is BigInteger

getDistribution

public String getDistribution()

Gets the value of the distribution property.

Returns:: possible object is String

setDistribution

public void setDistribution(String value)

Sets the value of the distribution property.

Parameters:: value - allowed object is String

getDistParameter

public Double getDistParameter()

Gets the value of the distParameter property.

Returns:: possible object is Double

setDistParameter

public void setDistParameter(Double value)

Sets the value of the distParameter property.

Parameters:: value - allowed object is Double

getOffsetVariable

public String getOffsetVariable()

Gets the value of the offsetVariable property.

Returns:: possible object is String

setOffsetVariable

public void setOffsetVariable(String value)

Sets the value of the offsetVariable property.

Parameters:: value - allowed object is String

getOffsetValue

public Double getOffsetValue()

Gets the value of the offsetValue property.

Returns:: possible object is Double

setOffsetValue

public void setOffsetValue(Double value)

Sets the value of the offsetValue property.

Parameters:: value - allowed object is Double

getModelDF

public Double getModelDF()

Gets the value of the modelDF property.

Returns:: possible object is Double

setModelDF

public void setModelDF(Double value)

Sets the value of the modelDF property.

Parameters:: value - allowed object is Double

getEndTimeVariable

public String getEndTimeVariable()

Gets the value of the endTimeVariable property.

Returns:: possible object is String

setEndTimeVariable

public void setEndTimeVariable(String value)

Sets the value of the endTimeVariable property.

Parameters:: value - allowed object is String

getStartTimeVariable

public String getStartTimeVariable()

Gets the value of the startTimeVariable property.

Returns:: possible object is String

setStartTimeVariable

public void setStartTimeVariable(String value)

Sets the value of the startTimeVariable property.

Parameters:: value - allowed object is String

getSubjectIDVariable

public String getSubjectIDVariable()

Gets the value of the subjectIDVariable property.

Returns:: possible object is String

setSubjectIDVariable

public void setSubjectIDVariable(String value)

Sets the value of the subjectIDVariable property.

Parameters:: value - allowed object is String

getStatusVariable

public String getStatusVariable()

Gets the value of the statusVariable property.

Returns:: possible object is String

setStatusVariable

public void setStatusVariable(String value)

Sets the value of the statusVariable property.

Parameters:: value - allowed object is String

getBaselineStrataVariable

public String getBaselineStrataVariable()

Gets the value of the baselineStrataVariable property.

Returns:: possible object is String

setBaselineStrataVariable

public void setBaselineStrataVariable(String value)

Sets the value of the baselineStrataVariable property.

Parameters:: value - allowed object is String

isIsScorable

public boolean isIsScorable()

Gets the value of the isScorable property.

Returns:: possible object is Boolean

setIsScorable

public void setIsScorable(Boolean value)

Sets the value of the isScorable property.

Parameters:: value - allowed object is Boolean