org.dmg.pmml.general_regression

Class GeneralRegressionModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.general_regression.GeneralRegressionModel

All Implemented Interfaces:

Serializable, HasExtensions<GeneralRegressionModel>, HasLocator, Visitable

public class GeneralRegressionModel
extends Model
implements HasExtensions<GeneralRegressionModel>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneralRegressionModel.CumulativeLinkFunction
static class	GeneralRegressionModel.Distribution
static class	GeneralRegressionModel.LinkFunction
static class	GeneralRegressionModel.ModelType

Constructor Summary

Constructors

Constructor and Description
GeneralRegressionModel()
GeneralRegressionModel(GeneralRegressionModel.ModelType modelType, MiningFunction miningFunction, MiningSchema miningSchema, ParameterList parameterList, PPMatrix ppMatrix, ParamMatrix paramMatrix)

Method Summary

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
GeneralRegressionModel	addExtensions(Extension... extensions)
String	getAlgorithmName()
BaseCumHazardTables	getBaseCumHazardTables()
String	getBaselineStrataVariable()
CovariateList	getCovariateList()
GeneralRegressionModel.CumulativeLinkFunction	getCumulativeLinkFunction()
Number	getDistParameter()
GeneralRegressionModel.Distribution	getDistribution()
String	getEndTimeVariable()
EventValues	getEventValues()
List<Extension>	getExtensions()
FactorList	getFactorList()
GeneralRegressionModel.LinkFunction	getLinkFunction()
Number	getLinkParameter()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
Number	getModelDF()
ModelExplanation	getModelExplanation()
String	getModelName()
ModelStats	getModelStats()
GeneralRegressionModel.ModelType	getModelType()
ModelVerification	getModelVerification()
Number	getOffsetValue()
String	getOffsetVariable()
Output	getOutput()
ParameterList	getParameterList()
ParamMatrix	getParamMatrix()
PCovMatrix	getPCovMatrix()
PPMatrix	getPPMatrix()
String	getStartTimeVariable()
String	getStatusVariable()
String	getSubjectIDVariable()
Object	getTargetReferenceCategory()
Targets	getTargets()
String	getTargetVariable()
Integer	getTrialsValue()
String	getTrialsVariable()
boolean	hasExtensions()
boolean	isScorable()
BaseCumHazardTables	requireBaseCumHazardTables()
GeneralRegressionModel.CumulativeLinkFunction	requireCumulativeLinkFunction()
Number	requireDistParameter()
GeneralRegressionModel.LinkFunction	requireLinkFunction()
Number	requireLinkParameter()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
GeneralRegressionModel.ModelType	requireModelType()
ParameterList	requireParameterList()
ParamMatrix	requireParamMatrix()
PPMatrix	requirePPMatrix()
GeneralRegressionModel	setAlgorithmName(String algorithmName)
GeneralRegressionModel	setBaseCumHazardTables(BaseCumHazardTables baseCumHazardTables)
GeneralRegressionModel	setBaselineStrataVariable(String baselineStrataVariable)
GeneralRegressionModel	setCovariateList(CovariateList covariateList)
GeneralRegressionModel	setCumulativeLinkFunction(GeneralRegressionModel.CumulativeLinkFunction cumulativeLinkFunction)
GeneralRegressionModel	setDistParameter(Number distParameter)
GeneralRegressionModel	setDistribution(GeneralRegressionModel.Distribution distribution)
GeneralRegressionModel	setEndTimeVariable(String endTimeVariable)
GeneralRegressionModel	setEventValues(EventValues eventValues)
GeneralRegressionModel	setFactorList(FactorList factorList)
GeneralRegressionModel	setLinkFunction(GeneralRegressionModel.LinkFunction linkFunction)
GeneralRegressionModel	setLinkParameter(Number linkParameter)
GeneralRegressionModel	setLocalTransformations(LocalTransformations localTransformations)
GeneralRegressionModel	setMathContext(MathContext mathContext)
GeneralRegressionModel	setMiningFunction(MiningFunction miningFunction)
GeneralRegressionModel	setMiningSchema(MiningSchema miningSchema)
GeneralRegressionModel	setModelDF(Number modelDF)
GeneralRegressionModel	setModelExplanation(ModelExplanation modelExplanation)
GeneralRegressionModel	setModelName(String modelName)
GeneralRegressionModel	setModelStats(ModelStats modelStats)
GeneralRegressionModel	setModelType(GeneralRegressionModel.ModelType modelType)
GeneralRegressionModel	setModelVerification(ModelVerification modelVerification)
GeneralRegressionModel	setOffsetValue(Number offsetValue)
GeneralRegressionModel	setOffsetVariable(String offsetVariable)
GeneralRegressionModel	setOutput(Output output)
GeneralRegressionModel	setParameterList(ParameterList parameterList)
GeneralRegressionModel	setParamMatrix(ParamMatrix paramMatrix)
GeneralRegressionModel	setPCovMatrix(PCovMatrix pCovMatrix)
GeneralRegressionModel	setPPMatrix(PPMatrix ppMatrix)
GeneralRegressionModel	setScorable(Boolean scorable)
GeneralRegressionModel	setStartTimeVariable(String startTimeVariable)
GeneralRegressionModel	setStatusVariable(String statusVariable)
GeneralRegressionModel	setSubjectIDVariable(String subjectIDVariable)
GeneralRegressionModel	setTargetReferenceCategory(Object targetReferenceCategory)
GeneralRegressionModel	setTargets(Targets targets)
GeneralRegressionModel	setTargetVariable(String targetVariable)
GeneralRegressionModel	setTrialsValue(Integer trialsValue)
GeneralRegressionModel	setTrialsVariable(String trialsVariable)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, hasLocator, 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

GeneralRegressionModel

public GeneralRegressionModel()

GeneralRegressionModel

public GeneralRegressionModel(GeneralRegressionModel.ModelType modelType,
                              MiningFunction miningFunction,
                              MiningSchema miningSchema,
                              ParameterList parameterList,
                              PPMatrix ppMatrix,
                              ParamMatrix paramMatrix)

Method Detail

getTargetVariable

public String getTargetVariable()

setTargetVariable

public GeneralRegressionModel setTargetVariable(String targetVariable)

requireModelType

public GeneralRegressionModel.ModelType requireModelType()

getModelType

public GeneralRegressionModel.ModelType getModelType()

setModelType

public GeneralRegressionModel setModelType(GeneralRegressionModel.ModelType modelType)

getModelName

public String getModelName()

Specified by:

getModelName in class Model

setModelName

public GeneralRegressionModel setModelName(String modelName)

Specified by:

setModelName in class Model

requireMiningFunction

public MiningFunction requireMiningFunction()

Specified by:

requireMiningFunction in class Model

getMiningFunction

public MiningFunction getMiningFunction()

Specified by:

getMiningFunction in class Model

setMiningFunction

public GeneralRegressionModel setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public GeneralRegressionModel setAlgorithmName(String algorithmName)

Specified by:

setAlgorithmName in class Model

getTargetReferenceCategory

public Object getTargetReferenceCategory()

setTargetReferenceCategory

public GeneralRegressionModel setTargetReferenceCategory(Object targetReferenceCategory)

requireCumulativeLinkFunction

public GeneralRegressionModel.CumulativeLinkFunction requireCumulativeLinkFunction()

getCumulativeLinkFunction

public GeneralRegressionModel.CumulativeLinkFunction getCumulativeLinkFunction()

setCumulativeLinkFunction

public GeneralRegressionModel setCumulativeLinkFunction(GeneralRegressionModel.CumulativeLinkFunction cumulativeLinkFunction)

requireLinkFunction

public GeneralRegressionModel.LinkFunction requireLinkFunction()

getLinkFunction

public GeneralRegressionModel.LinkFunction getLinkFunction()

setLinkFunction

public GeneralRegressionModel setLinkFunction(GeneralRegressionModel.LinkFunction linkFunction)

requireLinkParameter

public Number requireLinkParameter()

getLinkParameter

public Number getLinkParameter()

setLinkParameter

public GeneralRegressionModel setLinkParameter(Number linkParameter)

getTrialsVariable

public String getTrialsVariable()

setTrialsVariable

public GeneralRegressionModel setTrialsVariable(String trialsVariable)

getTrialsValue

public Integer getTrialsValue()

setTrialsValue

public GeneralRegressionModel setTrialsValue(Integer trialsValue)

getDistribution

public GeneralRegressionModel.Distribution getDistribution()

setDistribution

public GeneralRegressionModel setDistribution(GeneralRegressionModel.Distribution distribution)

requireDistParameter

public Number requireDistParameter()

getDistParameter

public Number getDistParameter()

setDistParameter

public GeneralRegressionModel setDistParameter(Number distParameter)

getOffsetVariable

public String getOffsetVariable()

setOffsetVariable

public GeneralRegressionModel setOffsetVariable(String offsetVariable)

getOffsetValue

public Number getOffsetValue()

setOffsetValue

public GeneralRegressionModel setOffsetValue(Number offsetValue)

getModelDF

public Number getModelDF()

setModelDF

public GeneralRegressionModel setModelDF(Number modelDF)

getEndTimeVariable

public String getEndTimeVariable()

setEndTimeVariable

public GeneralRegressionModel setEndTimeVariable(String endTimeVariable)

getStartTimeVariable

public String getStartTimeVariable()

setStartTimeVariable

public GeneralRegressionModel setStartTimeVariable(String startTimeVariable)

getSubjectIDVariable

public String getSubjectIDVariable()

setSubjectIDVariable

public GeneralRegressionModel setSubjectIDVariable(String subjectIDVariable)

getStatusVariable

public String getStatusVariable()

setStatusVariable

public GeneralRegressionModel setStatusVariable(String statusVariable)

getBaselineStrataVariable

public String getBaselineStrataVariable()

setBaselineStrataVariable

public GeneralRegressionModel setBaselineStrataVariable(String baselineStrataVariable)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public GeneralRegressionModel setScorable(Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public GeneralRegressionModel setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<GeneralRegressionModel>

getExtensions

public List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<GeneralRegressionModel>

addExtensions

public GeneralRegressionModel addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<GeneralRegressionModel>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public GeneralRegressionModel setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Overrides:

getOutput in class Model

setOutput

public GeneralRegressionModel setOutput(Output output)

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public GeneralRegressionModel setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getModelExplanation

public ModelExplanation getModelExplanation()

Overrides:

getModelExplanation in class Model

setModelExplanation

public GeneralRegressionModel setModelExplanation(ModelExplanation modelExplanation)

Overrides:

setModelExplanation in class Model

getTargets

public Targets getTargets()

Overrides:

getTargets in class Model

setTargets

public GeneralRegressionModel setTargets(Targets targets)

Overrides:

setTargets in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public GeneralRegressionModel setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in class Model

requireParameterList

public ParameterList requireParameterList()

getParameterList

public ParameterList getParameterList()

setParameterList

public GeneralRegressionModel setParameterList(ParameterList parameterList)

getFactorList

public FactorList getFactorList()

setFactorList

public GeneralRegressionModel setFactorList(FactorList factorList)

getCovariateList

public CovariateList getCovariateList()

setCovariateList

public GeneralRegressionModel setCovariateList(CovariateList covariateList)

requirePPMatrix

public PPMatrix requirePPMatrix()

getPPMatrix

public PPMatrix getPPMatrix()

setPPMatrix

public GeneralRegressionModel setPPMatrix(PPMatrix ppMatrix)

getPCovMatrix

public PCovMatrix getPCovMatrix()

setPCovMatrix

public GeneralRegressionModel setPCovMatrix(PCovMatrix pCovMatrix)

requireParamMatrix

public ParamMatrix requireParamMatrix()

getParamMatrix

public ParamMatrix getParamMatrix()

setParamMatrix

public GeneralRegressionModel setParamMatrix(ParamMatrix paramMatrix)

getEventValues

public EventValues getEventValues()

setEventValues

public GeneralRegressionModel setEventValues(EventValues eventValues)

requireBaseCumHazardTables

public BaseCumHazardTables requireBaseCumHazardTables()

getBaseCumHazardTables

public BaseCumHazardTables getBaseCumHazardTables()

setBaseCumHazardTables

public GeneralRegressionModel setBaseCumHazardTables(BaseCumHazardTables baseCumHazardTables)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public GeneralRegressionModel setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable