Package com.yahoo.prelude.query
Class WordAlternativesItem
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.WordAlternativesItem
- All Implemented Interfaces:
BlockItem
,HasIndexItem
,IndexedItem
,TaggableItem
,Cloneable
A set of words with differing exactness scores to be used for literal boost ranking.
- Author:
- Steinar Knutsen
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A word alternative.Nested classes/interfaces inherited from class com.yahoo.prelude.query.Item
Item.ItemCreator, Item.ItemType
-
Field Summary
Fields inherited from class com.yahoo.prelude.query.Item
connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, explicitSignificance, significance, uniqueID
-
Constructor Summary
ConstructorDescriptionWordAlternativesItem
(String indexName, boolean isFromQuery, Substring origin, Collection<WordAlternativesItem.Alternative> terms) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a new alternative iff the term string is not already present with an equal or higher exactness score.clone()
Returns a deep copy of this itemvoid
encodeThis
(ByteBuffer target) boolean
Returns whether this item is of the same class and contains the same state as the given item.Return an immutable snapshot of the contained terms.Return the searchable term contents of this item.Return the enumerated type of this item.getName()
Returns the name of this itemint
Returns how many phrase words does this item containReturns the raw form of the text leading to this term, exactly as received, including original casingint
hashCode()
boolean
boolean
isWords()
Returns whether this item represents normal textvoid
void
Sets the value of this item from a string.Returns the value of this term as a stringMethods inherited from class com.yahoo.prelude.query.TermItem
appendBodyString, disclose, encode, getOrigin, getSegmentingRule, getTermCount, isFromQuery, isNormalizable, setFromQuery, setNormalizable, setOrigin, setSegmentingRule
Methods inherited from class com.yahoo.prelude.query.SimpleIndexedItem
appendIndexString, getIndexName, setIndexName
Methods inherited from class com.yahoo.prelude.query.SimpleTaggableItem
getConnectedItem, getConnectivity, getSignificance, getUniqueID, hasExplicitSignificance, hasUniqueID, setConnectivity, setExplicitSignificance, setSignificance, setUniqueID
Methods inherited from class com.yahoo.prelude.query.Item
addAnnotation, appendHeadingString, 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
-
Constructor Details
-
WordAlternativesItem
public WordAlternativesItem(String indexName, boolean isFromQuery, Substring origin, Collection<WordAlternativesItem.Alternative> terms)
-
-
Method Details
-
setAlternatives
-
stringValue
Description copied from interface:BlockItem
Returns the value of this term as a string -
isStemmed
public boolean isStemmed() -
getNumWords
public int getNumWords()Description copied from interface:HasIndexItem
Returns how many phrase words does this item contain -
setValue
Description copied from class:TermItem
Sets the value of this item from a 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 interfaceBlockItem
- Specified by:
getRawWord
in classTermItem
-
isWords
public boolean isWords()Description copied from interface:BlockItem
Returns whether this item represents normal text -
getIndexedString
Description copied from interface:IndexedItem
Return the searchable term contents of this item.- Specified by:
getIndexedString
in interfaceIndexedItem
- Specified by:
getIndexedString
in classSimpleIndexedItem
- Returns:
- a string representation of what is presumably stored in an index which will match this item
-
getItemType
Description copied from class:Item
Return the enumerated type of this item.- Specified by:
getItemType
in classItem
-
getName
Description copied from class:Item
Returns the name of this item -
getAlternatives
Return an immutable snapshot of the contained terms. This list will not reflect later changes to the item.- Returns:
- an immutable list of word alternatives and their respective scores
-
encodeThis
- Overrides:
encodeThis
in classSimpleIndexedItem
-
addTerm
Add a new alternative iff the term string is not already present with an equal or higher exactness score. If the term string is present with a lower exactness score, the new, higher score will take precedence.- Parameters:
term
- one of several string interpretations of the input wordexactness
- how close the term string matches what the user input
-
clone
Description copied from class:Item
Returns a deep copy of this item -
equals
Description copied from class:Item
Returns whether this item is of the same class and contains the same state as the given item. -
hashCode
public int hashCode()
-