Package net.sf.saxon.query
Class QueryParser
java.lang.Object
net.sf.saxon.expr.parser.ExpressionParser
net.sf.saxon.query.QueryParser
This class defines extensions to the XPath parser to handle the additional
syntax supported in XQuery
-
Nested Class Summary
Nested classes/interfaces inherited from class net.sf.saxon.expr.parser.ExpressionParser
ExpressionParser.TemporaryContainer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Executable
protected static final int
protected static final int
protected static final int
(package private) List<net.sf.saxon.query.QueryParser.Import>
protected String
(package private) List<net.sf.saxon.query.QueryParser.Import>
static String
static String
Fields inherited from class net.sf.saxon.expr.parser.ExpressionParser
allowXPath30Syntax, codeInjector, defaultContainer, env, language, languageVersion, nameChecker, rangeVariables, scanOnly, SEQUENCE_TYPE, t, XPATH, XQUERY, XSLT_PATTERN
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor for internal use: this class should be instantiated via the QueryModule -
Method Summary
Modifier and TypeMethodDescriptionvoid
applyModuleImport
(net.sf.saxon.query.QueryParser.Import mImport) protected boolean
Test whether the current token is one that can start a RelativePathExpressionprotected void
checkForClauseAllowingEmpty
(ForClause clause) Check a ForClause for an "outer for"protected void
Callback to tailor the tokenizerGet the executable containing this expression.protected String
Get the current language (XPath or XQuery)int
Get the permitted set of standard functions in this environmentprotected void
grumble
(String message, StructuredQName errorCode, int offset) Report a static errorprotected void
Lookahead one token, catching any exception thrown by the tokenizer.protected LetExpression
Make a LetExpression.protected void
makeSimpleContent
(Expression content, SimpleNodeConstructor inst, int offset) Make the instructions for the children of a node with simple content (attribute, text, PI, etc)static Expression
makeStringJoin
(Expression exp, StaticContext env) Make a string-join expression that concatenates the string-values of items in a sequence with intervening spaces.protected Literal
makeStringLiteral
(String token) Method to make a string literal from a token identified as a string literal.makeXQueryExpression
(String query, QueryModule mainModule, Configuration config) Create an XQueryExpressionCreate a new parser of the same kindprotected String
Convert a QName in expanded-name format "uri":local into Clark formatprotected int
protected Expression
Parse a node constructor.protected void
Parse a context item declaration.protected void
parseCountClause
(List clauseList) Parse a count clause.protected void
Parse the "declare decimal-format" declaration.protected void
protected Expression
Parse an Extension Expression.protected Expression
Parse a FLWOR expression.protected void
parseFunctionDeclaration
(int functionOptions) Parse a function declaration.protected void
parseGroupByClause
(List<Clause> clauseList) Parse a Group By clause.final void
parseLibraryModule
(String queryString, QueryModule env) Parse a library module.protected Expression
parseNamedNamespaceConstructor
(int offset) protected Expression
parseNamespaceConstructor
(int offset) protected void
Parse the "declare revalidation" declaration.protected Expression
Parse a Typeswitch Expression.protected void
Parse an updating function declaration (allowed in XQuery Update only)protected Expression
Parse a Validate Expression.protected void
parseWindowClause
(List<Clause> clauseList) Parse a tumbling or sliding window clause.protected String
setDefaultValue
(String exp) Parse the expression (inside a string literal) used to define default values for external variables.void
setDisableCycleChecks
(boolean disable) Disable checks for certain kinds of cycle.void
setExecutable
(Executable exec) Set the executable used for this query expressionstatic Expression
stringify
(Expression exp, boolean noNodeIfEmpty, Configuration config) Convert an expression so it generates a space-separated sequence of stringsURILiteral
(String in) Handle a URI literal.Methods inherited from class net.sf.saxon.expr.parser.ExpressionParser
currentTokenDisplay, declareRangeVariable, disallowedAtStartOfRelativePath, expect, findRangeVariable, getCodeInjector, getDefaultContainer, getNameChecker, getRangeVariables, getStaticContext, getTokenizer, grumble, grumble, grumble, grumble, isKeyword, isNamespaceTestAllowed, makeCurriedFunction, makeLocalNameTest, makeNameCode, makeNameCodeSilently, makeNamespaceTest, makeNameTest, makeNodeName, makeStructuredQName, makeTracer, nextToken, parse, parseBasicStep, parseBinaryExpression, parseDynamicFunctionCall, parseExpression, parseExprSingle, parseFunctionArgument, parseFunctionCall, parseFunctionItemType, parseInlineFunction, parseItemType, parseLiteralFunctionItem, parseMapExpression, parseMapItemType, parseNodeTest, parseNumericLiteral, parseParenthesizedItemType, parsePathExpression, parsePredicate, parseRelativePath, parseRemainingPath, parseSequenceType, parseSequenceType, parseStepExpression, parseStringLiteral, parseSwitchExpression, parseTryCatchExpression, parseTypePattern, parseVariableReference, reportMissingFunction, resolveFunctionName, setCodeInjector, setDefaultContainer, setLanguage, setLocation, setLocation, setLocation, setRangeVariables, setRangeVariableStack, setScanOnly, testPermittedAxis, undeclareRangeVariable, warning
-
Field Details
-
XQUERY10
-
XQUERY30
-
queryVersion
-
executable
-
importedModules
-
namespacesToBeSealed
-
schemaImports
List<net.sf.saxon.query.QueryParser.Import> schemaImports -
moduleImports
List<net.sf.saxon.query.QueryParser.Import> moduleImports -
FUNCTION_IS_UPDATING
protected static final int FUNCTION_IS_UPDATING- See Also:
-
FUNCTION_IS_PRIVATE
protected static final int FUNCTION_IS_PRIVATE- See Also:
-
FUNCTION_IS_NONDETERMINISTIC
protected static final int FUNCTION_IS_NONDETERMINISTIC- See Also:
-
-
Constructor Details
-
QueryParser
public QueryParser()Constructor for internal use: this class should be instantiated via the QueryModule
-
-
Method Details
-
newParser
Create a new parser of the same kind- Returns:
- a new parser of the same kind as this one
-
makeXQueryExpression
public XQueryExpression makeXQueryExpression(String query, QueryModule mainModule, Configuration config) throws XPathException Create an XQueryExpression- Parameters:
query
- the source text of the querymainModule
- the static context of the queryconfig
- the Saxon configuration- Returns:
- the compiled XQuery expression
- Throws:
XPathException
- if the expression contains static errors
-
getPermittedFunctions
public int getPermittedFunctions()Get the permitted set of standard functions in this environment- Returns:
- a code indicating which system library functions are supported in this version of the language
-
getExecutable
Get the executable containing this expression.- Returns:
- the executable
-
setExecutable
Set the executable used for this query expression- Parameters:
exec
- the executable
-
setDisableCycleChecks
public void setDisableCycleChecks(boolean disable) Disable checks for certain kinds of cycle. This is equivalent todeclare option saxon:allow-cycles "true"
- Parameters:
disable
- true if checks for import cycles are to be suppressed, that is, if cycles should be allowed
-
customizeTokenizer
Callback to tailor the tokenizer- Overrides:
customizeTokenizer
in classExpressionParser
- Parameters:
t
- the Tokenizer to be customized
-
parseLibraryModule
Parse a library module. Prolog? Expression- Parameters:
queryString
- The text of the library module.env
- The static context. The result of parsing a library module is that the static context is populated with a set of function declarations and variable declarations. Each library module must have its own static context objext.- Throws:
XPathException
- if the expression contains a syntax error
-
grumble
Report a static error- Overrides:
grumble
in classExpressionParser
- Parameters:
message
- the error messageoffset
- the location in the source queryerrorCode
- the error code- Throws:
XPathException
- always thrown: an exception containing the supplied message
-
parseAnnotations
- Throws:
XPathException
-
parseRevalidationDeclaration
Parse the "declare revalidation" declaration. Syntax: not allowed unless XQuery update is in use- Throws:
XPathException
- if the syntax is incorrect, or is not allowed in this XQuery processor
-
applyModuleImport
- Throws:
XPathException
-
parseDecimalFormatDeclaration
Parse the "declare decimal-format" declaration. Allowed in XQuery 1.1 only- Throws:
XPathException
- if parsing fails
-
parseDefaultDecimalFormat
- Throws:
XPathException
-
parseContextItemDeclaration
Parse a context item declaration. Allowed only in XQuery 3.0- Throws:
XPathException
- if parsing fails
-
parseFunctionDeclaration
Parse a function declaration.Syntax:
<"declare" "function"> QName "(" ParamList? ")" ("as" SequenceType)? (EnclosedExpr | "external")On entry, the "declare function" has already been recognized
- Parameters:
functionOptions
- function annotations such as updating, deterministic etc- Throws:
XPathException
- if a syntax error is found
-
parseUpdatingFunctionDeclaration
Parse an updating function declaration (allowed in XQuery Update only)- Throws:
XPathException
- if parsing fails or if updating functions are not allowed
-
setDefaultValue
Parse the expression (inside a string literal) used to define default values for external variables. This requires instantiating a nested XPath parser. (This is a Saxon extension for XQuery 1.0 which becomes obsolete with XQuery 3.0)- Parameters:
exp
- holds the expression used to define a default value- Returns:
- the compiled expression that computes the default value
-
parseFLWORExpression
Parse a FLWOR expression. This replaces the XPath "for" expression. Full syntax: [41] FLWORExpr ::= (ForClause | LetClause)+ WhereClause? OrderByClause? "return" ExprSingle [42] ForClause ::= <"for" "$"> VarName TypeDeclaration? PositionalVar? "in" ExprSingle ("," "$" VarName TypeDeclaration? PositionalVar? "in" ExprSingle)* [43] PositionalVar ::= "at" "$" VarName [44] LetClause ::= <"let" "$"> VarName TypeDeclaration? ":=" ExprSingle ("," "$" VarName TypeDeclaration? ":=" ExprSingle)* [45] WhereClause ::= "where" Expr [46] OrderByClause ::= (<"order" "by"> | <"stable" "order" "by">) OrderSpecList [47] OrderSpecList ::= OrderSpec ("," OrderSpec)* [48] OrderSpec ::= ExprSingle OrderModifier [49] OrderModifier ::= ("ascending" | "descending")? (<"empty" "greatest"> | <"empty" "least">)? ("collation" StringLiteral)?- Overrides:
parseFLWORExpression
in classExpressionParser
- Returns:
- the resulting subexpression
- Throws:
XPathException
- if any error is encountered
-
makeLetExpression
Make a LetExpression. This returns an ordinary LetExpression if tracing is off, and an EagerLetExpression if tracing is on. This is so that trace events occur in an order that the user can follow.- Returns:
- the constructed "let" expression
-
checkForClauseAllowingEmpty
Check a ForClause for an "outer for"- Parameters:
clause
- the clause to be checked- Throws:
XPathException
- if invalid
-
parseCountClause
Parse a count clause. Not supported in 1.0; subclassed in the XQuery 1.1 parser- Parameters:
clauseList
- the list of clauses for the expression, to which this clause will be added- Throws:
XPathException
- if a static error is found
-
parseGroupByClause
Parse a Group By clause. Not supported in 1.0; subclassed in the XQuery 3.0 parser- Parameters:
clauseList
- the list of clauses for the expression, to which this clause will be added- Throws:
XPathException
- if a static error is found
-
parseWindowClause
Parse a tumbling or sliding window clause. Not supported in 1.0; subclassed in the XQuery 3.0 parser- Parameters:
clauseList
- the list of clauses for the expression, to which this clause will be added- Throws:
XPathException
- if a static error is found
-
makeStringJoin
Make a string-join expression that concatenates the string-values of items in a sequence with intervening spaces. This may be simplified later as a result of type-checking.- Parameters:
exp
- the base expression, evaluating to a sequenceenv
- the static context- Returns:
- a call on string-join to create a string containing the representations of the items in the sequence separated by spaces.
-
readCollationName
- Throws:
XPathException
-
parseTypeswitchExpression
Parse a Typeswitch Expression. This construct is XQuery-only. TypeswitchExpr ::= "typeswitch" "(" Expr ")" CaseClause+ "default" ("$" VarName)? "return" ExprSingle CaseClause ::= "case" ("$" VarName "as")? SequenceType "return" ExprSingle- Overrides:
parseTypeswitchExpression
in classExpressionParser
- Returns:
- the expression that results from the parsing
- Throws:
XPathException
- if parsing fails
-
parseValidateExpression
Parse a Validate Expression. This construct is XQuery-only. The syntax allows: validate mode? { Expr } mode ::= "strict" | "lax"- Overrides:
parseValidateExpression
in classExpressionParser
- Returns:
- the parsed expression; except that this version of the method always throws an exception
- Throws:
XPathException
- if parsing fails
-
parseExtensionExpression
Parse an Extension Expression. Syntax: "(#" QName arbitrary-text "#)")+ "{" expr? "}"- Overrides:
parseExtensionExpression
in classExpressionParser
- Returns:
- the parsed expression; except that this version of the method always throws an exception
- Throws:
XPathException
- if parsing fails
-
parseConstructor
Parse a node constructor. This is allowed only in XQuery. This method handles both the XML-like "direct" constructors, and the XQuery-based "computed" constructors.- Overrides:
parseConstructor
in classExpressionParser
- Returns:
- an Expression for evaluating the parsed constructor
- Throws:
XPathException
- in the event of a syntax error.
-
parseNamespaceConstructor
- Throws:
XPathException
-
parseNamedNamespaceConstructor
- Throws:
XPathException
-
makeSimpleContent
protected void makeSimpleContent(Expression content, SimpleNodeConstructor inst, int offset) throws XPathException Make the instructions for the children of a node with simple content (attribute, text, PI, etc)- Parameters:
content
- the expression making up the simple contentinst
- the skeletal instruction for creating the nodeoffset
- the character position of this construct within the source query- Throws:
XPathException
- if a static error is encountered
-
stringify
public static Expression stringify(Expression exp, boolean noNodeIfEmpty, Configuration config) throws XPathException Convert an expression so it generates a space-separated sequence of strings- Parameters:
exp
- the expression that calculates the contentnoNodeIfEmpty
- if true, no node is produced when the value of the content expression is an empty sequence. If false, the effect of supplying an empty sequence is that a node is created whose string-value is a zero-length string. Set to true for text node constructors, false for other kinds of node.config
- the Saxon configuration- Returns:
- an expression that computes the content and converts the result to a character string
- Throws:
XPathException
- if parsing fails
-
makeStringLiteral
Method to make a string literal from a token identified as a string literal. This is trivial in XPath, but in XQuery the method is overridden to identify pseudo-XML character and entity references- Overrides:
makeStringLiteral
in classExpressionParser
- Parameters:
token
- the string as written (or as returned by the tokenizer)- Returns:
- The string value of the string literal, after dereferencing entity and character references
- Throws:
XPathException
- if parsing fails
-
URILiteral
Handle a URI literal. This is whitespace-normalized as well as being unescaped- Parameters:
in
- the string as written- Returns:
- the URI after unescaping of entity and character references followed by whitespace normalization
- Throws:
XPathException
- if an error is found while unescaping the URI
-
normalizeEQName
Convert a QName in expanded-name format "uri":local into Clark format- Overrides:
normalizeEQName
in classExpressionParser
- Parameters:
s
- the QName in expanded-name format- Returns:
- the corresponding expanded name in Clark format
- Throws:
XPathException
-
lookAhead
Lookahead one token, catching any exception thrown by the tokenizer. This method is only called from the query parser when switching from character-at-a-time mode to tokenizing mode- Throws:
XPathException
- if parsing fails
-
atStartOfRelativePath
protected boolean atStartOfRelativePath()Description copied from class:ExpressionParser
Test whether the current token is one that can start a RelativePathExpression- Overrides:
atStartOfRelativePath
in classExpressionParser
- Returns:
- the resulting subexpression
-
getLanguage
Get the current language (XPath or XQuery)- Overrides:
getLanguage
in classExpressionParser
- Returns:
- a string representation of the language being parsed, for use in error messages
-