com.yahoo.search.yql

Class YqlParser

java.lang.Object

com.yahoo.search.yql.YqlParser

All Implemented Interfaces:

Parser

@Beta
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 and Description
static String	SORTING_FUNCTION
static String	SORTING_LOCALE
static String	SORTING_STRENGTH

Constructor Summary

Constructors

Constructor and Description
YqlParser(ParserEnvironment environment)

Method Summary

Modifier and Type	Method and 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

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

Constructor Detail

YqlParser

public YqlParser(ParserEnvironment environment)

Method Detail

parse

@NonNull
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

@Beta
public boolean isQueryParser()

setQueryParser

@Beta
public void setQueryParser(boolean queryParser)

setUserQuery

@Beta
public void setUserQuery(@NonNull
                               Query userQuery)

getYqlSummaryFields

@Beta
public Set<String> getYqlSummaryFields()

getGroupingSteps

@Beta
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