Package io.jmix.aitools.dataload

Class EntityDataLoadQuery

java.lang.Object

io.jmix.aitools.dataload.EntityDataLoadQuery

public class EntityDataLoadQuery
extends Object

Structured JPQL query draft produced by EntityDataLoadGenerationService for a natural-language request. Carries everything JpqlExecutionService needs to validate and run the query, plus the LLM's explanation and warnings for the caller.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	explanation
protected @Nullable Integer	firstResult
protected String	jpql
protected @Nullable Integer	maxResults
protected List<GeneratedJpqlParameter>	parameters
protected List<String>	resultProperties
protected List<String>	warnings

Constructor Summary

Constructors

Constructor	Description
EntityDataLoadQuery(String jpql, List<GeneratedJpqlParameter> parameters, List<String> resultProperties, String explanation, List<String> warnings, @Nullable Integer maxResults, @Nullable Integer firstResult)

Method Summary

Modifier and Type	Method	Description
String	getExplanation()
@Nullable Integer	getFirstResult()	Rrequested offset of the first row, or null to start from the first row.
String	getJpql()	Returns the generated JPQL select query.
@Nullable Integer	getMaxResults()	Returns requested row limit, or null to apply the default limit on execution.
List<GeneratedJpqlParameter>	getParameters()	Returns named parameters that must be bound when executing getJpql()
List<String>	getResultProperties()	Returns result column names in the exact order of the SELECT expressions in getJpql(); used as keys for the row maps in the execution result.
List<String>	getWarnings()

Methods inherited from class java.lang.Object

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

Field Details

jpql

protected String jpql

parameters

protected List<GeneratedJpqlParameter> parameters

resultProperties

protected List<String> resultProperties

explanation

protected String explanation

warnings

protected List<String> warnings

maxResults

protected @Nullable Integer maxResults

firstResult

protected @Nullable Integer firstResult

Constructor Details

EntityDataLoadQuery

public EntityDataLoadQuery(String jpql,
 List<GeneratedJpqlParameter> parameters,
 List<String> resultProperties,
 String explanation,
 List<String> warnings,
 @Nullable Integer maxResults,
 @Nullable Integer firstResult)

Method Details

getJpql

public String getJpql()

Returns the generated JPQL select query. Every SELECT expression is aliased via AS.

Returns:

the generated JPQL select query

getParameters

public List<GeneratedJpqlParameter> getParameters()

Returns named parameters that must be bound when executing getJpql()

Returns:

named parameters

getResultProperties

public List<String> getResultProperties()

Returns result column names in the exact order of the SELECT expressions in getJpql(); used as keys for the row maps in the execution result.

Returns:

result column names

getExplanation

public String getExplanation()

Returns:

human-readable explanation of what the query does, produced by the LLM

getWarnings

public List<String> getWarnings()

Returns:

warnings emitted by the LLM about the generated query (assumptions made, approximations, applied pagination, etc.)

getMaxResults

public @Nullable Integer getMaxResults()

Returns requested row limit, or null to apply the default limit on execution.

Returns:

requested row limit

getFirstResult

public @Nullable Integer getFirstResult()

Rrequested offset of the first row, or null to start from the first row.

Returns:

requested offset of the first row