Package com.yahoo.schema.parser

Class SchemaParser

java.lang.Object

com.yahoo.schema.parser.SchemaParser

All Implemented Interfaces:

SchemaParserConstants

public class SchemaParser
extends Object
implements SchemaParserConstants

The schema parser NOTE: When this grammar is changed, also change integration/intellij/src/main/bnf/ai/vespa/intellij/schema/parser/sd.bnf

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field	Description
Token	jj_nt	Next token.
Token	token	Current token.
SchemaParserTokenManager	token_source	Generated Token Manager.

Fields inherited from interface com.yahoo.schema.parser.SchemaParserConstants

ADJUST_TARGET, ALIAS, ALLOW_DROP_ALL, ALWAYS, ANNOTATION, ANNOTATIONREFERENCE, APPROXIMATE_THRESHOLD, ARITY, ARRAY, AS, ASCENDING, ATTRIBUTE, BOLDING, BRACE_ML_CONTENT, BRACE_ML_LEVEL_1, BRACE_ML_LEVEL_2, BRACE_ML_LEVEL_3, BRACE_SL_CONTENT, BRACE_SL_LEVEL_1, BRACE_SL_LEVEL_2, BRACE_SL_LEVEL_3, BTREE, CASED, COLON, COMMA, CONSTANT, CONSTANTS, CONTEXT, CREATE_IF_NONEXISTENT, CUTOFF_FACTOR, CUTOFF_STRATEGY, DEFAULT, DENSE_POSTING_LIST_THRESHOLD, DESCENDING, DICTIONARY, DIRECT, DISTANCE_METRIC, DIVERSITY, DOCUMENT, DOCUMENT_SUMMARY, DOT, DOUBLE, DOUBLE_KEYWORD, DOUBLEQUOTEDSTRING, DYNAMIC, ELEMENT_GAP, ENABLE_BIT_VECTORS, ENABLE_BM25, ENABLE_ONLY_BIT_VECTOR, EOF, EVALUATION_POINT, EXACT, EXACT_TERMINATOR, EXECUTION_MODE, EXPLORATION_SLACK, EXPRESSION_ML, EXPRESSION_SL, FALSE, FAST_ACCESS, FAST_RANK, FAST_SEARCH, FIELD, FIELDS, FIELDSET, FILE, FILE_PATH, FILTER, FILTER_FIRST_EXPLORATION, FILTER_FIRST_THRESHOLD, FILTER_THRESHOLD, FIRST_PHASE, FLOAT_KEYWORD, FROM_DISK, FULL, FUNCTION, GLOBAL_PHASE, GPU_DEVICE, GRAM, GRAM_SIZE, GREATERTHAN, HASH, HNSW, HTTP, ID, IDENTICAL, IDENTIFIER, IDENTIFIER_WITH_DASH, IGNORE_DEFAULT_RANK_FEATURES, IMPORT, INDEX, INDEXING, INFINITY, INHERITS, INLINE, INPUTS, INTEGER, INTEROP_THREADS, INTRAOP_THREADS, KEEP_RANK_COUNT, LBRACE, LESSTHAN, LITERAL, LOCALE, LONG, LONG_KEYWORD, LOOSE, LOWER_BOUND, LOWERCASE, MACRO, MAP, MATCH, MATCH_PHASE, MATCHED_ELEMENTS_ONLY, MATCHFEATURES_ML, MATCHFEATURES_ML_INHERITS, MATCHFEATURES_SL, MAX_FILTER_COVERAGE, MAX_HITS, MAX_LENGTH, MAX_LINKS_PER_NODE, MAX_OCCURRENCES, MAX_TOKEN_LENGTH, MIN_GROUPS, MIN_HITS_PER_THREAD, MODEL, MTOKEN, MULTI_THREADED_INDEXING, MUTABLE, MUTATE, NEIGHBORS_TO_EXPLORE_AT_INSERT, NEVER, NL, NONE, NORMAL, NORMALIZING, NUM_SEARCH_PARTITIONS, NUM_THREADS_PER_SEARCH, OFF, OMIT_SUMMARY_FEATURES, ON, ON_DEMAND, ON_FIRST_PHASE, ON_MATCH, ON_SECOND_PHASE, ON_SUMMARY, ONNX_INPUT_SL, ONNX_MODEL, ONNX_OUTPUT_SL, OPERATION, ORDER, PAGED, PARALLEL, POST_FILTER_THRESHOLD, PRE_POST_FILTER_TIPPING_POINT, PREFIX, PRIMARY, PROPERTIES, QUATERNARY, QUERY, QUERY_COMMAND, QUESTIONMARK, RANK, RANK_PROFILE, RANK_PROPERTIES, RANK_SCORE_DROP_LIMIT, RANK_TYPE, RANKFEATURES_ML, RANKFEATURES_SL, RAW, RAW_AS_BASE64_IN_SUMMARY, RBRACE, REFERENCE, REMOVE_IF_ZERO, RERANK_COUNT, SCHEMA, SEARCH, SEARCHLIB_SKIP, SECOND_PHASE, SECONDARY, SELECT_ELEMENTS_BY_SL, SEQUENTIAL, SIGNIFICANCE, SINGLE_LINE_COMMENT, SINGLEQUOTEDSTRING, SORTING, SOURCE, SSCONTEXTUAL, SSOVERRIDE, SSTITLE, SSURL, STATIC, STEMMING, STOPWORD_LIMIT, STRENGTH, STRICT, STRING, STRING_KEYWORD, STRUCT, STRUCT_FIELD, SUBSTRING, SUFFIX, SUMMARY, SUMMARY_TO, SUMMARYFEATURES_ML, SUMMARYFEATURES_ML_INHERITS, SUMMARYFEATURES_SL, SYMMETRIC, TARGET_HITS_MAX_ADJUSTMENT_FACTOR, TENSOR_TYPE, TENSOR_VALUE_ML, TENSOR_VALUE_SL, TERMWISE_LIMIT, TERTIARY, TEXT, TO, tokenImage, TOKENS, TRUE, TYPE, UCA, UNCASED, UPPER_BOUND, URI, URI_PATH, USE_MODEL, VARIABLE, WEAKAND, WEIGHT, WEIGHTEDSET, WORD

Constructor Summary

Constructors

Constructor	Description
SchemaParser(CharStream stream)	Constructor with user supplied CharStream.
SchemaParser(SchemaParserTokenManager tm)	Constructor with generated Token Manager.
SchemaParser(SimpleCharStream stream, com.yahoo.config.application.api.DeployLogger deployLogger)	Creates a parser.

Method Summary

Modifier and Type	Method	Description
final void	alias(ParsedField field)
final void	annotation(ParsedDocument document)	Consumes an annotation block from within a document element
final void	annotationBody(ParsedAnnotation type)	Consumes a single element of an annotation body block.
final void	annotationOutside(ParsedSchema schema)	This rule consumes a annotation block from within a schema element.
final ParsedType	annotationRefDataType()
final void	approximateThreshold(ParsedRankProfile profile)	This rule consumes an approximate-threshold statement for a rank profile.
final void	arrayTensorValues(List<Double> values)	Tensor array values.
final void	attribute(ParsedField field)	This rule consumes an attribute statement of a field element.
final void	attributeSetting(ParsedAttribute attribute)	This rule consumes a single attribute setting statement of an attribute element.
final void	attributeSorting(ParsedAttribute attribute)
final void	bolding(ParsedField field)	This rule consumes a bolding statement of a field element.
final Boolean	bool()	A boolean value.
final void	constant(ParsedSchema schema, ParsedRankProfile profile)
final com.yahoo.searchlib.rankingexpression.Reference	constantName()	Returns the reference "constant(name)" for both "constant(name)" and "name".
final void	constants(ParsedSchema schema, ParsedRankProfile profile)	Consumes a set of constants available in ranking expressions in the enclosing profile.
final void	constantTensor(ParsedRankProfile profile, com.yahoo.searchlib.rankingexpression.Reference name)
final String	constantTensorErrorMessage(String rankProfileName, com.yahoo.searchlib.rankingexpression.Reference name)
final void	constantValue(ParsedRankProfile profile, com.yahoo.searchlib.rankingexpression.Reference name)
final ParsedType	dataType()	This rule consumes a data type block from within a field element.
final void	dictionary(ParsedField field)	This rule consumes a dictionary statement of a field element.
final void	dictionarySetting(ParsedField field)
final void	disable_tracing()	Disable tracing.
final void	diversity(ParsedRankProfile profile)	This rule consumes a diversity block of a rank profile.
final void	diversityDeprecated(ParsedRankProfile profile)
final void	diversityItem(RankProfile.DiversitySettings settings)
final void	document(ParsedSchema schema)	Consumes a document element.
final void	documentBody(ParsedDocument document)	Consumes a document body block
final void	documentSummary(ParsedSchema schema)	Consumes a document-summary block from within a schema block.
final void	documentSummaryItem(ParsedDocumentSummary summary)	Consumes a single document-summary item.
final ElementGap	elementGapValue()
final void	enable_tracing()	Enable tracing.
final void	exactTerminator(ParsedMatchSettings matchInfo)
final void	explorationSlack(ParsedRankProfile profile)	This rule consumes an exploration-slack statement for a rank profile.
final String	expression()	This rule consumes an expression token and returns its image.
final ParsedField	field()	Consumes a field block
final void	fieldBody(ParsedField field)	This rule consumes a single element of a field body block.
final void	fieldInsideDoc(ParsedDocument document)	Consumes a field block from within a document element.
final void	fieldOutsideDoc(ParsedSchema schema)	Consumes a field block from outside a document element.
final void	fieldRankFilter(ParsedRankProfile profile)	Consumes a rank filter statement of a rank profile.
final void	fieldRankItem(ParsedRankProfile profile, String field)
final void	fieldRankType(ParsedRankProfile profile)	Consumes a rank-type statement of a rank profile.
final void	fieldSet(ParsedSchema schema)	Consumes a fieldset block
final void	fieldSorting(ParsedField field)
final void	fieldStemming(ParsedField field)	This rule consumes a stemming block of a field element.
final void	fieldWeight(ParsedRankProfile profile)	Consumes a field-weight statement of a rank profile.
final String	fileItem()
final void	filterFirstExploration(ParsedRankProfile profile)	This rule consumes a filter-first-exploration statement for a rank profile.
final void	filterFirstThreshold(ParsedRankProfile profile)	This rule consumes a filter-first-threshold statement for a rank profile.
final void	filterThreshold(ParsedRankProfile profile)
final void	firstPhase(ParsedRankProfile profile)	Consumes the first-phase block of a rank profile.
final void	firstPhaseItem(ParsedRankProfile profile)
final double	floatValue()	Consumes a floating-point token and returns its numeric value.
final void	function(ParsedRankProfile profile)	This rule consumes a function statement of a rank-profile.
ParseException	generateParseException()	Generate ParseException.
final Token	getNextToken()
final Token	getToken(int index)
final void	globalPhase(ParsedRankProfile profile)	Consumes the global-phase block of a rank profile.
final void	globalPhaseItem(ParsedRankProfile profile)	Consumes a statement for a global-phase block.
final void	gramSize(ParsedMatchSettings matchInfo)
final void	hnswIndex(ParsedIndex index)
final void	hnswIndexBody(HnswIndexParams.Builder params)
final void	id(ParsedField field)	Consumes an id statement of a field body block.
final String	identifier()	Consumes an identifier.
final String	identifierWithDash()
final void	ignoreRankFeatures(ParsedRankProfile profile)	This rule consumes a ignore-default-rank-features statement for a rank profile.
final void	importField(ParsedSchema schema)
final void	indexBody(ParsedIndex index)	Consumes a single index statement for an index block.
final void	indexedTensorBlockValues(com.yahoo.tensor.TensorAddress mappedAddress, com.yahoo.tensor.Tensor.Builder builder)
final void	indexedTensorValue(List<Double> values)
final void	indexedTensorValues(com.yahoo.tensor.Tensor.Builder builder)
final void	indexing(ParsedField field)	This rule consumes an indexing block of a field element.
final void	indexingOperation(ParsedField field, boolean multiLine)	This rule consumes an IL script block.
final void	indexInsideField(ParsedField field)	Consumes an index block for a field element.
final void	indexOutsideDoc(ParsedSchema schema)	Consumes an index block in a schema element.
final void	inheritsAnnotation(ParsedAnnotation annotation)
final void	inheritsDocument(ParsedDocument document)	Consumes a document inheritance statement.
final void	inheritsDocumentSummary(ParsedDocumentSummary documentSummary)	This rule consumes an inherits statement of a document summary.
final void	inheritsRankProfile(ParsedRankProfile profile)	Consumes an inherits statement of a rank-profile.
final void	inheritsStruct(ParsedStruct struct)	Consumes struct inheritance
final boolean	inline()
final com.yahoo.searchlib.rankingexpression.Reference	input(ParsedRankProfile profile)
final com.yahoo.searchlib.rankingexpression.Reference	inputName()	Returns the reference "query(name)" for both "query(name)" and "name".
final void	inputs(ParsedRankProfile profile)	Consumes an inputs block of a rank profile.
final int	integer()	Consumes an integer token and returns its numeric value.
final void	lbrace()	Consumes an opening brace with leading and trailing newline tokens.
final long	longValue()	Consumes a long or integer token and returns its numeric value.
final ParsedType	mapDataType()
final void	mappedTensorBlock(com.yahoo.tensor.Tensor.Builder builder)
final void	mappedTensorCellValue(com.yahoo.tensor.TensorAddress address, com.yahoo.tensor.Tensor.Builder builder)
final void	mappedTensorValue(com.yahoo.tensor.Tensor.Builder builder)	A mapped or mixed tensor value.
final void	matchFeatures(ParsedRankProfile profile)	Consumes a match-features block of a rank profile.
final void	matchItem(ParsedMatchSettings matchInfo)	This rule consumes a single match item for a match block.
final void	matchPhase(ParsedRankProfile profile)	This rule consumes a match-phase block of a rank profile.
final void	matchPhaseItem(ParsedRankProfile profile, RankProfile.MatchPhaseSettings settings)
final void	matchSettings(ParsedMatchSettings matchInfo)
final void	matchSize(ParsedMatchSettings matchInfo)
final void	matchType(ParsedMatchSettings matchInfo)
final void	maxTermOccurrences(ParsedMatchSettings matchInfo)
final void	maxTokenLength(ParsedMatchSettings matchInfo)
final void	minHitsPerThread(ParsedRankProfile profile)	This rule consumes a min-hits-per-thread statement for a rank profile.
final void	mutate(ParsedRankProfile profile)	This rule consumes an mutate statement of a rank-profile.
final String	mutate_expr()
final void	mutate_operation(ParsedRankProfile profile)
final ParsedDocument	namedDocument()	Consumes a document element, explicitly named
final void	normalizing(ParsedField field)	This rule consumes a normalizing statement of a field element.
final Number	number()
final void	numSearchPartitions(ParsedRankProfile profile)	This rule consumes a num-search-partitions statement for a rank profile.
final void	numThreadsPerSearch(ParsedRankProfile profile)	This rule consumes a num-threads-per-search statement for a rank profile.
final OnnxModel	onnxModel()	Consumes an onnx-model block.
final void	onnxModelInProfile(ParsedRankProfile profile)
final void	onnxModelInSchema(ParsedSchema schema)
final void	onnxModelItem(OnnxModel onnxModel)	Consumes an onnx-model block.
final void	postFilterThreshold(ParsedRankProfile profile)	This rule consumes a post-filter-threshold statement for a rank profile.
final void	queryCommand(ParsedField field)
final String	quotedString()	Consumes a quoted string token and returns the token image minus the quotes.
final void	rank(ParsedField field)	Consumes a rank statement of a field element.
final void	rankFeatures(ParsedRankProfile profile)	Consumes a rank-features block of a rank profile
final void	rankingConstant(ParsedSchema schema)	Consumes a constant block of a schema element.
final String	rankingConstantErrorMessage(String name)
final void	rankProfile(ParsedSchema schema)	Consumes a rank-profile block of a schema element.
final void	rankProfileItem(ParsedSchema schema, ParsedRankProfile profile)	This rule consumes a single statement for a rank-profile block.
final void	rankProperties(ParsedRankProfile profile)	Consumes a rank-properties block of a rank profile.
final void	rankProperty(ParsedRankProfile profile)	Consumes a single rank property pair for a rank profile.
final String	rankPropertyItem()	Consumes a single rank property for a rank-properties block.
final void	rankSetting(ParsedField field)	Consumes a single rank setting of a rank statement.
final void	rankType(ParsedField field)	This rule consumes a rank-type statement of a field element.
final void	rawAsBase64(ParsedSchema schema)
final ParsedType	referenceType()
void	ReInit(CharStream stream)	Reinitialise.
void	ReInit(SchemaParserTokenManager tm)	Reinitialise
final ParsedSchema	rootDocument()	Consumes a schema definition that contains only documents to be used for inheritance, etc.
final ParsedSchema	rootDocumentItem(ParsedSchema schema)	Consumes a single item from within a root document node.
final ParsedSchema	rootSchema()	This rule consumes a proper schema block.
final void	rootSchemaItem(ParsedSchema schema)	Consumes an element of a schema block.
final ParsedSchema	schema()	The rule consumes any schema and returns the corresponding object.
final void	searchStemming(ParsedSchema schema)	This rule consumes a stemming statement for a schema element.
final void	secondPhase(ParsedRankProfile profile)	Consumes the second-phase block of a rank profile.
final void	secondPhaseItem(ParsedRankProfile profile)	Consumes a statement for a second-phase block.
final void	significance(ParsedRankProfile profile)
final void	significanceItem(ParsedRankProfile profile)
final void	sorting(ParsedSorting sort)
final void	sortingSetting(ParsedSorting sorting)
final void	strict(ParsedRankProfile profile)
final String	string()	Consumes a string token and returns the token image.
final ParsedStruct	structDefinition()	This rule consumes a struct declaration block
final void	structField(ParsedField field)	This rule consumes a struct subfield from a document field body.
final void	structFieldBody(ParsedField field)	This rule consumes a single element of a struct subfield body block.
final void	structFieldDefinition(ParsedStruct struct)	This rule consumes a field block of a struct body.
final void	structInside(ParsedDocument document)	This rule consumes a struct block from within a document element.
final void	structOutside(ParsedSchema schema)	This rule consumes a struct block from within a schema element.
final void	summaryBolding(ParsedSummaryField field)	This rule consumes a bolding statement for a summary field element.
final void	summaryDestinationList(ParsedSummaryField field)	This rule consumes a destination-list statement for a summary field element.
final void	summaryElementsBy(ParsedSummaryField field)
final void	summaryElementsSelection(ParsedSummaryField field)
final void	summaryFeatures(ParsedRankProfile profile)	Consumes a summary-features block of a rank profile.
final void	summaryInDocument(ParsedDocumentSummary docsum)	This rule consumes a summary statement defined inside a document-summary block.
final void	summaryInField(ParsedField field)	The rule consumes a summary statement defined inside a field.
final void	summaryInFieldLong(ParsedField field)	This rule consumes a multi-line summary field.
final void	summaryInFieldShort(ParsedField field)	This rule consumes a single-line summary field.
final void	summaryItem(ParsedSummaryField field)	This rule consumes an item of a summary field block.
final void	summarySourceList(ParsedSummaryField field)	This rule consumes a source-list statement for a summary field element.
final void	summaryTo(ParsedField field)	This rule consumes a summary-to statement of a field element.
final void	summaryTransform(ParsedSummaryField field)	This rule consumes a transform statement for a summary field element.
final void	targetHitsMaxAdjustmentFactor(ParsedRankProfile profile)	This rule consumes a target-hits-max-adjustment-factor statement for a rank profile.
final com.yahoo.tensor.TensorAddress	tensorAddress(com.yahoo.tensor.TensorType type)
final void	tensorAddressElement(com.yahoo.tensor.TensorAddress.Builder builder)
final String	tensorAddressLabel()
final double	tensorCellValue()
final com.yahoo.tensor.TensorType	tensorType(String errorMessage)
final com.yahoo.tensor.TensorType	tensorTypeWithPrefix(String errorMessage)
final com.yahoo.tensor.Tensor	tensorValue(com.yahoo.tensor.TensorType type)	Parses a tensor written in a tensor literal form, https://docs.vespa.ai/en/reference/tensor.html#tensor-literal-form
final String	tensorValuePrefixedByValue()	Undocumented syntax for supplying a tensor constant value by a string prefixed by "value"
final void	termwiseLimit(ParsedRankProfile profile)	This rule consumes a termwise-limit statement for a rank profile.
final boolean	trace_enabled()
final String	uriItem()
final com.yahoo.search.schema.RankProfile.InputType	valueType(com.yahoo.searchlib.rankingexpression.Reference reference)
final void	weakand(ParsedRankProfile profile)
final void	weakandAdjustTarget(ParsedRankProfile profile)
final void	weakandAllowDropAll(ParsedRankProfile profile)
final void	weakandItem(ParsedRankProfile profile)
final void	weakandStopwordLimit(ParsedRankProfile profile)
final void	weight(ParsedField field)	This rule consumes a weight statement of a field element.
final void	weightedset(ParsedType fieldType)	This rule consumes a weighted set statement of a field element.
final void	weightedsetBody(ParsedType type)	This rule consumes one body item of a weighted set block.

Methods inherited from class java.lang.Object

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

Field Details

token_source

public SchemaParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Details

SchemaParser

public SchemaParser(SimpleCharStream stream,
 com.yahoo.config.application.api.DeployLogger deployLogger)

Creates a parser.

SchemaParser

public SchemaParser(CharStream stream)

Constructor with user supplied CharStream.

Parameters:

stream - stream to init with

SchemaParser

public SchemaParser(SchemaParserTokenManager tm)

Constructor with generated Token Manager.

Parameters:

tm - Token manager to use

Method Details

schema

public final ParsedSchema schema()
                          throws ParseException

The rule consumes any schema and returns the corresponding object. This is the only production that should ever consume leading newlines.

Returns:

the schema object

Throws:

ParseException

rootSchema

public final ParsedSchema rootSchema()
                              throws ParseException

This rule consumes a proper schema block. This and rootDocument() are the only rules that should ever consume trailing newline tokens.

Returns:

the schema definition object.

Throws:

ParseException

rootSchemaItem

public final void rootSchemaItem(ParsedSchema schema)
                          throws ParseException

Consumes an element of a schema block. This and rootSearch() are the only rules that should ever consume trailing newline tokens.

Parameters:

schema - the schema object to modify.

Throws:

ParseException

rootDocument

public final ParsedSchema rootDocument()
                                throws ParseException

Consumes a schema definition that contains only documents to be used for inheritance, etc.

Returns:

the schema definition object.

Throws:

ParseException

rootDocumentItem

public final ParsedSchema rootDocumentItem(ParsedSchema schema)
                                    throws ParseException

Consumes a single item from within a root document node.

Parameters:

schema - the schema object to modify.

Throws:

ParseException

document

public final void document(ParsedSchema schema)
                    throws ParseException

Consumes a document element. The name defaults to the schema's name, but may be set.

Parameters:

schema - the schema object to add content to.

Throws:

ParseException

namedDocument

public final ParsedDocument namedDocument()
                                   throws ParseException

Consumes a document element, explicitly named

Throws:

ParseException

documentBody

public final void documentBody(ParsedDocument document)
                        throws ParseException

Consumes a document body block

Parameters:

document - the document type to modify.

Throws:

ParseException

rawAsBase64

public final void rawAsBase64(ParsedSchema schema)
                       throws ParseException

Throws:

ParseException

inheritsStruct

public final void inheritsStruct(ParsedStruct struct)
                          throws ParseException

Consumes struct inheritance

Parameters:

struct - The struct type to modify.

Throws:

ParseException

inheritsDocument

public final void inheritsDocument(ParsedDocument document)
                            throws ParseException

Consumes a document inheritance statement.

Parameters:

document - The document type to modify.

Throws:

ParseException

fieldInsideDoc

public final void fieldInsideDoc(ParsedDocument document)
                          throws ParseException

Consumes a field block from within a document element.

Parameters:

document - the document type to modify

Throws:

ParseException

fieldOutsideDoc

public final void fieldOutsideDoc(ParsedSchema schema)
                           throws ParseException

Consumes a field block from outside a document element.

Parameters:

schema - the schema to modify

Throws:

ParseException

field

public final ParsedField field()
                        throws ParseException

Consumes a field block

Throws:

ParseException

fieldSet

public final void fieldSet(ParsedSchema schema)
                    throws ParseException

Consumes a fieldset block

Throws:

ParseException

annotationOutside

public final void annotationOutside(ParsedSchema schema)
                             throws ParseException

This rule consumes a annotation block from within a schema element.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

annotation

public final void annotation(ParsedDocument document)
                      throws ParseException

Consumes an annotation block from within a document element

Parameters:

document - the document object to add content to

Throws:

ParseException

annotationBody

public final void annotationBody(ParsedAnnotation type)
                          throws ParseException

Consumes a single element of an annotation body block.

Throws:

ParseException

inheritsAnnotation

public final void inheritsAnnotation(ParsedAnnotation annotation)
                              throws ParseException

Throws:

ParseException

structInside

public final void structInside(ParsedDocument document)
                        throws ParseException

This rule consumes a struct block from within a document element.

Parameters:

document - the document object to add content to

Throws:

ParseException

structOutside

public final void structOutside(ParsedSchema schema)
                         throws ParseException

This rule consumes a struct block from within a schema element.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

structDefinition

public final ParsedStruct structDefinition()
                                    throws ParseException

This rule consumes a struct declaration block

Throws:

ParseException

dataType

public final ParsedType dataType()
                          throws ParseException

This rule consumes a data type block from within a field element.

Returns:

the consumed data type

Throws:

ParseException

referenceType

public final ParsedType referenceType()
                               throws ParseException

Throws:

ParseException

annotationRefDataType

public final ParsedType annotationRefDataType()
                                       throws ParseException

Throws:

ParseException

mapDataType

public final ParsedType mapDataType()
                             throws ParseException

Throws:

ParseException

structFieldDefinition

public final void structFieldDefinition(ParsedStruct struct)
                                 throws ParseException

This rule consumes a field block of a struct body.

Parameters:

struct - The struct to modify.

Throws:

ParseException

structField

public final void structField(ParsedField field)
                       throws ParseException

This rule consumes a struct subfield from a document field body. This is not to be confused with a document struct's fields, but rather this is a subfield of a document field of type struct.

Parameters:

field - the field to modify

Throws:

ParseException

fieldBody

public final void fieldBody(ParsedField field)
                     throws ParseException

This rule consumes a single element of a field body block.

Parameters:

field - the field being built

Throws:

ParseException

structFieldBody

public final void structFieldBody(ParsedField field)
                           throws ParseException

This rule consumes a single element of a struct subfield body block. Only elements that are supported in streaming schema and indexed schema (with complex attributes) are allowed.

Parameters:

field - the field being built

Throws:

ParseException

indexing

public final void indexing(ParsedField field)
                    throws ParseException

This rule consumes an indexing block of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

indexingOperation

public final void indexingOperation(ParsedField field,
 boolean multiLine)
                             throws ParseException

This rule consumes an IL script block. This is expected to consume trailing newlines.

Parameters:

field - The field to modify.

Throws:

ParseException

summaryTo

public final void summaryTo(ParsedField field)
                     throws ParseException

This rule consumes a summary-to statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

weight

public final void weight(ParsedField field)
                  throws ParseException

This rule consumes a weight statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

weightedset

public final void weightedset(ParsedType fieldType)
                       throws ParseException

This rule consumes a weighted set statement of a field element.

Parameters:

fieldType - The field type to modify.

Throws:

ParseException

weightedsetBody

public final void weightedsetBody(ParsedType type)
                           throws ParseException

This rule consumes one body item of a weighted set block.

Parameters:

type - The field type to modify.

Throws:

ParseException

rankType

public final void rankType(ParsedField field)
                    throws ParseException

This rule consumes a rank-type statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

attribute

public final void attribute(ParsedField field)
                     throws ParseException

This rule consumes an attribute statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

fieldSorting

public final void fieldSorting(ParsedField field)
                        throws ParseException

Throws:

ParseException

attributeSorting

public final void attributeSorting(ParsedAttribute attribute)
                            throws ParseException

Throws:

ParseException

sorting

public final void sorting(ParsedSorting sort)
                   throws ParseException

Throws:

ParseException

sortingSetting

public final void sortingSetting(ParsedSorting sorting)
                          throws ParseException

Throws:

ParseException

attributeSetting

public final void attributeSetting(ParsedAttribute attribute)
                            throws ParseException

This rule consumes a single attribute setting statement of an attribute element.

Parameters:

attribute - The attribute to change.

Throws:

ParseException

summaryInDocument

public final void summaryInDocument(ParsedDocumentSummary docsum)
                             throws ParseException

This rule consumes a summary statement defined inside a document-summary block.

Parameters:

docsum - The document summary to modify.

Throws:

ParseException

summaryInField

public final void summaryInField(ParsedField field)
                          throws ParseException

The rule consumes a summary statement defined inside a field.

Parameters:

field - The field to modify.

Throws:

ParseException

summaryInFieldShort

public final void summaryInFieldShort(ParsedField field)
                               throws ParseException

This rule consumes a single-line summary field.

Throws:

ParseException

summaryInFieldLong

public final void summaryInFieldLong(ParsedField field)
                              throws ParseException

This rule consumes a multi-line summary field.

Throws:

ParseException

summaryItem

public final void summaryItem(ParsedSummaryField field)
                       throws ParseException

This rule consumes an item of a summary field block.

Parameters:

field - The field to modify.

Throws:

ParseException

summaryTransform

public final void summaryTransform(ParsedSummaryField field)
                            throws ParseException

This rule consumes a transform statement for a summary field element.

Parameters:

field - The field to modify.

Throws:

ParseException

summaryElementsSelection

public final void summaryElementsSelection(ParsedSummaryField field)
                                    throws ParseException

Throws:

ParseException

summaryElementsBy

public final void summaryElementsBy(ParsedSummaryField field)
                             throws ParseException

Throws:

ParseException

summaryBolding

public final void summaryBolding(ParsedSummaryField field)
                          throws ParseException

This rule consumes a bolding statement for a summary field element.

Parameters:

field - The summary field to modify.

Throws:

ParseException

summarySourceList

public final void summarySourceList(ParsedSummaryField field)
                             throws ParseException

This rule consumes a source-list statement for a summary field element.

Parameters:

field - The summary field to modify.

Throws:

ParseException

summaryDestinationList

public final void summaryDestinationList(ParsedSummaryField field)
                                  throws ParseException

This rule consumes a destination-list statement for a summary field element.

Parameters:

field - The summary field to modify.

Throws:

ParseException

fieldStemming

public final void fieldStemming(ParsedField field)
                         throws ParseException

This rule consumes a stemming block of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

searchStemming

public final void searchStemming(ParsedSchema schema)
                          throws ParseException

This rule consumes a stemming statement for a schema element.

Parameters:

schema - the schema to modify

Throws:

ParseException

normalizing

public final void normalizing(ParsedField field)
                       throws ParseException

This rule consumes a normalizing statement of a field element. At the moment, this can only be used to turn off normalizing.

Parameters:

field - The field to modify.

Throws:

ParseException

bolding

public final void bolding(ParsedField field)
                   throws ParseException

This rule consumes a bolding statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

dictionary

public final void dictionary(ParsedField field)
                      throws ParseException

This rule consumes a dictionary statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

dictionarySetting

public final void dictionarySetting(ParsedField field)
                             throws ParseException

Throws:

ParseException

queryCommand

public final void queryCommand(ParsedField field)
                        throws ParseException

Throws:

ParseException

alias

public final void alias(ParsedField field)
                 throws ParseException

Throws:

ParseException

matchSettings

public final void matchSettings(ParsedMatchSettings matchInfo)
                         throws ParseException

Throws:

ParseException

matchType

public final void matchType(ParsedMatchSettings matchInfo)
                     throws ParseException

Throws:

ParseException

matchItem

public final void matchItem(ParsedMatchSettings matchInfo)
                     throws ParseException

This rule consumes a single match item for a match block.

Parameters:

matchInfo - The settings to modify.

Throws:

ParseException

exactTerminator

public final void exactTerminator(ParsedMatchSettings matchInfo)
                           throws ParseException

Throws:

ParseException

gramSize

public final void gramSize(ParsedMatchSettings matchInfo)
                    throws ParseException

Throws:

ParseException

matchSize

public final void matchSize(ParsedMatchSettings matchInfo)
                     throws ParseException

Throws:

ParseException

maxTermOccurrences

public final void maxTermOccurrences(ParsedMatchSettings matchInfo)
                              throws ParseException

Throws:

ParseException

maxTokenLength

public final void maxTokenLength(ParsedMatchSettings matchInfo)
                          throws ParseException

Throws:

ParseException

rank

public final void rank(ParsedField field)
                throws ParseException

Consumes a rank statement of a field element.

Parameters:

field - The field to modify.

Throws:

ParseException

rankSetting

public final void rankSetting(ParsedField field)
                       throws ParseException

Consumes a single rank setting of a rank statement.

Parameters:

field - The field to modify.

Throws:

ParseException

id

public final void id(ParsedField field)
              throws ParseException

Consumes an id statement of a field body block.

Parameters:

field - The field to modify.

Throws:

ParseException

documentSummary

public final void documentSummary(ParsedSchema schema)
                           throws ParseException

Consumes a document-summary block from within a schema block.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

inheritsDocumentSummary

public final void inheritsDocumentSummary(ParsedDocumentSummary documentSummary)
                                   throws ParseException

This rule consumes an inherits statement of a document summary.

Parameters:

documentSummary - the document summary to modify

Throws:

ParseException

documentSummaryItem

public final void documentSummaryItem(ParsedDocumentSummary summary)
                               throws ParseException

Consumes a single document-summary item.

Parameters:

summary - The document summary to modify.

Throws:

ParseException

indexOutsideDoc

public final void indexOutsideDoc(ParsedSchema schema)
                           throws ParseException

Consumes an index block in a schema element.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

indexInsideField

public final void indexInsideField(ParsedField field)
                            throws ParseException

Consumes an index block for a field element.

Parameters:

field - the field to modify

Throws:

ParseException

indexBody

public final void indexBody(ParsedIndex index)
                     throws ParseException

Consumes a single index statement for an index block.

Parameters:

index - The index to modify.

Throws:

ParseException

hnswIndex

public final void hnswIndex(ParsedIndex index)
                     throws ParseException

Throws:

ParseException

hnswIndexBody

public final void hnswIndexBody(HnswIndexParams.Builder params)
                         throws ParseException

Throws:

ParseException

onnxModelInSchema

public final void onnxModelInSchema(ParsedSchema schema)
                             throws ParseException

Throws:

ParseException

onnxModelInProfile

public final void onnxModelInProfile(ParsedRankProfile profile)
                              throws ParseException

Throws:

ParseException

onnxModel

public final OnnxModel onnxModel()
                          throws ParseException

Consumes an onnx-model block.

Throws:

ParseException

onnxModelItem

public final void onnxModelItem(OnnxModel onnxModel)
                         throws ParseException

Consumes an onnx-model block.

Parameters:

onnxModel - the onnxModel to modify

Throws:

ParseException

rankingConstant

public final void rankingConstant(ParsedSchema schema)
                           throws ParseException

Consumes a constant block of a schema element.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

fileItem

public final String fileItem()
                      throws ParseException

Throws:

ParseException

uriItem

public final String uriItem()
                     throws ParseException

Throws:

ParseException

rankingConstantErrorMessage

public final String rankingConstantErrorMessage(String name)
                                         throws ParseException

Throws:

ParseException

rankProfile

public final void rankProfile(ParsedSchema schema)
                       throws ParseException

Consumes a rank-profile block of a schema element.

Parameters:

schema - the schema object to add content to

Throws:

ParseException

rankProfileItem

public final void rankProfileItem(ParsedSchema schema,
 ParsedRankProfile profile)
                           throws ParseException

This rule consumes a single statement for a rank-profile block.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

inheritsRankProfile

public final void inheritsRankProfile(ParsedRankProfile profile)
                               throws ParseException

Consumes an inherits statement of a rank-profile.

Parameters:

profile - the profile to modify

Throws:

ParseException

mutate

public final void mutate(ParsedRankProfile profile)
                  throws ParseException

This rule consumes an mutate statement of a rank-profile.

Parameters:

profile - The profile to modify.

Throws:

ParseException

mutate_operation

public final void mutate_operation(ParsedRankProfile profile)
                            throws ParseException

Throws:

ParseException

mutate_expr

public final String mutate_expr()
                         throws ParseException

Throws:

ParseException

function

public final void function(ParsedRankProfile profile)
                    throws ParseException

This rule consumes a function statement of a rank-profile.

Parameters:

profile - The profile to modify.

Throws:

ParseException

inline

public final boolean inline()
                     throws ParseException

Throws:

ParseException

matchPhase

public final void matchPhase(ParsedRankProfile profile)
                      throws ParseException

This rule consumes a match-phase block of a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

matchPhaseItem

public final void matchPhaseItem(ParsedRankProfile profile,
 RankProfile.MatchPhaseSettings settings)
                          throws ParseException

Throws:

ParseException

diversity

public final void diversity(ParsedRankProfile profile)
                     throws ParseException

This rule consumes a diversity block of a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

diversityDeprecated

public final void diversityDeprecated(ParsedRankProfile profile)
                               throws ParseException

Throws:

ParseException

diversityItem

public final void diversityItem(RankProfile.DiversitySettings settings)
                         throws ParseException

Throws:

ParseException

firstPhase

public final void firstPhase(ParsedRankProfile profile)
                      throws ParseException

Consumes the first-phase block of a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

firstPhaseItem

public final void firstPhaseItem(ParsedRankProfile profile)
                          throws ParseException

Throws:

ParseException

secondPhase

public final void secondPhase(ParsedRankProfile profile)
                       throws ParseException

Consumes the second-phase block of a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

secondPhaseItem

public final void secondPhaseItem(ParsedRankProfile profile)
                           throws ParseException

Consumes a statement for a second-phase block.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

globalPhase

public final void globalPhase(ParsedRankProfile profile)
                       throws ParseException

Consumes the global-phase block of a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

globalPhaseItem

public final void globalPhaseItem(ParsedRankProfile profile)
                           throws ParseException

Consumes a statement for a global-phase block.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

inputs

public final void inputs(ParsedRankProfile profile)
                  throws ParseException

Consumes an inputs block of a rank profile.

Throws:

ParseException

input

public final com.yahoo.searchlib.rankingexpression.Reference input(ParsedRankProfile profile)
                                                            throws ParseException

Throws:

ParseException

inputName

public final com.yahoo.searchlib.rankingexpression.Reference inputName()
                                                                throws ParseException

Returns the reference "query(name)" for both "query(name)" and "name".

Throws:

ParseException

valueType

public final com.yahoo.search.schema.RankProfile.InputType valueType(com.yahoo.searchlib.rankingexpression.Reference reference)
                                                              throws ParseException

Throws:

ParseException

summaryFeatures

public final void summaryFeatures(ParsedRankProfile profile)
                           throws ParseException

Consumes a summary-features block of a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

strict

public final void strict(ParsedRankProfile profile)
                  throws ParseException

Throws:

ParseException

significance

public final void significance(ParsedRankProfile profile)
                        throws ParseException

Throws:

ParseException

significanceItem

public final void significanceItem(ParsedRankProfile profile)
                            throws ParseException

Throws:

ParseException

weakand

public final void weakand(ParsedRankProfile profile)
                   throws ParseException

Throws:

ParseException

weakandItem

public final void weakandItem(ParsedRankProfile profile)
                       throws ParseException

Throws:

ParseException

weakandStopwordLimit

public final void weakandStopwordLimit(ParsedRankProfile profile)
                                throws ParseException

Throws:

ParseException

weakandAllowDropAll

public final void weakandAllowDropAll(ParsedRankProfile profile)
                               throws ParseException

Throws:

ParseException

weakandAdjustTarget

public final void weakandAdjustTarget(ParsedRankProfile profile)
                               throws ParseException

Throws:

ParseException

filterThreshold

public final void filterThreshold(ParsedRankProfile profile)
                           throws ParseException

Throws:

ParseException

matchFeatures

public final void matchFeatures(ParsedRankProfile profile)
                         throws ParseException

Consumes a match-features block of a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

rankFeatures

public final void rankFeatures(ParsedRankProfile profile)
                        throws ParseException

Consumes a rank-features block of a rank profile

Throws:

ParseException

ignoreRankFeatures

public final void ignoreRankFeatures(ParsedRankProfile profile)
                              throws ParseException

This rule consumes a ignore-default-rank-features statement for a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

numThreadsPerSearch

public final void numThreadsPerSearch(ParsedRankProfile profile)
                               throws ParseException

This rule consumes a num-threads-per-search statement for a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

minHitsPerThread

public final void minHitsPerThread(ParsedRankProfile profile)
                            throws ParseException

This rule consumes a min-hits-per-thread statement for a rank profile.

Parameters:

profile - The rank profile to modify.

Throws:

ParseException

numSearchPartitions

public final void numSearchPartitions(ParsedRankProfile profile)
                               throws ParseException

This rule consumes a num-search-partitions statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

termwiseLimit

public final void termwiseLimit(ParsedRankProfile profile)
                         throws ParseException

This rule consumes a termwise-limit statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

postFilterThreshold

public final void postFilterThreshold(ParsedRankProfile profile)
                               throws ParseException

This rule consumes a post-filter-threshold statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

approximateThreshold

public final void approximateThreshold(ParsedRankProfile profile)
                                throws ParseException

This rule consumes an approximate-threshold statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

filterFirstThreshold

public final void filterFirstThreshold(ParsedRankProfile profile)
                                throws ParseException

This rule consumes a filter-first-threshold statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

filterFirstExploration

public final void filterFirstExploration(ParsedRankProfile profile)
                                  throws ParseException

This rule consumes a filter-first-exploration statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

explorationSlack

public final void explorationSlack(ParsedRankProfile profile)
                            throws ParseException

This rule consumes an exploration-slack statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

targetHitsMaxAdjustmentFactor

public final void targetHitsMaxAdjustmentFactor(ParsedRankProfile profile)
                                         throws ParseException

This rule consumes a target-hits-max-adjustment-factor statement for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

rankProperties

public final void rankProperties(ParsedRankProfile profile)
                          throws ParseException

Consumes a rank-properties block of a rank profile. There is a little trick within this rule to allow the final rank property to skip the terminating newline token.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

rankProperty

public final void rankProperty(ParsedRankProfile profile)
                        throws ParseException

Consumes a single rank property pair for a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

rankPropertyItem

public final String rankPropertyItem()
                              throws ParseException

Consumes a single rank property for a rank-properties block.

Returns:

the token image of the consumed item

Throws:

ParseException

fieldWeight

public final void fieldWeight(ParsedRankProfile profile)
                       throws ParseException

Consumes a field-weight statement of a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

fieldRankType

public final void fieldRankType(ParsedRankProfile profile)
                         throws ParseException

Consumes a rank-type statement of a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

fieldRankFilter

public final void fieldRankFilter(ParsedRankProfile profile)
                           throws ParseException

Consumes a rank filter statement of a rank profile.

Parameters:

profile - the rank profile to modify

Throws:

ParseException

fieldRankItem

public final void fieldRankItem(ParsedRankProfile profile,
 String field)
                         throws ParseException

Throws:

ParseException

elementGapValue

public final ElementGap elementGapValue()
                                 throws ParseException

Throws:

ParseException

constants

public final void constants(ParsedSchema schema,
 ParsedRankProfile profile)
                     throws ParseException

Consumes a set of constants available in ranking expressions in the enclosing profile.

Throws:

ParseException

constant

public final void constant(ParsedSchema schema,
 ParsedRankProfile profile)
                    throws ParseException

Throws:

ParseException

constantName

public final com.yahoo.searchlib.rankingexpression.Reference constantName()
                                                                   throws ParseException

Returns the reference "constant(name)" for both "constant(name)" and "name".

Throws:

ParseException

constantValue

public final void constantValue(ParsedRankProfile profile,
 com.yahoo.searchlib.rankingexpression.Reference name)
                         throws ParseException

Throws:

ParseException

constantTensor

public final void constantTensor(ParsedRankProfile profile,
 com.yahoo.searchlib.rankingexpression.Reference name)
                          throws ParseException

Throws:

ParseException

constantTensorErrorMessage

public final String constantTensorErrorMessage(String rankProfileName,
 com.yahoo.searchlib.rankingexpression.Reference name)
                                        throws ParseException

Throws:

ParseException

tensorValue

public final com.yahoo.tensor.Tensor tensorValue(com.yahoo.tensor.TensorType type)
                                          throws ParseException

Parses a tensor written in a tensor literal form, https://docs.vespa.ai/en/reference/tensor.html#tensor-literal-form

Throws:

ParseException

mappedTensorValue

public final void mappedTensorValue(com.yahoo.tensor.Tensor.Builder builder)
                             throws ParseException

A mapped or mixed tensor value.

Throws:

ParseException

mappedTensorBlock

public final void mappedTensorBlock(com.yahoo.tensor.Tensor.Builder builder)
                             throws ParseException

Throws:

ParseException

indexedTensorBlockValues

public final void indexedTensorBlockValues(com.yahoo.tensor.TensorAddress mappedAddress,
 com.yahoo.tensor.Tensor.Builder builder)
                                    throws ParseException

Throws:

ParseException

indexedTensorValues

public final void indexedTensorValues(com.yahoo.tensor.Tensor.Builder builder)
                               throws ParseException

Throws:

ParseException

arrayTensorValues

public final void arrayTensorValues(List<Double> values)
                             throws ParseException

Tensor array values. Using sub-bracketing for multiple dimensions is optional and therefore ignored here.

Throws:

ParseException

indexedTensorValue

public final void indexedTensorValue(List<Double> values)
                              throws ParseException

Throws:

ParseException

mappedTensorCellValue

public final void mappedTensorCellValue(com.yahoo.tensor.TensorAddress address,
 com.yahoo.tensor.Tensor.Builder builder)
                                 throws ParseException

Throws:

ParseException

tensorAddress

public final com.yahoo.tensor.TensorAddress tensorAddress(com.yahoo.tensor.TensorType type)
                                                   throws ParseException

Throws:

ParseException

tensorAddressElement

public final void tensorAddressElement(com.yahoo.tensor.TensorAddress.Builder builder)
                                throws ParseException

Throws:

ParseException

tensorAddressLabel

public final String tensorAddressLabel()
                                throws ParseException

Throws:

ParseException

tensorCellValue

public final double tensorCellValue()
                             throws ParseException

Throws:

ParseException

tensorValuePrefixedByValue

public final String tensorValuePrefixedByValue()
                                        throws ParseException

Undocumented syntax for supplying a tensor constant value by a string prefixed by "value"

Throws:

ParseException

tensorTypeWithPrefix

public final com.yahoo.tensor.TensorType tensorTypeWithPrefix(String errorMessage)
                                                       throws ParseException

Throws:

ParseException

tensorType

public final com.yahoo.tensor.TensorType tensorType(String errorMessage)
                                             throws ParseException

Throws:

ParseException

importField

public final void importField(ParsedSchema schema)
                       throws ParseException

Throws:

ParseException

expression

public final String expression()
                        throws ParseException

This rule consumes an expression token and returns its image.

Returns:

The consumed token image.

Throws:

ParseException

identifierWithDash

public final String identifierWithDash()
                                throws ParseException

Throws:

ParseException

identifier

public final String identifier()
                        throws ParseException

Consumes an identifier. This must be kept in sync with all word tokens that should be parseable as identifiers.

Returns:

the identifier string

Throws:

ParseException

string

public final String string()
                    throws ParseException

Consumes a string token and returns the token image.

Returns:

The consumed token image.

Throws:

ParseException

quotedString

public final String quotedString()
                          throws ParseException

Consumes a quoted string token and returns the token image minus the quotes. This does not perform unescaping of the content, it simply removes the first and last character of the image. However, the token itself can contain anything but a double quote.

Returns:

the unquoted token image

Throws:

ParseException

bool

public final Boolean bool()
                   throws ParseException

A boolean value.

Throws:

ParseException

integer

public final int integer()
                  throws ParseException

Consumes an integer token and returns its numeric value.

Throws:

ParseException

longValue

public final long longValue()
                     throws ParseException

Consumes a long or integer token and returns its numeric value.

Throws:

ParseException

floatValue

public final double floatValue()
                        throws ParseException

Consumes a floating-point token and returns its numeric value.

Throws:

ParseException

number

public final Number number()
                    throws ParseException

Throws:

ParseException

lbrace

public final void lbrace()
                  throws ParseException

Consumes an opening brace with leading and trailing newline tokens.

Throws:

ParseException

ReInit

public void ReInit(CharStream stream)

Reinitialise.

Parameters:

stream - stream to init with

ReInit

public void ReInit(SchemaParserTokenManager tm)

Reinitialise

Parameters:

tm - Token manager to use

getNextToken

public final Token getNextToken()

Returns:

the next Token.

getToken

public final Token getToken(int index)

Parameters:

index - index to be retrieved

Returns:

the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

Returns:

new Exception object. Never null

trace_enabled

public final boolean trace_enabled()

Returns:

Always false.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.