Package com.yahoo.prelude.query

Class IntItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.SimpleIndexedItem

com.yahoo.prelude.query.TermItem

com.yahoo.prelude.query.IntItem

All Implemented Interfaces:

BlockItem, HasIndexItem, IndexedItem, TaggableItem, Cloneable

Direct Known Subclasses:

RangeItem

public class IntItem
extends TermItem

This represents either

• a number (integer or floating point)
• a partial range, given by "<number" or ">number", where the numbers are exclusive, or
• a full or open range "[number;number], "[number;]" or "[;number]" where the numbers are inclusive, or exclusive if a square bracket is replaced with a pointy one

If a range is specified in brackets, it is also permissible to add a third number specifying the number of hits this will match on each node - [from;to;hitLimit]

Author:

bratseth

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
IntItem(int number, String indexName)	Creates an int item which must be equal to the given int number - that is both the lower and upper limit is this number
IntItem(long number, String indexName)	Creates an int item which must be equal to the given long number - that is both the lower and upper limit is this number
IntItem(Limit from, Limit to, int hitLimit, String indexName, boolean isFromQuery)
IntItem(Limit from, Limit to, String indexName)
IntItem(Long expression)
IntItem(String expression)
IntItem(String expression, boolean isFromQuery)
IntItem(String expression, String indexName)
IntItem(String expression, String indexName, boolean isFromQuery)

Method Summary

Modifier and Type	Method	Description
protected void	appendHeadingString(StringBuilder buffer)	Int items uses a empty heading instead of "INT "
WordItem	asWord()	Returns this as a wordItem
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.
static IntItem	from(String indexName, Limit from, Limit to, int hitLimit)	Creates an int item from arguments.
protected String	getEncodedInt()	Returns the number for encoding; the number expression as-is.
final Limit	getFromLimit()	Returns the lower limit of this range, which may be negative infinity
final int	getHitLimit()	Returns the number of hits this will match, or 0 if all should be matched.
String	getIndexedString()	Return the searchable term contents of this item.
Item.ItemType	getItemType()	Return the enumerated type of this item.
String	getName()	Returns the name of this item
String	getNumber()	Sets the number expression of this - a number or range
int	getNumWords()	Returns how many phrase words does this item contain
String	getRawWord()	Returns the raw form of the text leading to this term, exactly as received, including original casing
final Limit	getToLimit()	Returns the upper limit of this range, which may be positive infinity
int	hashCode()
boolean	isStemmed()
boolean	isWords()	Returns whether this item represents normal text
final void	setHitLimit(int hitLimit)	Sets the number of hits this will match, or 0 if all should be matched.
void	setNumber(String expression)	Sets the number expression of this - a number or range following the syntax specified in the class javadoc
void	setValue(String value)	Same as setNumber(java.lang.String)
String	stringValue()	Returns the value of this term as a string

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

appendBodyString, disclose, encode, getOrigin, getSegmentingRule, getTermCount, isFromQuery, isLowercased, isNormalizable, setFromQuery, setLowercased, setNormalizable, setOrigin, setSegmentingRule

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

appendIndexString, getFieldName, getIndexName, setIndexName

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, clone, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, 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

getIndexName

Constructor Details

IntItem

public IntItem(int number,
 String indexName)

Creates an int item which must be equal to the given int number - that is both the lower and upper limit is this number

IntItem

public IntItem(long number,
 String indexName)

Creates an int item which must be equal to the given long number - that is both the lower and upper limit is this number

IntItem

public IntItem(Limit from,
 Limit to,
 String indexName)

IntItem

public IntItem(Long expression)

IntItem

public IntItem(String expression)

IntItem

public IntItem(String expression,
 boolean isFromQuery)

IntItem

public IntItem(String expression,
 String indexName)

IntItem

public IntItem(String expression,
 String indexName,
 boolean isFromQuery)

IntItem

public IntItem(Limit from,
 Limit to,
 int hitLimit,
 String indexName,
 boolean isFromQuery)

Method Details

setNumber

public void setNumber(String expression)

Sets the number expression of this - a number or range following the syntax specified in the class javadoc

getNumber

public String getNumber()

Sets the number expression of this - a number or range

getFromLimit

public final Limit getFromLimit()

Returns the lower limit of this range, which may be negative infinity

getToLimit

public final Limit getToLimit()

Returns the upper limit of this range, which may be positive infinity

getHitLimit

public final int getHitLimit()

Returns the number of hits this will match, or 0 if all should be matched. If this number is positive, the hits closest to from are returned, and if this number is negative the hits closest to to are returned.

setHitLimit

public final void setHitLimit(int hitLimit)

Sets the number of hits this will match, or 0 if all should be matched. If this number is positive, the hits closest to from are returned, and if this number is negative the hits closest to to are returned.

Parameters:

hitLimit - number of hits to match for this operator

asWord

public WordItem asWord()

Returns this as a wordItem

getRawWord

public String getRawWord()

Description copied from class: TermItem

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

Specified by:

getRawWord in interface BlockItem

Specified by:

getRawWord in class TermItem

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

stringValue

public String stringValue()

Description copied from interface: BlockItem

Returns the value of this term as a string

setValue

public void setValue(String value)

Same as setNumber(java.lang.String)

Specified by:

setValue in class TermItem

appendHeadingString

protected void appendHeadingString(StringBuilder buffer)

Int items uses a empty heading instead of "INT "

Overrides:

appendHeadingString in class Item

hashCode

public int hashCode()

Overrides:

hashCode in class TermItem

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 TermItem

getEncodedInt

protected String getEncodedInt()

Returns the number for encoding; the number expression as-is.

getIndexedString

public String getIndexedString()

Description copied from interface: IndexedItem

Return the searchable term contents of this item.

Specified by:

getIndexedString in interface IndexedItem

Specified by:

getIndexedString in class SimpleIndexedItem

Returns:

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

encodeThis

protected void encodeThis(ByteBuffer buffer)

Overrides:

encodeThis in class SimpleIndexedItem

getNumWords

public int getNumWords()

Description copied from interface: HasIndexItem

Returns how many phrase words does this item contain

isStemmed

public boolean isStemmed()

isWords

public boolean isWords()

Description copied from interface: BlockItem

Returns whether this item represents normal text

Specified by:

isWords in interface BlockItem

Specified by:

isWords in class TermItem

from

public static IntItem from(String indexName,
 Limit from,
 Limit to,
 int hitLimit)

Creates an int item from arguments. This will return an instance of the RankItem subclass if either hitLimit or both from and to is set to a value other than defaults (respectively 0, double negative and positive infinity). And different from each other.

Parameters:

indexName - the index this searches

from - the lower limit (inclusive) on hits

to - the higher limit (inclusive) on hits

hitLimit - the number of hits to match, or 0 to return all