Package org.dmg.pmml.text

Class TextModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.text.TextModel

All Implemented Interfaces:

java.io.Serializable, HasExtensions<TextModel>, HasLocator, Visitable

public class TextModel
extends Model
implements HasExtensions<TextModel>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TextModel()
TextModel(MiningFunction miningFunction, java.lang.Integer numberOfTerms, java.lang.Integer numberOfDocuments, MiningSchema miningSchema, TextDictionary textDictionary, TextCorpus textCorpus, DocumentTermMatrix documentTermMatrix)

Method Summary

Modifier and Type	Method	Description
VisitorAction	accept(Visitor visitor)
TextModel	addExtensions(Extension... extensions)
java.lang.String	getAlgorithmName()
DocumentTermMatrix	getDocumentTermMatrix()
java.util.List<Extension>	getExtensions()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
ModelExplanation	getModelExplanation()
java.lang.String	getModelName()
ModelStats	getModelStats()
ModelVerification	getModelVerification()
java.lang.Integer	getNumberOfDocuments()
java.lang.Integer	getNumberOfTerms()
Output	getOutput()
Targets	getTargets()
TextCorpus	getTextCorpus()
TextDictionary	getTextDictionary()
TextModelNormalization	getTextModelNormalization()
TextModelSimiliarity	getTextModelSimiliarity()
boolean	hasExtensions()
boolean	isScorable()
DocumentTermMatrix	requireDocumentTermMatrix()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
java.lang.Integer	requireNumberOfDocuments()
java.lang.Integer	requireNumberOfTerms()
TextCorpus	requireTextCorpus()
TextDictionary	requireTextDictionary()
TextModel	setAlgorithmName(java.lang.String algorithmName)
TextModel	setDocumentTermMatrix(DocumentTermMatrix documentTermMatrix)
TextModel	setLocalTransformations(LocalTransformations localTransformations)
TextModel	setMathContext(MathContext mathContext)
TextModel	setMiningFunction(MiningFunction miningFunction)
TextModel	setMiningSchema(MiningSchema miningSchema)
TextModel	setModelExplanation(ModelExplanation modelExplanation)
TextModel	setModelName(java.lang.String modelName)
TextModel	setModelStats(ModelStats modelStats)
TextModel	setModelVerification(ModelVerification modelVerification)
TextModel	setNumberOfDocuments(java.lang.Integer numberOfDocuments)
TextModel	setNumberOfTerms(java.lang.Integer numberOfTerms)
TextModel	setOutput(Output output)
TextModel	setScorable(java.lang.Boolean scorable)
TextModel	setTargets(Targets targets)
TextModel	setTextCorpus(TextCorpus textCorpus)
TextModel	setTextDictionary(TextDictionary textDictionary)
TextModel	setTextModelNormalization(TextModelNormalization textModelNormalization)
TextModel	setTextModelSimiliarity(TextModelSimiliarity textModelSimiliarity)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, getSchemaVersion, getSchemaVersion, hasLocator, setLocator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextModel

public TextModel()

TextModel

public TextModel(MiningFunction miningFunction,
                 java.lang.Integer numberOfTerms,
                 java.lang.Integer numberOfDocuments,
                 MiningSchema miningSchema,
                 TextDictionary textDictionary,
                 TextCorpus textCorpus,
                 DocumentTermMatrix documentTermMatrix)

Method Detail

getModelName

public java.lang.String getModelName()

Specified by:

getModelName in class Model

setModelName

public TextModel setModelName(java.lang.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 TextModel setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public java.lang.String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public TextModel setAlgorithmName(java.lang.String algorithmName)

Specified by:

setAlgorithmName in class Model

requireNumberOfTerms

public java.lang.Integer requireNumberOfTerms()

getNumberOfTerms

public java.lang.Integer getNumberOfTerms()

setNumberOfTerms

public TextModel setNumberOfTerms(java.lang.Integer numberOfTerms)

requireNumberOfDocuments

public java.lang.Integer requireNumberOfDocuments()

getNumberOfDocuments

public java.lang.Integer getNumberOfDocuments()

setNumberOfDocuments

public TextModel setNumberOfDocuments(java.lang.Integer numberOfDocuments)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public TextModel setScorable(java.lang.Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public TextModel setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<TextModel>

getExtensions

public java.util.List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<TextModel>

addExtensions

public TextModel addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<TextModel>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public TextModel setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Overrides:

getOutput in class Model

setOutput

public TextModel setOutput(Output output)

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public TextModel setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getModelExplanation

public ModelExplanation getModelExplanation()

Overrides:

getModelExplanation in class Model

setModelExplanation

public TextModel setModelExplanation(ModelExplanation modelExplanation)

Overrides:

setModelExplanation in class Model

getTargets

public Targets getTargets()

Overrides:

getTargets in class Model

setTargets

public TextModel setTargets(Targets targets)

Overrides:

setTargets in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public TextModel setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in class Model

requireTextDictionary

public TextDictionary requireTextDictionary()

getTextDictionary

public TextDictionary getTextDictionary()

setTextDictionary

public TextModel setTextDictionary(TextDictionary textDictionary)

requireTextCorpus

public TextCorpus requireTextCorpus()

getTextCorpus

public TextCorpus getTextCorpus()

setTextCorpus

public TextModel setTextCorpus(TextCorpus textCorpus)

requireDocumentTermMatrix

public DocumentTermMatrix requireDocumentTermMatrix()

getDocumentTermMatrix

public DocumentTermMatrix getDocumentTermMatrix()

setDocumentTermMatrix

public TextModel setDocumentTermMatrix(DocumentTermMatrix documentTermMatrix)

getTextModelNormalization

public TextModelNormalization getTextModelNormalization()

setTextModelNormalization

public TextModel setTextModelNormalization(TextModelNormalization textModelNormalization)

getTextModelSimiliarity

public TextModelSimiliarity getTextModelSimiliarity()

setTextModelSimiliarity

public TextModel setTextModelSimiliarity(TextModelSimiliarity textModelSimiliarity)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public TextModel setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable