Package com.yahoo.prelude.query

Class StringInItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.InItem

com.yahoo.prelude.query.StringInItem

All Implemented Interfaces:

Cloneable

public class StringInItem
extends InItem

Class representing an IN operator with a set of string values.

Author:

toregge

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, documentFrequency, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors

Constructor	Description
StringInItem(String indexName)
StringInItem(String indexName, Set<String> tokens)

Method Summary

Modifier and Type	Method	Description
void	addToken(String token)
protected void	appendBodyString(StringBuilder buffer)	Override to append the item body in the canonical query language of this item.
StringInItem	clone()	Returns a deep copy of this item
void	disclose(Discloser discloser)
int	encode(ByteBuffer buffer)
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.
Item.ItemType	getItemType()	Return the enumerated type of this item.
int	getTermCount()
Collection<String>	getTokens()
int	hashCode()
void	removeToken(String token)

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

getIndexName, getName, setIndexName

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

addAnnotation, appendHeadingString, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, hasPrefixMatchSemantics, hasUniqueID, 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

Constructor Details

StringInItem

public StringInItem(String indexName)

StringInItem

public StringInItem(String indexName,
 Set<String> tokens)

Method Details

getItemType

public Item.ItemType getItemType()

Description copied from class: Item

Return the enumerated type of this item.

Specified by:

getItemType in class Item

encode

public int encode(ByteBuffer buffer)

Specified by:

encode in class Item

encodeThis

protected void encodeThis(ByteBuffer buffer)

Overrides:

encodeThis in class Item

getTermCount

public int getTermCount()

Specified by:

getTermCount in class Item

appendBodyString

protected void appendBodyString(StringBuilder buffer)

Description copied from class: Item

Override to append the item body in the canonical query language of this item. An item is usually represented by the string

 ([itemName] [body])
 

The body must be appended by this method.

Specified by:

appendBodyString in class Item

addToken

public void addToken(String token)

removeToken

public void removeToken(String token)

getTokens

public Collection<String> getTokens()

disclose

public void disclose(Discloser discloser)

Overrides:

disclose in class Item

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 InItem

hashCode

public int hashCode()

Overrides:

hashCode in class InItem

clone

public StringInItem clone()

Description copied from class: Item

Returns a deep copy of this item

Overrides:

clone in class Item