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:

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_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TextDictionary"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TextCorpus"/>
         <element ref="{http://www.dmg.org/PMML-4_3}DocumentTermMatrix"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TextModelNormalization" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TextModelSimiliarity" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}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_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="numberOfTerms" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="numberOfDocuments" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextModel()
TextModel(MiningFunction miningFunction, int numberOfTerms, int numberOfDocuments, MiningSchema miningSchema, TextDictionary textDictionary, TextCorpus textCorpus, DocumentTermMatrix documentTermMatrix)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
TextModel	addExtensions(Extension... extensions)
String	getAlgorithmName() Gets the value of the algorithmName property.
DocumentTermMatrix	getDocumentTermMatrix() Gets the value of the documentTermMatrix property.
List<Extension>	getExtensions() Gets the value of the extensions property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
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.
int	getNumberOfDocuments() Gets the value of the numberOfDocuments property.
int	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.
TextModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
TextModel	setDocumentTermMatrix(DocumentTermMatrix documentTermMatrix) Sets the value of the documentTermMatrix property.
TextModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
TextModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
TextModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
TextModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
TextModel	setModelName(String modelName) Sets the value of the modelName property.
TextModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
TextModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
TextModel	setNumberOfDocuments(int numberOfDocuments) Sets the value of the numberOfDocuments property.
TextModel	setNumberOfTerms(int numberOfTerms) Sets the value of the numberOfTerms property.
TextModel	setOutput(Output output) Sets the value of the output property.
TextModel	setScorable(Boolean scorable) Sets the value of the scorable property.
TextModel	setTargets(Targets targets) Sets the value of the targets property.
TextModel	setTextCorpus(TextCorpus textCorpus) Sets the value of the textCorpus property.
TextModel	setTextDictionary(TextDictionary textDictionary) Sets the value of the textDictionary property.
TextModel	setTextModelNormalization(TextModelNormalization textModelNormalization) Sets the value of the textModelNormalization property.
TextModel	setTextModelSimiliarity(TextModelSimiliarity textModelSimiliarity) Sets the value of the textModelSimiliarity property.

Methods inherited from class org.dmg.pmml.PMMLObject

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

TextModel

public TextModel()

TextModel

public TextModel(MiningFunction miningFunction,
         int numberOfTerms,
         int numberOfDocuments,
         MiningSchema miningSchema,
         TextDictionary textDictionary,
         TextCorpus textCorpus,
         DocumentTermMatrix documentTermMatrix)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public TextModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public TextModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public TextModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getNumberOfTerms

public int getNumberOfTerms()

Gets the value of the numberOfTerms property.

setNumberOfTerms

public TextModel setNumberOfTerms(int numberOfTerms)

Sets the value of the numberOfTerms property.

getNumberOfDocuments

public int getNumberOfDocuments()

Gets the value of the numberOfDocuments property.

setNumberOfDocuments

public TextModel setNumberOfDocuments(int numberOfDocuments)

Sets the value of the numberOfDocuments property.

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public TextModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

getExtensions

public 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 TextModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public TextModel setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - 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 TextModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public TextModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Overrides:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public TextModel setTargets(Targets targets)

Sets the value of the targets property.

Overrides:

setTargets in class Model

Parameters:

targets - 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 TextModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getTextDictionary

public TextDictionary getTextDictionary()

Gets the value of the textDictionary property.

Returns:

possible object is TextDictionary

setTextDictionary

public TextModel setTextDictionary(TextDictionary textDictionary)

Sets the value of the textDictionary property.

Parameters:

textDictionary - allowed object is TextDictionary

getTextCorpus

public TextCorpus getTextCorpus()

Gets the value of the textCorpus property.

Returns:

possible object is TextCorpus

setTextCorpus

public TextModel setTextCorpus(TextCorpus textCorpus)

Sets the value of the textCorpus property.

Parameters:

textCorpus - allowed object is TextCorpus

getDocumentTermMatrix

public DocumentTermMatrix getDocumentTermMatrix()

Gets the value of the documentTermMatrix property.

Returns:

possible object is DocumentTermMatrix

setDocumentTermMatrix

public TextModel setDocumentTermMatrix(DocumentTermMatrix documentTermMatrix)

Sets the value of the documentTermMatrix property.

Parameters:

documentTermMatrix - allowed object is DocumentTermMatrix

getTextModelNormalization

public TextModelNormalization getTextModelNormalization()

Gets the value of the textModelNormalization property.

Returns:

possible object is TextModelNormalization

setTextModelNormalization

public TextModel setTextModelNormalization(TextModelNormalization textModelNormalization)

Sets the value of the textModelNormalization property.

Parameters:

textModelNormalization - allowed object is TextModelNormalization

getTextModelSimiliarity

public TextModelSimiliarity getTextModelSimiliarity()

Gets the value of the textModelSimiliarity property.

Returns:

possible object is TextModelSimiliarity

setTextModelSimiliarity

public TextModel setTextModelSimiliarity(TextModelSimiliarity textModelSimiliarity)

Sets the value of the textModelSimiliarity property.

Parameters:

textModelSimiliarity - allowed object is TextModelSimiliarity

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public TextModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public TextModel addExtensions(Extension... extensions)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable