org.dmg.pmml

Class TextIndex

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Expression

org.dmg.pmml.TextIndex

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class TextIndex
extends Expression
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}TextIndexNormalization" maxOccurs="unbounded" minOccurs="0"/>
         <group ref="{http://www.dmg.org/PMML-4_2}EXPRESSION"/>
       </sequence>
       <attribute name="textField" use="required" type="{http://www.dmg.org/PMML-4_2}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.w3.org/2001/XMLSchema}integer" 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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	countHits
protected Expression	expression
protected java.util.List<Extension>	extensions
protected java.lang.Boolean	isCaseSensitive
protected java.lang.String	localTermWeights
protected java.lang.Integer	maxLevenshteinDistance
protected FieldName	textField
protected java.util.List<TextIndexNormalization>	textIndexNormalizations
protected java.lang.Boolean	tokenize
protected java.lang.String	wordSeparatorCharacterRE

Constructor Summary

Constructors

Constructor and Description
TextIndex()
TextIndex(FieldName textField)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getCountHits() Gets the value of the countHits property.
Expression	getExpression() Gets the value of the expression property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
java.lang.String	getLocalTermWeights() Gets the value of the localTermWeights property.
int	getMaxLevenshteinDistance() Gets the value of the maxLevenshteinDistance property.
FieldName	getTextField() Gets the value of the textField property.
java.util.List<TextIndexNormalization>	getTextIndexNormalizations() Gets the value of the textIndexNormalizations property.
java.lang.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.
void	setCountHits(java.lang.String value) Sets the value of the countHits property.
void	setExpression(Expression value) Sets the value of the expression property.
void	setIsCaseSensitive(java.lang.Boolean value) Sets the value of the isCaseSensitive property.
void	setLocalTermWeights(java.lang.String value) Sets the value of the localTermWeights property.
void	setMaxLevenshteinDistance(java.lang.Integer value) Sets the value of the maxLevenshteinDistance property.
void	setTextField(FieldName value) Sets the value of the textField property.
void	setTokenize(java.lang.Boolean value) Sets the value of the tokenize property.
void	setWordSeparatorCharacterRE(java.lang.String value) Sets the value of the wordSeparatorCharacterRE property.
TextIndex	withCountHits(java.lang.String value)
TextIndex	withExpression(Expression value)
TextIndex	withExtensions(java.util.Collection<Extension> values)
TextIndex	withExtensions(Extension... values)
TextIndex	withIsCaseSensitive(java.lang.Boolean value)
TextIndex	withLocalTermWeights(java.lang.String value)
TextIndex	withMaxLevenshteinDistance(java.lang.Integer value)
TextIndex	withTextField(FieldName value)
TextIndex	withTextIndexNormalizations(java.util.Collection<TextIndexNormalization> values)
TextIndex	withTextIndexNormalizations(TextIndexNormalization... values)
TextIndex	withTokenize(java.lang.Boolean value)
TextIndex	withWordSeparatorCharacterRE(java.lang.String 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

textField

protected FieldName textField

localTermWeights

protected java.lang.String localTermWeights

isCaseSensitive

protected java.lang.Boolean isCaseSensitive

maxLevenshteinDistance

protected java.lang.Integer maxLevenshteinDistance

countHits

protected java.lang.String countHits

wordSeparatorCharacterRE

protected java.lang.String wordSeparatorCharacterRE

tokenize

protected java.lang.Boolean tokenize

extensions

protected java.util.List<Extension> extensions

textIndexNormalizations

protected java.util.List<TextIndexNormalization> textIndexNormalizations

expression

protected Expression expression

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 void setTextField(FieldName value)

Sets the value of the textField property.

Parameters:

value - allowed object is String

getLocalTermWeights

public java.lang.String getLocalTermWeights()

Gets the value of the localTermWeights property.

Returns:

possible object is String

setLocalTermWeights

public void setLocalTermWeights(java.lang.String value)

Sets the value of the localTermWeights property.

Parameters:

value - allowed object is String

isIsCaseSensitive

public boolean isIsCaseSensitive()

Gets the value of the isCaseSensitive property.

Returns:

possible object is Boolean

setIsCaseSensitive

public void setIsCaseSensitive(java.lang.Boolean value)

Sets the value of the isCaseSensitive property.

Parameters:

value - allowed object is Boolean

getMaxLevenshteinDistance

public int getMaxLevenshteinDistance()

Gets the value of the maxLevenshteinDistance property.

Returns:

possible object is String

setMaxLevenshteinDistance

public void setMaxLevenshteinDistance(java.lang.Integer value)

Sets the value of the maxLevenshteinDistance property.

Parameters:

value - allowed object is String

getCountHits

public java.lang.String getCountHits()

Gets the value of the countHits property.

Returns:

possible object is String

setCountHits

public void setCountHits(java.lang.String value)

Sets the value of the countHits property.

Parameters:

value - allowed object is String

getWordSeparatorCharacterRE

public java.lang.String getWordSeparatorCharacterRE()

Gets the value of the wordSeparatorCharacterRE property.

Returns:

possible object is String

setWordSeparatorCharacterRE

public void setWordSeparatorCharacterRE(java.lang.String value)

Sets the value of the wordSeparatorCharacterRE property.

Parameters:

value - allowed object is String

isTokenize

public boolean isTokenize()

Gets the value of the tokenize property.

Returns:

possible object is Boolean

setTokenize

public void setTokenize(java.lang.Boolean value)

Sets the value of the tokenize property.

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

getTextIndexNormalizations

public java.util.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.

Returns:

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

setExpression

public void setExpression(Expression value)

Sets the value of the expression property.

Parameters:

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

withTextField

public TextIndex withTextField(FieldName value)

withLocalTermWeights

public TextIndex withLocalTermWeights(java.lang.String value)

withIsCaseSensitive

public TextIndex withIsCaseSensitive(java.lang.Boolean value)

withMaxLevenshteinDistance

public TextIndex withMaxLevenshteinDistance(java.lang.Integer value)

withCountHits

public TextIndex withCountHits(java.lang.String value)

withWordSeparatorCharacterRE

public TextIndex withWordSeparatorCharacterRE(java.lang.String value)

withTokenize

public TextIndex withTokenize(java.lang.Boolean value)

withExtensions

public TextIndex withExtensions(Extension... values)

withExtensions

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

withTextIndexNormalizations

public TextIndex withTextIndexNormalizations(TextIndexNormalization... values)

withTextIndexNormalizations

public TextIndex withTextIndexNormalizations(java.util.Collection<TextIndexNormalization> values)

withExpression

public TextIndex withExpression(Expression value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasTextIndexNormalizations

public boolean hasTextIndexNormalizations()

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable