Package com.yahoo.prelude.query
Class TaggableSegmentItem
- java.lang.Object
-
- com.yahoo.prelude.query.Item
-
- com.yahoo.prelude.query.CompositeItem
-
- com.yahoo.prelude.query.SegmentItem
-
- com.yahoo.prelude.query.TaggableSegmentItem
-
- All Implemented Interfaces:
BlockItem
,HasIndexItem
,TaggableItem
,java.lang.Cloneable
- Direct Known Subclasses:
IndexedSegmentItem
public abstract class TaggableSegmentItem extends SegmentItem implements TaggableItem
Common implementation for Item classes implementing the TaggableItem interface. Note that this file exist in 3 copies that should be kept in sync: CompositeTaggableItem.java SimpleTaggableItem.java TaggableSegmentItem.java These should only have trivial differences. (multiple inheritance or mixins would have been nice).- Author:
- arnej27959
-
-
Nested Class Summary
-
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
Constructors Modifier Constructor Description protected
TaggableSegmentItem(java.lang.String rawWord, java.lang.String current, boolean isFromQuery, boolean stemmed, Substring origin)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Item
getConnectedItem()
double
getConnectivity()
double
getSignificance()
int
getUniqueID()
boolean
hasExplicitSignificance()
boolean
hasUniqueID()
void
setConnectivity(Item item, double connectivity)
void
setExplicitSignificance(boolean explicitSignificance)
void
setSignificance(double significance)
Used for setting explicit term significance (in the tf/idf sense) to a single term or phrase, relative to the rest of the query.void
setUniqueID(int id)
-
Methods inherited from class com.yahoo.prelude.query.SegmentItem
addItem, addItem, clone, disclose, getNormalized, getNumWords, getOrigin, getRawWord, getSegmentingRule, isFromQuery, isFromUser, isLocked, isStemmed, isWords, lock, removeItem, removeItem, setFromUser, setSegmentingRule, stringValue
-
Methods inherited from class com.yahoo.prelude.query.CompositeItem
adding, appendBodyString, encode, encodeThis, encodingArity, ensureNotInSubtree, equals, extractSingleChild, getItem, getItemCount, getItemIndex, getItemIterator, getTermCount, hashCode, items, setIndexName, setItem, shouldParenthize
-
Methods inherited from class com.yahoo.prelude.query.Item
addAnnotation, appendHeadingString, getAnnotation, getBytes, getCode, getCreator, getItemType, getLabel, getLanguage, getName, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, 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 Detail
-
TaggableSegmentItem
protected TaggableSegmentItem(java.lang.String rawWord, java.lang.String current, boolean isFromQuery, boolean stemmed, Substring origin)
-
-
Method Detail
-
getUniqueID
public int getUniqueID()
- Specified by:
getUniqueID
in interfaceTaggableItem
-
setUniqueID
public void setUniqueID(int id)
- Specified by:
setUniqueID
in interfaceTaggableItem
-
setConnectivity
public void setConnectivity(Item item, double connectivity)
- Specified by:
setConnectivity
in interfaceTaggableItem
- Parameters:
item
- the item this should be connected to - in practice the next consecutive item in the queryconnectivity
- a value between 0 (none) and 1 (maximal), defining the connectivity between this and the argument item. The default connectivity is 0.1.
-
getConnectedItem
public Item getConnectedItem()
- Specified by:
getConnectedItem
in interfaceTaggableItem
-
getConnectivity
public double getConnectivity()
- Specified by:
getConnectivity
in interfaceTaggableItem
-
setSignificance
public void setSignificance(double significance)
Description copied from interface:TaggableItem
Used for setting explicit term significance (in the tf/idf sense) to a single term or phrase, relative to the rest of the query. This influences ranking features which take term significance into account and overrides the default partial corpus based term significance computation happening in the backend.- Specified by:
setSignificance
in interfaceTaggableItem
-
setExplicitSignificance
public void setExplicitSignificance(boolean explicitSignificance)
- Specified by:
setExplicitSignificance
in interfaceTaggableItem
-
hasExplicitSignificance
public boolean hasExplicitSignificance()
- Specified by:
hasExplicitSignificance
in interfaceTaggableItem
-
getSignificance
public double getSignificance()
- Specified by:
getSignificance
in interfaceTaggableItem
-
hasUniqueID
public boolean hasUniqueID()
- Specified by:
hasUniqueID
in interfaceTaggableItem
- Overrides:
hasUniqueID
in classItem
-
-