org.dmg.pmml.pmml_4_2.descr

Class TextModel

java.lang.Object

org.dmg.pmml.pmml_4_2.descr.TextModel

All Implemented Interfaces:

Serializable

public class TextModel
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}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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" 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 String	algorithmName
protected List<Serializable>	extensionsAndDocumentTermMatrixesAndTextCorpuses
protected MININGFUNCTION	functionName
protected Boolean	isScorable
protected String	modelName
protected BigInteger	numberOfDocuments
protected BigInteger	numberOfTerms

Constructor Summary

Constructors

Constructor and Description
TextModel()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlgorithmName() Gets the value of the algorithmName property.
List<Serializable>	getExtensionsAndDocumentTermMatrixesAndTextCorpuses() Gets the value of the extensionsAndDocumentTermMatrixesAndTextCorpuses property.
MININGFUNCTION	getFunctionName() Gets the value of the functionName property.
String	getModelName() Gets the value of the modelName property.
BigInteger	getNumberOfDocuments() Gets the value of the numberOfDocuments property.
BigInteger	getNumberOfTerms() Gets the value of the numberOfTerms property.
boolean	isIsScorable() Gets the value of the isScorable property.
void	setAlgorithmName(String value) Sets the value of the algorithmName property.
void	setFunctionName(MININGFUNCTION value) Sets the value of the functionName property.
void	setIsScorable(Boolean value) Sets the value of the isScorable property.
void	setModelName(String value) Sets the value of the modelName property.
void	setNumberOfDocuments(BigInteger value) Sets the value of the numberOfDocuments property.
void	setNumberOfTerms(BigInteger value) Sets the value of the numberOfTerms property.

Methods inherited from class java.lang.Object

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

Field Detail

extensionsAndDocumentTermMatrixesAndTextCorpuses

protected List<Serializable> extensionsAndDocumentTermMatrixesAndTextCorpuses

modelName

protected String modelName

functionName

protected MININGFUNCTION functionName

algorithmName

protected String algorithmName

numberOfTerms

protected BigInteger numberOfTerms

numberOfDocuments

protected BigInteger numberOfDocuments

isScorable

protected Boolean isScorable

Constructor Detail

TextModel

public TextModel()

Method Detail

getExtensionsAndDocumentTermMatrixesAndTextCorpuses

public List<Serializable> getExtensionsAndDocumentTermMatrixesAndTextCorpuses()

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

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

    getExtensionsAndDocumentTermMatrixesAndTextCorpuses().add(newItem);
 

Objects of the following type(s) are allowed in the list TextDictionary Extension ModelExplanation ModelVerification DocumentTermMatrix TextModelNormalization Targets MiningSchema Output ModelStats LocalTransformations TextModelSimiliarity TextCorpus

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

getNumberOfTerms

public BigInteger getNumberOfTerms()

Gets the value of the numberOfTerms property.

Returns:

possible object is BigInteger

setNumberOfTerms

public void setNumberOfTerms(BigInteger value)

Sets the value of the numberOfTerms property.

Parameters:

value - allowed object is BigInteger

getNumberOfDocuments

public BigInteger getNumberOfDocuments()

Gets the value of the numberOfDocuments property.

Returns:

possible object is BigInteger

setNumberOfDocuments

public void setNumberOfDocuments(BigInteger value)

Sets the value of the numberOfDocuments property.

Parameters:

value - allowed object is BigInteger

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