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 String`	`ACCENT_DROP`
`static String`	`ALTERNATIVES`
`static String`	`AND_SEGMENTING`
`static String`	`ANNOTATIONS`
`static String`	`APPROXIMATE`
`static String`	`ASCENDING_HITS_ORDER`
`static String`	`BOUNDS`
`static String`	`BOUNDS_LEFT_OPEN`
`static String`	`BOUNDS_OPEN`
`static String`	`BOUNDS_RIGHT_OPEN`
`static String`	`CONNECTION_ID`
`static String`	`CONNECTION_WEIGHT`
`static String`	`CONNECTIVITY`
`static Integer`	`DEFAULT_TARGET_NUM_HITS`
`static String`	`DESCENDING_HITS_ORDER`
`static String`	`DISTANCE`
`static String`	`DISTANCE_THRESHOLD`
`static String`	`DOT_PRODUCT`
`static String`	`END_ANCHOR`
`static String`	`EQUIV`
`static String`	`FILTER`
`static String`	`FUZZY`
`static String`	`GEO_LOCATION`
`static String`	`HIT_LIMIT`
`static String`	`HNSW_EXPLORE_ADDITIONAL_HITS`
`static String`	`IMPLICIT_TRANSFORMS`
`static String`	`LABEL`
`static String`	`NEAR`
`static String`	`NEAREST_NEIGHBOR`
`static String`	`NFKC`
`static String`	`NORMALIZE_CASE`
`static String`	`ONEAR`
`static String`	`ORIGIN`
`static String`	`ORIGIN_LENGTH`
`static String`	`ORIGIN_OFFSET`
`static String`	`ORIGIN_ORIGINAL`
`static String`	`PHRASE`
`static String`	`PREDICATE`
`static String`	`PREFIX`
`static String`	`RANGE`
`static String`	`RANK`
`static String`	`RANKED`
`static String`	`SAME_ELEMENT`
`static String`	`SCORE_THRESHOLD`
`static String`	`SIGNIFICANCE`
`static String`	`SORTING_FUNCTION`
`static String`	`SORTING_LOCALE`
`static String`	`SORTING_STRENGTH`
`static String`	`START_ANCHOR`
`static String`	`STEM`
`static String`	`SUBSTRING`
`static String`	`SUFFIX`
`static String`	`TARGET_HITS`
`static String`	`TARGET_NUM_HITS`
`static String`	`THRESHOLD_BOOST_FACTOR`
`static String`	`UNIQUE_ID`
`static String`	`URI`
`static String`	`USE_POSITION_DATA`
`static String`	`USER_INPUT_LANGUAGE`
`static String`	`WAND`
`static String`	`WEAK_AND`
`static String`	`WEIGHT`
`static String`	`WEIGHTED_SET`

Constructor Summary

Constructors
Constructor Description

YqlParser(ParserEnvironment environment)

Method Summary

All Methods Instance Methods Concrete Methods
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 Detail
  - 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
- Constructor Detail
  - YqlParser
```
public YqlParser(ParserEnvironment environment)
```
- Method Detail
  - 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

Class YqlParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DESCENDING_HITS_ORDER

ASCENDING_HITS_ORDER

DEFAULT_TARGET_NUM_HITS

ANNOTATIONS

NFKC

USER_INPUT_LANGUAGE

START_ANCHOR

END_ANCHOR

SORTING_FUNCTION

SORTING_LOCALE

SORTING_STRENGTH

ACCENT_DROP

ALTERNATIVES

AND_SEGMENTING

APPROXIMATE

BOUNDS

BOUNDS_LEFT_OPEN

BOUNDS_OPEN

BOUNDS_RIGHT_OPEN

CONNECTION_ID

CONNECTION_WEIGHT

CONNECTIVITY

DISTANCE

DISTANCE_THRESHOLD

DOT_PRODUCT

EQUIV

FILTER

GEO_LOCATION

HIT_LIMIT

HNSW_EXPLORE_ADDITIONAL_HITS

IMPLICIT_TRANSFORMS

LABEL

NEAR

NEAREST_NEIGHBOR

NORMALIZE_CASE

ONEAR

ORIGIN

ORIGIN_LENGTH

ORIGIN_OFFSET

ORIGIN_ORIGINAL

PHRASE

PREDICATE

PREFIX

RANGE

RANK

RANKED

SAME_ELEMENT

SCORE_THRESHOLD

SIGNIFICANCE

STEM

SUBSTRING

SUFFIX

TARGET_HITS

TARGET_NUM_HITS

THRESHOLD_BOOST_FACTOR

UNIQUE_ID

URI

USE_POSITION_DATA

WAND

WEAK_AND

WEIGHT

WEIGHTED_SET

FUZZY

Constructor Detail

YqlParser

Method Detail

parse

isQueryParser

setQueryParser

setUserQuery

getYqlSummaryFields

getGroupingSteps

getOffset

getHits