org.dmg.pmml

Class TextIndex

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Expression

org.dmg.pmml.TextIndex

All Implemented Interfaces:

Serializable, HasExpression, HasExtensions, HasLocator, Visitable

public class TextIndex
extends Expression
implements HasExpression, 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}TextIndexNormalization" maxOccurs="unbounded" minOccurs="0"/>
         <group ref="{http://www.dmg.org/PMML-4_3}EXPRESSION"/>
       </sequence>
       <attribute name="textField" use="required" type="{http://www.dmg.org/PMML-4_3}FIELD-NAME" />
       <attribute name="localTermWeights" default="termFrequency">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="termFrequency"/>
             <enumeration value="binary"/>
             <enumeration value="logarithmic"/>
             <enumeration value="augmentedNormalizedTermFrequency"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="isCaseSensitive" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="maxLevenshteinDistance" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" default="0" />
       <attribute name="countHits" default="allHits">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="allHits"/>
             <enumeration value="bestHits"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="wordSeparatorCharacterRE" type="{http://www.w3.org/2001/XMLSchema}string" default="\s" />
       <attribute name="tokenize" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextIndex.CountHits Java class for null.
static class	TextIndex.LocalTermWeights Java class for null.

Constructor Summary

Constructors

Constructor and Description
TextIndex()
TextIndex(FieldName textField)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
TextIndex	addExtensions(Extension... extensions)
TextIndex	addTextIndexNormalizations(TextIndexNormalization... textIndexNormalizations)
TextIndex.CountHits	getCountHits() Gets the value of the countHits property.
Expression	getExpression() Gets the value of the expression property.
List<Extension>	getExtensions() Gets the value of the extensions property.
TextIndex.LocalTermWeights	getLocalTermWeights() Gets the value of the localTermWeights property.
Integer	getMaxLevenshteinDistance() Gets the value of the maxLevenshteinDistance property.
FieldName	getTextField() Gets the value of the textField property.
List<TextIndexNormalization>	getTextIndexNormalizations() Gets the value of the textIndexNormalizations property.
String	getWordSeparatorCharacterRE() Gets the value of the wordSeparatorCharacterRE property.
boolean	hasExtensions()
boolean	hasTextIndexNormalizations()
boolean	isIsCaseSensitive() Gets the value of the isCaseSensitive property.
boolean	isTokenize() Gets the value of the tokenize property.
TextIndex	setCountHits(TextIndex.CountHits countHits) Sets the value of the countHits property.
TextIndex	setExpression(Expression expression) Sets the value of the expression property.
TextIndex	setIsCaseSensitive(Boolean isCaseSensitive) Sets the value of the isCaseSensitive property.
TextIndex	setLocalTermWeights(TextIndex.LocalTermWeights localTermWeights) Sets the value of the localTermWeights property.
TextIndex	setMaxLevenshteinDistance(Integer maxLevenshteinDistance) Sets the value of the maxLevenshteinDistance property.
TextIndex	setTextField(FieldName textField) Sets the value of the textField property.
TextIndex	setTokenize(Boolean tokenize) Sets the value of the tokenize property.
TextIndex	setWordSeparatorCharacterRE(String wordSeparatorCharacterRE) Sets the value of the wordSeparatorCharacterRE 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

TextIndex

public TextIndex()

TextIndex

public TextIndex(FieldName textField)

Method Detail

getTextField

public FieldName getTextField()

Gets the value of the textField property.

Returns:

possible object is String

setTextField

public TextIndex setTextField(FieldName textField)

Sets the value of the textField property.

Parameters:

textField - allowed object is String

getLocalTermWeights

public TextIndex.LocalTermWeights getLocalTermWeights()

Gets the value of the localTermWeights property.

Returns:

possible object is TextIndex.LocalTermWeights

setLocalTermWeights

public TextIndex setLocalTermWeights(TextIndex.LocalTermWeights localTermWeights)

Sets the value of the localTermWeights property.

Parameters:

localTermWeights - allowed object is TextIndex.LocalTermWeights

isIsCaseSensitive

public boolean isIsCaseSensitive()

Gets the value of the isCaseSensitive property.

Returns:

possible object is Boolean

setIsCaseSensitive

public TextIndex setIsCaseSensitive(Boolean isCaseSensitive)

Sets the value of the isCaseSensitive property.

Parameters:

isCaseSensitive - allowed object is Boolean

getMaxLevenshteinDistance

public Integer getMaxLevenshteinDistance()

Gets the value of the maxLevenshteinDistance property.

Returns:

possible object is Integer

setMaxLevenshteinDistance

public TextIndex setMaxLevenshteinDistance(Integer maxLevenshteinDistance)

Sets the value of the maxLevenshteinDistance property.

Parameters:

maxLevenshteinDistance - allowed object is Integer

getCountHits

public TextIndex.CountHits getCountHits()

Gets the value of the countHits property.

Returns:

possible object is TextIndex.CountHits

setCountHits

public TextIndex setCountHits(TextIndex.CountHits countHits)

Sets the value of the countHits property.

Parameters:

countHits - allowed object is TextIndex.CountHits

getWordSeparatorCharacterRE

public String getWordSeparatorCharacterRE()

Gets the value of the wordSeparatorCharacterRE property.

Returns:

possible object is String

setWordSeparatorCharacterRE

public TextIndex setWordSeparatorCharacterRE(String wordSeparatorCharacterRE)

Sets the value of the wordSeparatorCharacterRE property.

Parameters:

wordSeparatorCharacterRE - allowed object is String

isTokenize

public boolean isTokenize()

Gets the value of the tokenize property.

Returns:

possible object is Boolean

setTokenize

public TextIndex setTokenize(Boolean tokenize)

Sets the value of the tokenize property.

Parameters:

tokenize - 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

getTextIndexNormalizations

public List<TextIndexNormalization> getTextIndexNormalizations()

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

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

    getTextIndexNormalizations().add(newItem);
 

Objects of the following type(s) are allowed in the list TextIndexNormalization

getExpression

public Expression getExpression()

Gets the value of the expression property.

Specified by:

getExpression in interface HasExpression

Returns:

possible object is Constant FieldRef NormContinuous NormDiscrete Discretize MapValues TextIndex Apply Aggregate Lag

setExpression

public TextIndex setExpression(Expression expression)

Sets the value of the expression property.

Specified by:

setExpression in interface HasExpression

Parameters:

expression - allowed object is Constant FieldRef NormContinuous NormDiscrete Discretize MapValues TextIndex Apply Aggregate Lag

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public TextIndex addExtensions(Extension... extensions)

hasTextIndexNormalizations

public boolean hasTextIndexNormalizations()

addTextIndexNormalizations

public TextIndex addTextIndexNormalizations(TextIndexNormalization... textIndexNormalizations)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable