Package com.yahoo.search.yql

Class YqlParser

java.lang.Object

com.yahoo.search.yql.YqlParser

All Implemented Interfaces:

Parser

public class YqlParser
extends Object
implements Parser

The YQL query language. This class must be kept in lockstep with VespaSerializer. Adding anything here will usually require a corresponding addition in VespaSerializer.

Author:

Steinar Knutsen, Stian Kristoffersen, Simon Thoresen Hult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCENT_DROP
static final String	ALTERNATIVES
static final String	AND_SEGMENTING
static final String	ANNOTATIONS
static final String	APPROXIMATE
static final String	ASCENDING_HITS_ORDER
static final String	BOUNDS
static final String	BOUNDS_LEFT_OPEN
static final String	BOUNDS_OPEN
static final String	BOUNDS_RIGHT_OPEN
static final String	CONNECTION_ID
static final String	CONNECTION_WEIGHT
static final String	CONNECTIVITY
static final Integer	DEFAULT_TARGET_NUM_HITS
static final String	DESCENDING_HITS_ORDER
static final String	DISTANCE
static final String	DISTANCE_THRESHOLD
static final String	DOT_PRODUCT
static final String	END_ANCHOR
static final String	EQUIV
static final String	FILTER
static final String	FUZZY
static final String	GEO_LOCATION
static final String	HIT_LIMIT
static final String	HNSW_EXPLORE_ADDITIONAL_HITS
static final String	IMPLICIT_TRANSFORMS
static final String	LABEL
static final String	MAX_EDIT_DISTANCE
static final String	NEAR
static final String	NEAREST_NEIGHBOR
static final String	NFKC
static final String	NORMALIZE_CASE
static final String	ONEAR
static final String	ORIGIN
static final String	ORIGIN_LENGTH
static final String	ORIGIN_OFFSET
static final String	ORIGIN_ORIGINAL
static final String	PHRASE
static final String	PREDICATE
static final String	PREFIX
static final String	PREFIX_LENGTH
static final String	RANGE
static final String	RANK
static final String	RANKED
static final String	SAME_ELEMENT
static final String	SCORE_THRESHOLD
static final String	SIGNIFICANCE
static final String	SORTING_FUNCTION
static final String	SORTING_LOCALE
static final String	SORTING_STRENGTH
static final String	START_ANCHOR
static final String	STEM
static final String	SUBSTRING
static final String	SUFFIX
static final String	TARGET_HITS
static final String	TARGET_NUM_HITS
static final String	THRESHOLD_BOOST_FACTOR
static final String	UNIQUE_ID
static final String	URI
static final String	USE_POSITION_DATA
static final String	USER_INPUT_LANGUAGE
static final String	WAND
static final String	WEAK_AND
static final String	WEIGHT
static final String	WEIGHTED_SET

Constructor Summary

Constructors

Constructor	Description
YqlParser(ParserEnvironment environment)

Method Summary

Modifier and Type	Method	Description
List<VespaGroupingStep>	getGroupingSteps()
Integer	getHits()	Give the number of hits expected from the latest parsed query if anything is explicitly specified.
Integer	getOffset()	Give the offset expected from the latest parsed query if anything is explicitly specified.
Sorting	getSorting()	The sorting specified in the YQL+ query last parsed.
Integer	getTimeout()	The timeout specified in the YQL+ query last parsed.
Set<String>	getYqlSummaryFields()
boolean	isQueryParser()
QueryTree	parse(Parsable query)	Parser the given Parsable, and returns a corresponding QueryTree.
void	setQueryParser(boolean queryParser)
void	setUserQuery(Query userQuery)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DESCENDING_HITS_ORDER

public static final String DESCENDING_HITS_ORDER

See Also:

• Constant Field Values

ASCENDING_HITS_ORDER

public static final String ASCENDING_HITS_ORDER

See Also:

• Constant Field Values

DEFAULT_TARGET_NUM_HITS

public static final Integer DEFAULT_TARGET_NUM_HITS

ANNOTATIONS

public static final String ANNOTATIONS

See Also:

• Constant Field Values

NFKC

public static final String NFKC

See Also:

• Constant Field Values

USER_INPUT_LANGUAGE

public static final String USER_INPUT_LANGUAGE

See Also:

• Constant Field Values

START_ANCHOR

public static final String START_ANCHOR

See Also:

• Constant Field Values

END_ANCHOR

public static final String END_ANCHOR

See Also:

• Constant Field Values

SORTING_FUNCTION

public static final String SORTING_FUNCTION

See Also:

• Constant Field Values

SORTING_LOCALE

public static final String SORTING_LOCALE

See Also:

• Constant Field Values

SORTING_STRENGTH

public static final String SORTING_STRENGTH

See Also:

• Constant Field Values

ACCENT_DROP

public static final String ACCENT_DROP

See Also:

• Constant Field Values

ALTERNATIVES

public static final String ALTERNATIVES

See Also:

• Constant Field Values

AND_SEGMENTING

public static final String AND_SEGMENTING

See Also:

• Constant Field Values

APPROXIMATE

public static final String APPROXIMATE

See Also:

• Constant Field Values

BOUNDS

public static final String BOUNDS

See Also:

• Constant Field Values

BOUNDS_LEFT_OPEN

public static final String BOUNDS_LEFT_OPEN

See Also:

• Constant Field Values

BOUNDS_OPEN

public static final String BOUNDS_OPEN

See Also:

• Constant Field Values

BOUNDS_RIGHT_OPEN

public static final String BOUNDS_RIGHT_OPEN

See Also:

• Constant Field Values

CONNECTION_ID

public static final String CONNECTION_ID

See Also:

• Constant Field Values

CONNECTION_WEIGHT

public static final String CONNECTION_WEIGHT

See Also:

• Constant Field Values

CONNECTIVITY

public static final String CONNECTIVITY

See Also:

• Constant Field Values

DISTANCE

public static final String DISTANCE

See Also:

• Constant Field Values

DISTANCE_THRESHOLD

public static final String DISTANCE_THRESHOLD

See Also:

• Constant Field Values

DOT_PRODUCT

public static final String DOT_PRODUCT

See Also:

• Constant Field Values

EQUIV

public static final String EQUIV

See Also:

• Constant Field Values

FILTER

public static final String FILTER

See Also:

• Constant Field Values

GEO_LOCATION

public static final String GEO_LOCATION

See Also:

• Constant Field Values

HIT_LIMIT

public static final String HIT_LIMIT

See Also:

• Constant Field Values

HNSW_EXPLORE_ADDITIONAL_HITS

public static final String HNSW_EXPLORE_ADDITIONAL_HITS

See Also:

• Constant Field Values

IMPLICIT_TRANSFORMS

public static final String IMPLICIT_TRANSFORMS

See Also:

• Constant Field Values

LABEL

public static final String LABEL

See Also:

• Constant Field Values

NEAR

public static final String NEAR

See Also:

• Constant Field Values

NEAREST_NEIGHBOR

public static final String NEAREST_NEIGHBOR

See Also:

• Constant Field Values

NORMALIZE_CASE

public static final String NORMALIZE_CASE

See Also:

• Constant Field Values

ONEAR

public static final String ONEAR

See Also:

• Constant Field Values

ORIGIN

public static final String ORIGIN

See Also:

• Constant Field Values

ORIGIN_LENGTH

public static final String ORIGIN_LENGTH

See Also:

• Constant Field Values

ORIGIN_OFFSET

public static final String ORIGIN_OFFSET

See Also:

• Constant Field Values

ORIGIN_ORIGINAL

public static final String ORIGIN_ORIGINAL

See Also:

• Constant Field Values

PHRASE

public static final String PHRASE

See Also:

• Constant Field Values

PREDICATE

public static final String PREDICATE

See Also:

• Constant Field Values

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

RANGE

public static final String RANGE

See Also:

• Constant Field Values

RANK

public static final String RANK

See Also:

• Constant Field Values

RANKED

public static final String RANKED

See Also:

• Constant Field Values

SAME_ELEMENT

public static final String SAME_ELEMENT

See Also:

• Constant Field Values

SCORE_THRESHOLD

public static final String SCORE_THRESHOLD

See Also:

• Constant Field Values

SIGNIFICANCE

public static final String SIGNIFICANCE

See Also:

• Constant Field Values

STEM

public static final String STEM

See Also:

• Constant Field Values

SUBSTRING

public static final String SUBSTRING

See Also:

• Constant Field Values

SUFFIX

public static final String SUFFIX

See Also:

• Constant Field Values

TARGET_HITS

public static final String TARGET_HITS

See Also:

• Constant Field Values

TARGET_NUM_HITS

public static final String TARGET_NUM_HITS

See Also:

• Constant Field Values

THRESHOLD_BOOST_FACTOR

public static final String THRESHOLD_BOOST_FACTOR

See Also:

• Constant Field Values

UNIQUE_ID

public static final String UNIQUE_ID

See Also:

• Constant Field Values

URI

public static final String URI

See Also:

• Constant Field Values

USE_POSITION_DATA

public static final String USE_POSITION_DATA

See Also:

• Constant Field Values

WAND

public static final String WAND

See Also:

• Constant Field Values

WEAK_AND

public static final String WEAK_AND

See Also:

• Constant Field Values

WEIGHT

public static final String WEIGHT

See Also:

• Constant Field Values

WEIGHTED_SET

public static final String WEIGHTED_SET

See Also:

• Constant Field Values

FUZZY

public static final String FUZZY

See Also:

• Constant Field Values

MAX_EDIT_DISTANCE

public static final String MAX_EDIT_DISTANCE

See Also:

• Constant Field Values

PREFIX_LENGTH

public static final String PREFIX_LENGTH

See Also:

• Constant Field Values

Constructor Details

YqlParser

public YqlParser(ParserEnvironment environment)

Method Details

parse

public QueryTree parse(Parsable query)

Description copied from interface: Parser

Parser the given Parsable, and returns a corresponding QueryTree. If parsing fails without an exception, the contained root will be an instance of NullItem.

Specified by:

parse in interface Parser

Parameters:

query - the Parsable to parse

Returns:

the parsed QueryTree, never null

isQueryParser

public boolean isQueryParser()

setQueryParser

public void setQueryParser(boolean queryParser)

setUserQuery

public void setUserQuery(Query userQuery)

getYqlSummaryFields

public Set<String> getYqlSummaryFields()

getGroupingSteps

public List<VespaGroupingStep> getGroupingSteps()

getOffset

public Integer getOffset()

Give the offset expected from the latest parsed query if anything is explicitly specified.

Returns:

an Integer instance or null

getHits

public Integer getHits()

Give the number of hits expected from the latest parsed query if anything is explicitly specified.

Returns:

an Integer instance or null

getTimeout

public Integer getTimeout()

The timeout specified in the YQL+ query last parsed.

Returns:

an Integer instance or null

getSorting

public Sorting getSorting()

The sorting specified in the YQL+ query last parsed.

Returns:

a Sorting instance or null