Package com.yahoo.prelude.query

Class NullItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.NullItem

All Implemented Interfaces:

Cloneable

public class NullItem
extends Item

A placeholder for null queries to make searchers easier to write.

Author:

Steinar Knutsen

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
NullItem()

Method Summary

Modifier and Type	Method	Description
void	appendBodyString(StringBuilder buffer)	Override to append the item body in the canonical query language of this item.
void	appendHeadingString(StringBuilder buffer)	Appends the heading of this string.
int	encode(ByteBuffer buffer)
Item.ItemType	getItemType()	Return the enumerated type of this item.
String	getName()	Returns the name of this item
int	getTermCount()
void	setIndexName(String index)	Does nothing

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

addAnnotation, clone, disclose, encodeThis, equals, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, hashCode, 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

NullItem

public NullItem()

Method Details

setIndexName

public void setIndexName(String index)

Does nothing

Specified by:

setIndexName in class Item

encode

public int encode(ByteBuffer buffer)

Specified by:

encode in class Item

getItemType

public Item.ItemType getItemType()

Description copied from class: Item

Return the enumerated type of this item.

Specified by:

getItemType in class Item

appendBodyString

public 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

appendHeadingString

public 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

getName

public String getName()

Description copied from class: Item

Returns the name of this item

Specified by:

getName in class Item

getTermCount

public int getTermCount()

Specified by:

getTermCount in class Item