@ExportPackage @PublicApi

Package com.yahoo.prelude.query

The query model representing a boolean combination of selection criterions, where elements may be simple criterions, nested boolean operators, or annotated pieces of natural language text.

See: Description

Interface Summary

Interface	Description
BlockItem	An interface used for anything which represents a single block of query input.
HasIndexItem	An interface for items where it is useful to access an associated index name.
IndexedItem	Interface for Items that is indexed
TaggableItem	An interface used for anything which may be addressed using an external, unique ID in the query tree in the backend.

Class Summary

Class	Description
AndItem	An and'ing of a collection of sub-expressions
AndSegmentItem	An immutable and'ing of a collection of sub-expressions.
CompositeIndexedItem	Common implementation for Item classes implementing the IndexedItem interface.
CompositeItem	Superclass of expressions which contains a collection of sub-expressions
CompositeItem.ListIteratorWrapper	Handles mutator calls correctly
CompositeTaggableItem	Common implementation for Item classes implementing the TaggableItem interface.
DotProductItem	A weighted set query item to be evaluated as a sparse dot product.
EquivItem	An Item where each child is an alternative which can be matched.
ExactStringItem	Used to signal that this term requires exact match if the backend supports it.
FalseItem	A query item which never matches.
Highlight	Class encapsulating information on extra highlight-terms for a query
IndexedSegmentItem	Common implementation for Item classes implementing the IndexedItem interface.
IntItem	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]
Item	A term of the query language.
ItemHelper	Helper function for Item
Limit	An immutable numeric range limit which can be inclusive or exclusive
MarkerWordItem	Special words known by the index used for marking things.
NearItem	A set of terms which must be near each other to match.
NonReducibleCompositeItem	A composite item which specifies semantics which are not maintained if an instance with a single child is replaced by the single child.
NotItem	A composite item where the first item is positive and the following items are negative items which should be excluded from the result.
NullItem	A place holder for null queries to make searchers easier to write.
ONearItem	Ordered NearItem.
OrItem	An or'ing of a collection of sub-expressions
PhraseItem	A term which contains a phrase - a collection of word terms
PhraseSegmentItem	A term which contains a fixed length phrase, a collection of word terms, resulting from a single segmentation operation.
PredicateQueryItem	A PredicateQueryItem is a collection of feature/value-pairs that are used to query predicate fields, which contains boolean constraints.
PredicateQueryItem.Entry
PredicateQueryItem.EntryBase
PredicateQueryItem.RangeEntry
PrefixItem	A word which matches beginnings of words instead of complete words
PureWeightedInteger
PureWeightedItem
PureWeightedString
QueryCanonicalizer	Query normalizer and sanity checker.
QueryCanonicalizer.CanonicalizationResult
RangeItem	This class represents a numeric range.
RankItem	Represents the rank operator, which only orders the result set and does not change which hits are returned.
RegExpItem	Match a field with the contained regular expression.
SameElementItem	This represents a query where all terms are required to match in the same element id.
SegmentItem	An immutable and'ing of a collection of sub-expressions.
SimpleIndexedItem	Common implementation for Item classes implementing the IndexedItem interface.
SimpleTaggableItem	Common implementation for Item classes implementing the TaggableItem interface.
Substring	An substring which also provides access to the full (query) string it is a substring of.
SubstringItem	A word that matches substrings of words
SuffixItem	A word that matches a suffix of words instead of a complete word.
TaggableSegmentItem	Common implementation for Item classes implementing the TaggableItem interface.
TermItem	A query term, that is, not only a term in the query language (an item), but also a term to be found in (or excluded from) the search index.
TermType	A term type enumeration
ToolBox	Query tree helper methods and factories.
ToolBox.QueryVisitor
WandItem	A weighted set query item to be evaluated as a Wand with dot product scoring.
WeakAndItem	Weak And of a collection of sub-expressions: this behaves like an OR unless many hits are returned and then it starts acting more like an AND.
WeightedSetItem	A term which contains a weighted set.
WordAlternativesItem	A set words with differing exactness scores to be used for literal boost ranking.
WordAlternativesItem.Alternative
WordItem	A term item containing a single word.

Enum Summary

Enum	Description
Item.ItemCreator	The definitions in Item.ItemCreator must match the ones in searchlib/src/searchlib/parsequery/parse.h
Item.ItemType	The definitions in Item.ItemType must match the ones in searchlib/src/searchlib/parsequery/parse.h
SegmentingRule	If a term has to be resegmented, and the result is more than one word, this is how the result should be handled in the query tree.

Exception Summary

Exception	Description
QueryException	Runtime exception to mark errors in query parsing.

Package com.yahoo.prelude.query Description

The query model representing a boolean combination of selection criterions, where elements may be simple criterions, nested boolean operators, or annotated pieces of natural language text.