com.saxonica.expr

Class XQueryParserPE

java.lang.Object

net.sf.saxon.expr.parser.XPathParser

net.sf.saxon.query.XQueryParser

com.saxonica.expr.XQueryParserPE

Direct Known Subclasses:

XQueryParserEE

public class XQueryParserPE
extends XQueryParser

Parser extension for syntax in XQuery Update and/or XQuery 3.0 that is supported only in Saxon-PE or -EE. This includes all syntax needed for the HOF feature. Other XQuery 3.0 extensions, such as the switch expression and FLWOR extensions, are moved into the (HE) QueryParser from Saxon 9.6.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.expr.parser.XPathParser

XPathParser.TemporaryContainer

Field Summary

Fields inherited from class net.sf.saxon.query.XQueryParser

executable, importedModules, queryVersion, XQUERY10, XQUERY30

Fields inherited from class net.sf.saxon.expr.parser.XPathParser

allowXPath30Syntax, catchDepth, charChecker, codeInjector, defaultContainer, env, language, languageVersion, rangeVariables, scanOnly, SEQUENCE_TYPE, t, XPATH, XQUERY, XSLT_PATTERN

Constructor Summary

Constructors

Constructor and Description
XQueryParserPE(String queryVersion)

Method Summary

Methods

Modifier and Type	Method and Description
protected LocalBinding	findRangeVariable(StructuredQName qName) Locate a range variable with a given name.
int	getPermittedFunctions() Get the permitted set of standard functions in this environment
protected boolean	isReservedInQuery(String uri)
protected Expression	makeCurriedFunction(int offset, StructuredQName name, Expression[] args, IntSet placeMarkers) Process a function call in which one or more of the argument positions are represented as "?" placemarkers (indicating partial application or currying)
XQueryParser	newParser() Create a new parser of the same kind
protected Expression	parseDynamicFunctionCall(Expression functionItem) Parse a dynamic function call
Expression	parseFunctionArgument() Parse a function argument.
ItemType	parseFunctionItemType() Parse the item type used for function items (XQuery 3.0 higher order functions) Syntax (changed by WG decision on 2009-09-22): function '(' '*' ') | function '(' (SeqType (',' SeqType)*)? ')' 'as' SeqType The "function(" has already been read
protected Expression	parseInlineFunction(Map<StructuredQName,Annotation> annotations) Parse an inline function "function" "(" ParamList? ")" ("as" SequenceType)? EnclosedExpr On entry, "function (" has already been read
protected Expression	parseLiteralFunctionItem() Parse a literal function item (introduced in XQuery 3.0) Syntax: QName # integer The QName and # have already been read
protected Expression	parseMapExpression() Parse a map expression.
ItemType	parseMapItemType() Parse the item type used for map items (XPath 3.0) Syntax: map '(' '*' ') | map '(' ItemType ',' SeqType ')' 'as' SeqType The "map(" has already been read

Methods inherited from class net.sf.saxon.query.XQueryParser

applyModuleImport, atStartOfRelativePath, customizeTokenizer, getExecutable, getLanguage, grumble, isStreaming, lookAhead, makeLetExpression, makeSimpleContent, makeStringJoin, makeStringLiteral, makeXQueryExpression, normalizeEQName, parseAnnotations, parseConstructor, parseExtensionExpression, parseFLWORExpression, parseFunctionDeclaration, parseLibraryModule, parseOutputDeclaration, parseRevalidationDeclaration, parseSwitchExpression, parseTryCatchExpression, parseTypeswitchExpression, parseUpdatingFunctionDeclaration, parseValidateExpression, readCollationName, setDisableCycleChecks, setExecutable, setStreaming, stringify, testPermittedAxis, URILiteral

Methods inherited from class net.sf.saxon.expr.parser.XPathParser

currentTokenDisplay, declareRangeVariable, disallowedAtStartOfRelativePath, expect, getCodeInjector, getDefaultContainer, getMissingFunctionExplanation, getRangeVariables, getStaticContext, getTokenizer, grumble, grumble, grumble, isKeyword, isNamespaceTestAllowed, makeLocalNameTest, makeNameCode, makeNamespaceTest, makeNameTest, makeNodeName, makeStructuredQName, makeStructuredQNameSilently, makeTracer, nextToken, parse, parseBasicStep, parseBinaryExpression, parseExpression, parseExprSingle, parseFunctionCall, parseItemType, parseNodeTest, parseNumericLiteral, parsePathExpression, parsePredicate, parseRelativePath, parseRemainingPath, parseSequenceType, parseSequenceType, parseSimpleMappingExpression, parseStepExpression, parseStringLiteral, parseVariableReference, reportMissingFunction, resolveFunctionName, setCodeInjector, setDefaultContainer, setLanguage, setLocation, setLocation, setLocation, setRangeVariables, setRangeVariableStack, setScanOnly, undeclareRangeVariable, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

XQueryParserPE

public XQueryParserPE(String queryVersion)

Method Detail

newParser

public XQueryParser newParser()

Create a new parser of the same kind

Overrides:

newParser in class XQueryParser

Returns:

a new parser of the same kind as this one

getPermittedFunctions

public int getPermittedFunctions()

Get the permitted set of standard functions in this environment

Overrides:

getPermittedFunctions in class XQueryParser

Returns:

a code indicating which system library functions are supported in this version of the language

isReservedInQuery

protected boolean isReservedInQuery(String uri)

Overrides:

isReservedInQuery in class XPathParser

parseLiteralFunctionItem

protected Expression parseLiteralFunctionItem()
                                       throws XPathException

Parse a literal function item (introduced in XQuery 3.0) Syntax: QName # integer The QName and # have already been read

Overrides:

parseLiteralFunctionItem in class XPathParser

Returns:

an ExternalObject representing the function item

Throws:

XPathException - if a static error is encountered

parseFunctionItemType

public ItemType parseFunctionItemType()
                               throws XPathException

Parse the item type used for function items (XQuery 3.0 higher order functions) Syntax (changed by WG decision on 2009-09-22): function '(' '*' ') | function '(' (SeqType (',' SeqType)*)? ')' 'as' SeqType The "function(" has already been read

Overrides:

parseFunctionItemType in class XPathParser

Returns:

the item type representing a function item

Throws:

XPathException - if a static error occurs (including the case where XPath 3.0 syntax is not enabled)

parseFunctionArgument

public Expression parseFunctionArgument()
                                 throws XPathException

Parse a function argument. The special marker "?" is allowed and causes "null" to be returned

Overrides:

parseFunctionArgument in class XPathParser

Returns:

the Expression used as the argument, or null if the argument is the place-holder "?"

Throws:

XPathException - if the argument expression does not parse correctly

parseMapItemType

public ItemType parseMapItemType()
                          throws XPathException

Parse the item type used for map items (XPath 3.0) Syntax: map '(' '*' ') | map '(' ItemType ',' SeqType ')' 'as' SeqType The "map(" has already been read

Overrides:

parseMapItemType in class XPathParser

Returns:

the item type of the map

Throws:

XPathException - if a parsing error occurs or if the map syntax is not available

parseDynamicFunctionCall

protected Expression parseDynamicFunctionCall(Expression functionItem)
                                       throws XPathException

Parse a dynamic function call

Overrides:

parseDynamicFunctionCall in class XPathParser

Parameters:

functionItem - the expression that determines the function to be called

Returns:

the expression that results from the parsing

Throws:

XPathException - if a static error is found

parseInlineFunction

protected Expression parseInlineFunction(Map<StructuredQName,Annotation> annotations)
                                  throws XPathException

Parse an inline function "function" "(" ParamList? ")" ("as" SequenceType)? EnclosedExpr On entry, "function (" has already been read

Overrides:

parseInlineFunction in class XPathParser

Parameters:

annotations - the function annotations, which have already been read, or null if there are none

Returns:

the parsed inline function

Throws:

XPathException - if a syntax error is found

makeCurriedFunction

protected Expression makeCurriedFunction(int offset,
                             StructuredQName name,
                             Expression[] args,
                             IntSet placeMarkers)
                                  throws XPathException

Process a function call in which one or more of the argument positions are represented as "?" placemarkers (indicating partial application or currying)

Overrides:

makeCurriedFunction in class XPathParser

Parameters:

offset - the location of the expression in the query source

name - the function name (as if there were no currying)

args - the arguments (with EmptySequence in the placemarker positions)

placeMarkers - the positions of the placemarkers @return the curried function

Returns:

the curried function

Throws:

XPathException - if the syntax is incorrect

parseMapExpression

protected Expression parseMapExpression()
                                 throws XPathException

Parse a map expression. Requires XPath/XQuery 3.0 Provisional syntax map { expr := expr (, expr := expr )*} }

Overrides:

parseMapExpression in class XPathParser

Returns:

the map expression

Throws:

XPathException

findRangeVariable

protected LocalBinding findRangeVariable(StructuredQName qName)

Locate a range variable with a given name. (By "range variable", we mean a variable declared within the expression where it is used.)

Overrides:

findRangeVariable in class XPathParser

Parameters:

qName - identifies the name of the range variable

Returns:

null if not found (this means the variable is probably a context variable); otherwise the relevant RangeVariable