gudusoft.gsqlparser.pp2.island

Class ClauseScopeAnnotator

Object

gudusoft.gsqlparser.pp2.island.ClauseScopeAnnotator

public final class ClauseScopeAnnotator
extends Object

Annotates each token with the clause it belongs to (ClausePart) and marks master/clause keyword roles, by walking the token stream left-to-right and tracking the current clause per SQL scope level.

SQL-scope aware

The annotator consumes SqlScopeDetector.SqlScopeResult (S20) so a subquery's clauses do not leak into the enclosing query: the "current clause" is tracked independently per scope level. When the walk descends into a deeper scope, that level's clause state starts fresh; when it returns, the enclosing level's clause (e.g. FROM around a derived-table subquery) is intact.

Expression-depth gating

A clause keyword only changes the current clause when it appears at the query block's own paren depth — not inside a nested expression. This stops window specs (OVER (ORDER BY a)), aggregate filters (FILTER (WHERE ...)), and parenthesised predicates from corrupting the clause state. The function-form keywords LEFT( / RIGHT( are also recognised as function calls (not JOIN keywords) when immediately followed by an open paren.

Designated annotator

S21 is one of the designated role-annotator stages (plan forbidden #6), so it sets TokenRole.KEYWORD_MASTER on master keywords (SELECT/INSERT/UPDATE/DELETE/MERGE) and TokenRole.KEYWORD_CLAUSE on recognised clause keywords. It never mutates the wrapped TSourceToken. The per-token clause membership is returned as a ClauseScopeAnnotator.ClauseScopeResult side structure (a token belongs to exactly one clause, so a small enum is clearer than seven boolean roles).

Iterative single pass; no recursion. Plan reference: §7.3/S21, §7.4/S21.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClauseScopeAnnotator.ClauseScopeResult Per-token clause membership plus the master-keyword token indices.

Constructor Summary

Constructors

Constructor and Description
ClauseScopeAnnotator()

Method Summary

Modifier and Type	Method and Description
ClauseScopeAnnotator.ClauseScopeResult	annotate(Pp2TokenStream stream, SqlScopeDetector.SqlScopeResult sqlScope) Annotate stream clause membership using the SQL scope levels.

Methods inherited from class Object

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

Constructor Detail

ClauseScopeAnnotator

public ClauseScopeAnnotator()

Method Detail

annotate

public ClauseScopeAnnotator.ClauseScopeResult annotate(Pp2TokenStream stream,
                                                       SqlScopeDetector.SqlScopeResult sqlScope)

Annotate stream clause membership using the SQL scope levels.

Parameters:

stream - the token stream; must not be null

sqlScope - the S20 scope result for the same stream; must not be null and must cover the same token count

Returns:

a ClauseScopeAnnotator.ClauseScopeResult; never null

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if sqlScope.size() != stream size