Package com.yahoo.prelude.query

Class SimpleIndexedItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.SimpleIndexedItem

All Implemented Interfaces:

HasIndexItem, IndexedItem, TaggableItem, Cloneable

Direct Known Subclasses:

TermItem

public abstract class SimpleIndexedItem
extends SimpleTaggableItem
implements IndexedItem

Common implementation for Item classes implementing the IndexedItem interface. Note that this file exist in 3 copies that should be kept in sync: CompositeIndexedItem.java SimpleIndexedItem.java IndexedSegmentItem.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, documentFrequency, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors

Constructor	Description
SimpleIndexedItem()

Method Summary

Modifier and Type	Method	Description
protected void	appendIndexString(StringBuilder buffer)	Appends the index prefix if necessary
void	disclose(Discloser discloser)
protected void	encodeThis(ByteBuffer buffer)
boolean	equals(Object object)	Returns whether this item is of the same class and contains the same state as the given item.
String	getFieldName()	The *full* name of the field searched by this, which is prefixed by the parent name and a dot if this is inside a SameElement, and the same as getIndexName otherwise.
abstract String	getIndexedString()	Return the searchable term contents of this item.
String	getIndexName()	The name of the index this belongs to, or "" (never null) if not specified
int	hashCode()
void	setIndexName(String index)	Sets the name of the index to search

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

getConnectedItem, getConnectivity, getDocumentFrequency, getSignificance, getUniqueID, hasExplicitSignificance, hasUniqueID, setConnectivity, setDocumentFrequency, setExplicitSignificance, setSignificance, setUniqueID

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

addAnnotation, appendBodyString, appendHeadingString, clone, encode, getAnnotation, getBytes, getCode, getCreator, getItemType, getLabel, getLanguage, getName, getParent, getTermCount, getWeight, hasAnnotation, hasConnectivityBackLink, hasPrefixMatchSemantics, 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

getNumWords

Constructor Details

SimpleIndexedItem

public SimpleIndexedItem()

Method Details

getIndexName

public String getIndexName()

The name of the index this belongs to, or "" (never null) if not specified

Specified by:

getIndexName in interface HasIndexItem

getFieldName

public String getFieldName()

The *full* name of the field searched by this, which is prefixed by the parent name and a dot if this is inside a SameElement, and the same as getIndexName otherwise.

encodeThis

protected void encodeThis(ByteBuffer buffer)

Overrides:

encodeThis in class Item

setIndexName

public void setIndexName(String index)

Sets the name of the index to search

Specified by:

setIndexName in interface IndexedItem

Specified by:

setIndexName in class Item

appendIndexString

protected void appendIndexString(StringBuilder buffer)

Appends the index prefix if necessary

equals

public boolean equals(Object object)

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 Item

hashCode

public int hashCode()

Overrides:

hashCode in class Item

getIndexedString

public abstract String getIndexedString()

Description copied from interface: IndexedItem

Return the searchable term contents of this item.

Specified by:

getIndexedString in interface IndexedItem

Returns:

a string representation of what is presumably stored in an index which will match this item

disclose

public void disclose(Discloser discloser)

Overrides:

disclose in class Item