Package com.yahoo.prelude.query

Class FuzzyItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.SimpleIndexedItem

com.yahoo.prelude.query.TermItem

com.yahoo.prelude.query.FuzzyItem

All Implemented Interfaces:

BlockItem, HasIndexItem, IndexedItem, TaggableItem, Cloneable

public class FuzzyItem
extends TermItem

Fuzzy search term

Author:

alexeyche

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.prelude.query.Item

Item.ItemCreator, Item.ItemType

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_EDIT_DISTANCE
static int	DEFAULT_PREFIX_LENGTH

Fields inherited from class com.yahoo.prelude.query.Item

connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, documentFrequency, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors

Constructor	Description
FuzzyItem(String indexName, boolean isFromQuery, String term, int maxEditDistance, int prefixLength)
FuzzyItem(String indexName, boolean isFromQuery, String term, int maxEditDistance, int prefixLength, boolean prefixMatch)

Method Summary

Modifier and Type	Method	Description
protected void	appendHeadingString(StringBuilder buffer)	Appends the heading of this string.
protected void	encodeThis(ByteBuffer buffer)
boolean	equals(Object o)	Returns whether this item is of the same class and contains the same state as the given item.
String	getIndexedString()	Return the searchable term contents of this item.
Item.ItemType	getItemType()	Return the enumerated type of this item.
int	getMaxEditDistance()
String	getName()	Returns the name of this item
int	getNumWords()	Returns how many phrase words does this item contain
int	getPrefixLength()
String	getRawWord()	Returns the raw form of the text leading to this term, exactly as received, including original casing
int	hashCode()
protected boolean	hasPrefixMatchSemantics()	Indicates that a query item that does not normally match with prefix semantics should do so for this particular query item instance.
boolean	isPrefixMatch()
boolean	isStemmed()
boolean	isWords()	Returns whether this item represents normal text
void	setMaxEditDistance(int maxEditDistance)
void	setPrefixLength(int prefixLength)
void	setPrefixMatch(boolean prefixMatch)
void	setValue(String value)	Sets the value of this item from a string.
String	stringValue()	Returns the value of this term as a string

Methods inherited from class com.yahoo.prelude.query.TermItem

appendBodyString, disclose, encode, getOrigin, getSegmentingRule, getTermCount, isFromQuery, isLowercased, isNormalizable, setFromQuery, setLowercased, setNormalizable, setOrigin, setSegmentingRule

Methods inherited from class com.yahoo.prelude.query.SimpleIndexedItem

appendIndexString, getFieldName, getIndexName, setIndexName

Methods inherited from class com.yahoo.prelude.query.SimpleTaggableItem

getConnectedItem, getConnectivity, getDocumentFrequency, getSignificance, getUniqueID, hasExplicitSignificance, hasUniqueID, setConnectivity, setDocumentFrequency, setExplicitSignificance, setSignificance, setUniqueID

Methods inherited from class com.yahoo.prelude.query.Item

addAnnotation, clone, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, shouldParenthesize, toString, usePositionData

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.prelude.query.HasIndexItem

getIndexName

Field Details

DEFAULT_MAX_EDIT_DISTANCE

public static int DEFAULT_MAX_EDIT_DISTANCE

DEFAULT_PREFIX_LENGTH

public static int DEFAULT_PREFIX_LENGTH

Constructor Details

FuzzyItem

public FuzzyItem(String indexName,
 boolean isFromQuery,
 String term,
 int maxEditDistance,
 int prefixLength,
 boolean prefixMatch)

FuzzyItem

public FuzzyItem(String indexName,
 boolean isFromQuery,
 String term,
 int maxEditDistance,
 int prefixLength)

Method Details

setMaxEditDistance

public void setMaxEditDistance(int maxEditDistance)

setPrefixLength

public void setPrefixLength(int prefixLength)

getPrefixLength

public int getPrefixLength()

getMaxEditDistance

public int getMaxEditDistance()

isPrefixMatch

public boolean isPrefixMatch()

setPrefixMatch

public void setPrefixMatch(boolean prefixMatch)

hasPrefixMatchSemantics

protected boolean hasPrefixMatchSemantics()

Description copied from class: Item

Indicates that a query item that does not normally match with prefix semantics should do so for this particular query item instance. False by default; should be overridden by subclasses that want to signal this behavior.

Overrides:

hasPrefixMatchSemantics in class Item

setValue

public void setValue(String value)

Description copied from class: TermItem

Sets the value of this item from a string.

Specified by:

setValue in class TermItem

getRawWord

public String getRawWord()

Description copied from class: TermItem

Returns the raw form of the text leading to this term, exactly as received, including original casing

Specified by:

getRawWord in interface BlockItem

Specified by:

getRawWord in class TermItem

isWords

public boolean isWords()

Description copied from interface: BlockItem

Returns whether this item represents normal text

Specified by:

isWords in interface BlockItem

Specified by:

isWords in class TermItem

getItemType

public Item.ItemType getItemType()

Description copied from class: Item

Return the enumerated type of this item.

Specified by:

getItemType in class Item

getName

public String getName()

Description copied from class: Item

Returns the name of this item

Specified by:

getName in class Item

stringValue

public String stringValue()

Description copied from interface: BlockItem

Returns the value of this term as a string

isStemmed

public boolean isStemmed()

getIndexedString

public String getIndexedString()

Description copied from interface: IndexedItem

Return the searchable term contents of this item.

Specified by:

getIndexedString in interface IndexedItem

Specified by:

getIndexedString in class SimpleIndexedItem

Returns:

a string representation of what is presumably stored in an index which will match this item

getNumWords

public int getNumWords()

Description copied from interface: HasIndexItem

Returns how many phrase words does this item contain

equals

public boolean equals(Object o)

Description copied from class: Item

Returns whether this item is of the same class and contains the same state as the given item.

Overrides:

equals in class TermItem

hashCode

public int hashCode()

Overrides:

hashCode in class TermItem

appendHeadingString

protected void appendHeadingString(StringBuilder buffer)

Description copied from class: Item

Appends the heading of this string. As default getName() followed by a space.

Overrides:

appendHeadingString in class Item

encodeThis

protected void encodeThis(ByteBuffer buffer)

Overrides:

encodeThis in class SimpleIndexedItem