org.dmg.pmml

Class TextModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.TextModel

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class TextModel
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}TextDictionary"/>
         <element ref="{http://www.dmg.org/PMML-4_2}TextCorpus"/>
         <element ref="{http://www.dmg.org/PMML-4_2}DocumentTermMatrix"/>
         <element ref="{http://www.dmg.org/PMML-4_2}TextModelNormalization" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}TextModelSimiliarity" minOccurs="0"/>
         <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="numberOfTerms" use="required" type="{http://www.w3.org/2001/XMLSchema}integer" />
       <attribute name="numberOfDocuments" use="required" type="{http://www.w3.org/2001/XMLSchema}integer" />
       <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 DocumentTermMatrix	documentTermMatrix
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 java.lang.Integer	numberOfDocuments
protected java.lang.Integer	numberOfTerms
protected Output	output
protected java.lang.Boolean	scorable
protected Targets	targets
protected TextCorpus	textCorpus
protected TextDictionary	textDictionary
protected TextModelNormalization	textModelNormalization
protected TextModelSimiliarity	textModelSimiliarity

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
DocumentTermMatrix	getDocumentTermMatrix() Gets the value of the documentTermMatrix 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.
java.lang.Integer	getNumberOfDocuments() Gets the value of the numberOfDocuments property.
java.lang.Integer	getNumberOfTerms() Gets the value of the numberOfTerms property.
Output	getOutput() Gets the value of the output property.
Targets	getTargets() Gets the value of the targets property.
TextCorpus	getTextCorpus() Gets the value of the textCorpus property.
TextDictionary	getTextDictionary() Gets the value of the textDictionary property.
TextModelNormalization	getTextModelNormalization() Gets the value of the textModelNormalization property.
TextModelSimiliarity	getTextModelSimiliarity() Gets the value of the textModelSimiliarity 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	setDocumentTermMatrix(DocumentTermMatrix value) Sets the value of the documentTermMatrix 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	setNumberOfDocuments(java.lang.Integer value) Sets the value of the numberOfDocuments property.
void	setNumberOfTerms(java.lang.Integer value) Sets the value of the numberOfTerms property.
void	setOutput(Output value) Sets the value of the output 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.
void	setTextCorpus(TextCorpus value) Sets the value of the textCorpus property.
void	setTextDictionary(TextDictionary value) Sets the value of the textDictionary property.
void	setTextModelNormalization(TextModelNormalization value) Sets the value of the textModelNormalization property.
void	setTextModelSimiliarity(TextModelSimiliarity value) Sets the value of the textModelSimiliarity property.
TextModel	withAlgorithmName(java.lang.String value)
TextModel	withDocumentTermMatrix(DocumentTermMatrix value)
TextModel	withExtensions(java.util.Collection<Extension> values)
TextModel	withExtensions(Extension... values)
TextModel	withFunctionName(MiningFunctionType value)
TextModel	withLocalTransformations(LocalTransformations value)
TextModel	withMiningSchema(MiningSchema value)
TextModel	withModelExplanation(ModelExplanation value)
TextModel	withModelName(java.lang.String value)
TextModel	withModelStats(ModelStats value)
TextModel	withModelVerification(ModelVerification value)
TextModel	withNumberOfDocuments(java.lang.Integer value)
TextModel	withNumberOfTerms(java.lang.Integer value)
TextModel	withOutput(Output value)
TextModel	withScorable(java.lang.Boolean value)
TextModel	withTargets(Targets value)
TextModel	withTextCorpus(TextCorpus value)
TextModel	withTextDictionary(TextDictionary value)
TextModel	withTextModelNormalization(TextModelNormalization value)
TextModel	withTextModelSimiliarity(TextModelSimiliarity 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

numberOfTerms

protected java.lang.Integer numberOfTerms

numberOfDocuments

protected java.lang.Integer numberOfDocuments

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

textDictionary

protected TextDictionary textDictionary

textCorpus

protected TextCorpus textCorpus

documentTermMatrix

protected DocumentTermMatrix documentTermMatrix

textModelNormalization

protected TextModelNormalization textModelNormalization

textModelSimiliarity

protected TextModelSimiliarity textModelSimiliarity

modelVerification

protected ModelVerification modelVerification

Constructor Detail

TextModel

public TextModel()

TextModel

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

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

getNumberOfTerms

public java.lang.Integer getNumberOfTerms()

Gets the value of the numberOfTerms property.

Returns:

possible object is String

setNumberOfTerms

public void setNumberOfTerms(java.lang.Integer value)

Sets the value of the numberOfTerms property.

Parameters:

value - allowed object is String

getNumberOfDocuments

public java.lang.Integer getNumberOfDocuments()

Gets the value of the numberOfDocuments property.

Returns:

possible object is String

setNumberOfDocuments

public void setNumberOfDocuments(java.lang.Integer value)

Sets the value of the numberOfDocuments property.

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

getTextDictionary

public TextDictionary getTextDictionary()

Gets the value of the textDictionary property.

Returns:

possible object is TextDictionary

setTextDictionary

public void setTextDictionary(TextDictionary value)

Sets the value of the textDictionary property.

Parameters:

value - allowed object is TextDictionary

getTextCorpus

public TextCorpus getTextCorpus()

Gets the value of the textCorpus property.

Returns:

possible object is TextCorpus

setTextCorpus

public void setTextCorpus(TextCorpus value)

Sets the value of the textCorpus property.

Parameters:

value - allowed object is TextCorpus

getDocumentTermMatrix

public DocumentTermMatrix getDocumentTermMatrix()

Gets the value of the documentTermMatrix property.

Returns:

possible object is DocumentTermMatrix

setDocumentTermMatrix

public void setDocumentTermMatrix(DocumentTermMatrix value)

Sets the value of the documentTermMatrix property.

Parameters:

value - allowed object is DocumentTermMatrix

getTextModelNormalization

public TextModelNormalization getTextModelNormalization()

Gets the value of the textModelNormalization property.

Returns:

possible object is TextModelNormalization

setTextModelNormalization

public void setTextModelNormalization(TextModelNormalization value)

Sets the value of the textModelNormalization property.

Parameters:

value - allowed object is TextModelNormalization

getTextModelSimiliarity

public TextModelSimiliarity getTextModelSimiliarity()

Gets the value of the textModelSimiliarity property.

Returns:

possible object is TextModelSimiliarity

setTextModelSimiliarity

public void setTextModelSimiliarity(TextModelSimiliarity value)

Sets the value of the textModelSimiliarity property.

Parameters:

value - allowed object is TextModelSimiliarity

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

withFunctionName

public TextModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public TextModel withAlgorithmName(java.lang.String value)

withNumberOfTerms

public TextModel withNumberOfTerms(java.lang.Integer value)

withNumberOfDocuments

public TextModel withNumberOfDocuments(java.lang.Integer value)

withScorable

public TextModel withScorable(java.lang.Boolean value)

withExtensions

public TextModel withExtensions(Extension... values)

withExtensions

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

withMiningSchema

public TextModel withMiningSchema(MiningSchema value)

withOutput

public TextModel withOutput(Output value)

withModelStats

public TextModel withModelStats(ModelStats value)

withModelExplanation

public TextModel withModelExplanation(ModelExplanation value)

withTargets

public TextModel withTargets(Targets value)

withLocalTransformations

public TextModel withLocalTransformations(LocalTransformations value)

withTextDictionary

public TextModel withTextDictionary(TextDictionary value)

withTextCorpus

public TextModel withTextCorpus(TextCorpus value)

withDocumentTermMatrix

public TextModel withDocumentTermMatrix(DocumentTermMatrix value)

withTextModelNormalization

public TextModel withTextModelNormalization(TextModelNormalization value)

withTextModelSimiliarity

public TextModel withTextModelSimiliarity(TextModelSimiliarity value)

withModelVerification

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