Package com.yahoo.prelude.query

Class PredicateQueryItem

java.lang.Object

com.yahoo.prelude.query.Item

com.yahoo.prelude.query.SimpleTaggableItem

com.yahoo.prelude.query.PredicateQueryItem

All Implemented Interfaces:

TaggableItem, Cloneable

public class PredicateQueryItem
extends SimpleTaggableItem

A PredicateQueryItem is a collection of feature/value-pairs that are used to query predicate fields, which contains boolean constraints. If the feature/value-pairs from the PredicateQueryItem satisfies the boolean constraints, the document is a match.

Author:

Magnar Nedland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PredicateQueryItem.Entry	A unique entry in a predicate item.
static class	PredicateQueryItem.EntryBase	An entry in a predicate item.
static class	PredicateQueryItem.RangeEntry	A range entry in a predicate item.

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

Item.ItemCreator, Item.ItemType

Field Summary

Fields

Modifier and Type	Field	Description
static long	ALL_SUB_QUERIES

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

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

Constructor Summary

Constructors

Constructor	Description
PredicateQueryItem()

Method Summary

Modifier and Type	Method	Description
void	addFeature(PredicateQueryItem.Entry entry)	Adds a feature/value-pair to the predicate query.
void	addFeature(String key, String value)	Adds a feature/value-pair to the predicate query.
void	addFeature(String key, String value, long subQueryBitmap)	Adds a feature/value-pair to the predicate query.
void	addRangeFeature(PredicateQueryItem.RangeEntry entry)	Adds a range feature with a given value to the predicate query.
void	addRangeFeature(String key, long value)	Adds a range feature with a given value to the predicate query.
void	addRangeFeature(String key, long value, long subQueryBitmap)	Adds a range feature with a given value to the predicate query.
protected void	appendBodyString(StringBuilder buffer)	Override to append the item body in the canonical query language of this item.
PredicateQueryItem	clone()	Returns a deep copy of this item
int	encode(ByteBuffer buffer)
boolean	equals(Object o)	Returns whether this item is of the same class and contains the same state as the given item.
Collection<PredicateQueryItem.Entry>	getFeatures()	Returns a mutable collection of feature entries.
String	getIndexName()	Returns the name of the index (field) used for the predicates.
Item.ItemType	getItemType()	Return the enumerated type of this item.
String	getName()	Returns the name of this item
Collection<PredicateQueryItem.RangeEntry>	getRangeFeatures()	Returns a mutable collection of range feature entries.
int	getTermCount()
int	hashCode()
void	setIndexName(String index)	Sets the name of the index (field) to be used for the predicates.

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

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

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

addAnnotation, appendHeadingString, disclose, encodeThis, getAnnotation, getBytes, getCode, getCreator, getLabel, getLanguage, getParent, getWeight, hasAnnotation, hasConnectivityBackLink, isFilter, isFromSpecialToken, isProtected, isRanked, isRoot, putBytes, putString, setCreator, setFilter, setFromSpecialToken, setHasUniqueID, setLabel, setLanguage, setParent, setPositionData, setProtected, setRanked, setWeight, shouldParenthize, toString, usePositionData

Methods inherited from class java.lang.Object

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

Field Detail

ALL_SUB_QUERIES

public static final long ALL_SUB_QUERIES

See Also:

Constant Field Values

Constructor Detail

PredicateQueryItem

public PredicateQueryItem()

Method Detail

setIndexName

public void setIndexName(String index)

Sets the name of the index (field) to be used for the predicates.

Specified by:

setIndexName in class Item

getIndexName

public String getIndexName()

Returns the name of the index (field) used for the predicates.

addFeature

public void addFeature(String key,
                       String value)

Adds a feature/value-pair to the predicate query. This feature is applied to all sub queries.

Parameters:

key - name of the feature to be set in this query

value - value of the feature

addFeature

public void addFeature(String key,
                       String value,
                       long subQueryBitmap)

Adds a feature/value-pair to the predicate query.

Parameters:

key - name of the feature to be set in this query

value - value of the feature

subQueryBitmap - bitmap specifying which sub queries this feature applies to

addFeature

public void addFeature(PredicateQueryItem.Entry entry)

Adds a feature/value-pair to the predicate query.

Parameters:

entry - the feature to add

addRangeFeature

public void addRangeFeature(String key,
                            long value)

Adds a range feature with a given value to the predicate query. This feature is applied to all sub queries.

Parameters:

key - name of the feature to be set in this query

value - value of the feature

addRangeFeature

public void addRangeFeature(String key,
                            long value,
                            long subQueryBitmap)

Adds a range feature with a given value to the predicate query.

Parameters:

key - name of the feature to be set in this query

value - value of the feature

subQueryBitmap - bitmap specifying which sub queries this feature applies to

addRangeFeature

public void addRangeFeature(PredicateQueryItem.RangeEntry entry)

Adds a range feature with a given value to the predicate query.

Parameters:

entry - the feature to add

getFeatures

public Collection<PredicateQueryItem.Entry> getFeatures()

Returns a mutable collection of feature entries.

getRangeFeatures

public Collection<PredicateQueryItem.RangeEntry> getRangeFeatures()

Returns a mutable collection of range feature entries.

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

encode

public int encode(ByteBuffer buffer)

Specified by:

encode 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 appended by this method.

Specified by:

appendBodyString in class Item

clone

public PredicateQueryItem clone()

Description copied from class: Item

Returns a deep copy of this item

Overrides:

clone 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 Item

hashCode

public int hashCode()

Overrides:

hashCode in class Item