com.yahoo.prelude.query

Class TermItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.SimpleIndexedItem

com.yahoo.prelude.query.TermItem

All Implemented Interfaces:

BlockItem, HasIndexItem, IndexedItem, TaggableItem, Cloneable

Direct Known Subclasses:

IntItem, RegExpItem, WordAlternativesItem, WordItem

public abstract class TermItem
extends SimpleIndexedItem
implements BlockItem

A query term, that is, not only a term in the query language (an item), but also a term to be found in (or excluded from) the search index.

Optionally, a TermItem may also specify the name of an index backend to search.

Author:

bratseth, havardpe

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 and Description
	TermItem()
	TermItem(String indexName)
	TermItem(String indexName, boolean isFromQuery)
protected	TermItem(String indexName, boolean isFromQuery, Substring origin)

Method Summary

Modifier and Type	Method and Description
protected void	appendBodyString(StringBuilder buffer) Appends the index prefix if necessary and delegates to the subclass
void	disclose(Discloser discloser)
int	encode(ByteBuffer buffer)
Substring	getOrigin() Returns the substring which is the raw form of the text leading to this token.
abstract String	getRawWord() Returns the raw form of the text leading to this term, exactly as received, including original casing
SegmentingRule	getSegmentingRule() If the block has to be resegmented, what operator should be chosen if it is necessary to change operator?
int	getTermCount()
boolean	isFromQuery() Whether this term is from the query or has been added by a searcher.
boolean	isNormalizable() This refers to whether accent removal is a meaningful and possible operation for this word.
abstract boolean	isWords() Does this item represent "usual words"?
void	setNormalizable(boolean normalizable) This refers to whether accent removal is a meaningful and possible operation for this word.
void	setOrigin(Substring origin) Sets the origin of this
void	setSegmentingRule(SegmentingRule segmentingRule)
abstract void	setValue(String value) Sets the value of this item from a string.

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

appendIndexString, encodeThis, equals, getIndexedString, getIndexName, hashCode, 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, clone, 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, shouldParenthize, toString, usePositionData

Methods inherited from class java.lang.Object

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

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

isStemmed, stringValue

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

getIndexName, getNumWords

Constructor Detail

TermItem

public TermItem()

TermItem

public TermItem(String indexName)

TermItem

public TermItem(String indexName,
                boolean isFromQuery)

TermItem

protected TermItem(String indexName,
                   boolean isFromQuery,
                   Substring origin)

Method Detail

encode

public final int encode(ByteBuffer buffer)

Specified by:

encode in class Item

appendBodyString

protected final void appendBodyString(StringBuilder buffer)

Appends the index prefix if necessary and delegates to the subclass

Specified by:

appendBodyString in class Item

setValue

public abstract void setValue(String value)

Sets the value of this item from a string.

Throws:

UnsupportedOperationException - if this is not supported on this kind of item

getRawWord

public abstract String getRawWord()

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

Specified by:

getRawWord in interface BlockItem

getOrigin

public Substring getOrigin()

Returns the substring which is the raw form of the text leading to this token. This substring also contains the superstring this substring was a part of, e.g the whole query string. If this did not originate directly from a user string, this is null.

Specified by:

getOrigin in interface BlockItem

isFromQuery

public boolean isFromQuery()

Whether this term is from the query or has been added by a searcher. Only terms from the user should be modified by query rewriters which attempts to improve the precision or recall of the user's query.

Specified by:

isFromQuery in interface BlockItem

isWords

public abstract boolean isWords()

Description copied from interface: BlockItem

Does this item represent "usual words"?

Specified by:

isWords in interface BlockItem

setOrigin

public void setOrigin(Substring origin)

Sets the origin of this

disclose

public void disclose(Discloser discloser)

Overrides:

disclose in class SimpleIndexedItem

getTermCount

public int getTermCount()

Specified by:

getTermCount in class Item

isNormalizable

public boolean isNormalizable()

This refers to whether accent removal is a meaningful and possible operation for this word. It should be named "isTransformable" or similar, but for historical reasons that is not the case. This method has nothing to do with Unicode normalization.

Returns:

true if accent removal can/should be performed

setNormalizable

public void setNormalizable(boolean normalizable)

This refers to whether accent removal is a meaningful and possible operation for this word. It should be named "isTransformable" or similar, but for historical reasons that is not the case. This method has nothing to do with Unicode normalization.

Parameters:

normalizable - set to true if accent removal can/should be performed

getSegmentingRule

public SegmentingRule getSegmentingRule()

Description copied from interface: BlockItem

If the block has to be resegmented, what operator should be chosen if it is necessary to change operator?

Specified by:

getSegmentingRule in interface BlockItem

setSegmentingRule

public void setSegmentingRule(SegmentingRule segmentingRule)