Package io.jmix.aitools.dataload.execution

Class JpqlDeclarationSupport

java.lang.Object

io.jmix.aitools.dataload.execution.JpqlDeclarationSupport

@Component("aitls_JpqlDeclarationSupport")
public class JpqlDeclarationSupport
extends Object

Reads the identification variables a JPQL query declares, subqueries included, for the data-load access checks. The public query parser names one outer alias per entity and no subquery variable, which is not enough to tell where an entity occurs, so this reads the parser's own syntax tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JpqlDeclarationSupport.Declaration	An identification variable the query declares.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable DomainModel	domainModel
protected DomainModelBuilder	domainModelBuilder
protected Metadata	metadata
protected MetadataTools	metadataTools

Constructor Summary

Constructors

Constructor	Description
JpqlDeclarationSupport()

Method Summary

Modifier and Type	Method	Description
protected void	addDeclaration(List<JpqlDeclarationSupport.Declaration> declarations, Map<String,String> variableEntities, JpqlDeclarationSupport.Declaration declaration)
protected void	checkDeclarationsReadable(org.antlr.runtime.tree.Tree selectionSource)	Fails on a declaration that the syntax tree keeps as bare tokens, such as a subquery's from o.lines l or a join fetch.
protected void	collectDeclarations(org.antlr.runtime.tree.Tree node, int queryDepth, List<JpqlDeclarationSupport.Declaration> declarations, Map<String,String> variableEntities)
protected DomainModel	getDomainModel()
static boolean	isLeftJoin(JoinVariableNode join)	Tells whether the join is a left join, outer or not.
protected JpqlDeclarationSupport.Declaration	joinDeclaration(BaseJoinNode joinNode, Map<String,String> variableEntities, boolean nested)
protected MetaProperty	joinedProperty(PathNode pathNode, Map<String,String> variableEntities)
protected String	lowerCase(String name)
List<JpqlDeclarationSupport.Declaration>	readDeclarations(String jpql)	Reads every identification variable the query declares in from, join and in (…), including subqueries.

Methods inherited from class java.lang.Object

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

Field Details

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

domainModelBuilder

@Autowired
@Qualifier("regular")
protected DomainModelBuilder domainModelBuilder

domainModel

protected volatile @Nullable DomainModel domainModel

Constructor Details

JpqlDeclarationSupport

public JpqlDeclarationSupport()

Method Details

isLeftJoin

public static boolean isLeftJoin(JoinVariableNode join)

Tells whether the join is a left join, outer or not.

Parameters:

join - a join declaring a variable

Returns:

whether it is a left join

readDeclarations

public List<JpqlDeclarationSupport.Declaration> readDeclarations(String jpql)

Reads every identification variable the query declares in from, join and in (…), including subqueries.

Parameters:

jpql - query text

Returns:

the declarations in the order they appear

Throws:

JpqlAccessConstraintException - if a variable name is declared more than once in the query, subqueries included

IllegalStateException - if a declaration cannot be read

collectDeclarations

protected void collectDeclarations(org.antlr.runtime.tree.Tree node,
 int queryDepth,
 List<JpqlDeclarationSupport.Declaration> declarations,
 Map<String,String> variableEntities)

checkDeclarationsReadable

protected void checkDeclarationsReadable(org.antlr.runtime.tree.Tree selectionSource)

Fails on a declaration that the syntax tree keeps as bare tokens, such as a subquery's from o.lines l or a join fetch. Their variables would otherwise go unseen.

Parameters:

selectionSource - a from item of the tree

Throws:

IllegalStateException - if the item holds something other than declarations

joinDeclaration

protected JpqlDeclarationSupport.Declaration joinDeclaration(BaseJoinNode joinNode,
 Map<String,String> variableEntities,
 boolean nested)

addDeclaration

protected void addDeclaration(List<JpqlDeclarationSupport.Declaration> declarations,
 Map<String,String> variableEntities,
 JpqlDeclarationSupport.Declaration declaration)

joinedProperty

protected MetaProperty joinedProperty(PathNode pathNode,
 Map<String,String> variableEntities)

getDomainModel

protected DomainModel getDomainModel()

lowerCase

protected String lowerCase(String name)