Package com.yahoo.prelude.query

Class NearItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.CompositeItem

com.yahoo.prelude.query.NearItem

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ONearItem

public class NearItem
extends CompositeItem

A set of terms which must be near each other to match.

Author:

bratseth, havardpe

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.prelude.query.Item

Item.ItemCreator, Item.ItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	defaultDistance	The default distance used if none is specified: 2
protected int	distance
protected int	exclusionDistance
protected int	numNegativeItems

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

connectedBacklink, connectedItem, connectivity, DEFAULT_WEIGHT, documentFrequency, explicitSignificance, significance, uniqueID

Constructor Summary

Constructors

Constructor	Description
NearItem()	Creates a NEAR item with distance 2
NearItem(int distance)	Creates a near item with a limit to the distance between the words.

Method Summary

Modifier and Type	Method	Description
protected void	appendHeadingString(StringBuilder buffer)	Appends the heading of this string - [getName()]([limit])
void	disclose(Discloser discloser)
protected void	encodeThis(ByteBuffer buffer)	Encodes just this item, not its regular subitems, to the given buffer.
boolean	equals(Object object)	Returns whether this item is of the same class and contains the same state as the given item.
int	getDistance()
int	getExclusionDistance()
Item.ItemType	getItemType()	Return the enumerated type of this item.
String	getName()	Returns the name of this item
int	getNumNegativeItems()
int	hashCode()
void	setDistance(int distance)
void	setExclusionDistance(int exclusionDistance)
void	setNumNegativeItems(int numNegativeItems)

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

acceptsItemsOfType, adding, addItem, addItem, appendBodyString, clone, encode, encodingArity, ensureNotInSubtree, extractSingleChild, getItem, getItemCount, getItemIndex, getItemIterator, getTermCount, isLocked, items, lock, removeItem, removeItem, setIndexName, setItem, shouldParenthesize

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

addAnnotation, 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, toString, usePositionData

Methods inherited from class java.lang.Object

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

Field Details

distance

protected int distance

numNegativeItems

protected int numNegativeItems

exclusionDistance

protected int exclusionDistance

defaultDistance

public static final int defaultDistance

The default distance used if none is specified: 2

See Also:

• Constant Field Values

Constructor Details

NearItem

public NearItem()

Creates a NEAR item with distance 2

NearItem

public NearItem(int distance)

Creates a near item with a limit to the distance between the words.

Parameters:

distance - the maximum position difference between the words which should be counted as a match

Method Details

setDistance

public void setDistance(int distance)

getDistance

public int getDistance()

setNumNegativeItems

public void setNumNegativeItems(int numNegativeItems)

getNumNegativeItems

public int getNumNegativeItems()

setExclusionDistance

public void setExclusionDistance(int exclusionDistance)

getExclusionDistance

public int getExclusionDistance()

getItemType

public Item.ItemType getItemType()

Description copied from class: Item

Return the enumerated type of this item.

Specified by:

getItemType in class Item

getName

public String getName()

Description copied from class: Item

Returns the name of this item

Specified by:

getName in class Item

encodeThis

protected void encodeThis(ByteBuffer buffer)

Description copied from class: CompositeItem

Encodes just this item, not its regular subitems, to the given buffer.

Overrides:

encodeThis in class CompositeItem

disclose

public void disclose(Discloser discloser)

Overrides:

disclose in class CompositeItem

appendHeadingString

protected void appendHeadingString(StringBuilder buffer)

Appends the heading of this string - [getName()]([limit])

Overrides:

appendHeadingString in class Item

equals

public boolean equals(Object object)

Description copied from class: CompositeItem

Returns whether this item is of the same class and contains the same state as the given item.

Overrides:

equals in class CompositeItem

hashCode

public int hashCode()

Overrides:

hashCode in class CompositeItem