Package io.jmix.aitools.dataload.execution

Class GeneratedJpqlResult

java.lang.Object

io.jmix.aitools.dataload.execution.GeneratedJpqlResult

@NullMarked
public class GeneratedJpqlResult
extends Object

Structured JPQL draft returned by the generation layer.

This type represents what the LLM produced after generation or repair.

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>	warnings

Constructor Summary

Constructors

Constructor	Description
GeneratedJpqlResult(String jpql, List<GeneratedJpqlParameter> parameters, String explanation, List<String> warnings)	Creates a result without execution hints (maxResults / firstResult are unset).
GeneratedJpqlResult(String jpql, List<GeneratedJpqlParameter> parameters, String explanation, List<String> warnings, @Nullable Integer maxResults, @Nullable Integer firstResult)

Method Summary

Modifier and Type	Method	Description
String	getExplanation()	Returns a short human-readable explanation of the generated query intent.
@Nullable Integer	getFirstResult()	Returns the requested row offset, if the generation layer provided it.
String	getJpql()	Returns the generated JPQL text.
@Nullable Integer	getMaxResults()	Returns the requested maximum number of rows, if the generation layer provided it.
List<GeneratedJpqlParameter>	getParameters()	Returns the structured parameters produced together with the JPQL draft.
List<String>	getWarnings()	Returns warnings produced during generation, for example ambiguity notes.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

jpql

protected String jpql

parameters

protected List<GeneratedJpqlParameter> parameters

explanation

protected String explanation

warnings

protected List<String> warnings

maxResults

protected @Nullable Integer maxResults

firstResult

protected @Nullable Integer firstResult

Constructor Details

GeneratedJpqlResult

public GeneratedJpqlResult(String jpql,
 List<GeneratedJpqlParameter> parameters,
 String explanation,
 List<String> warnings)

Creates a result without execution hints (maxResults / firstResult are unset).

Parameters:

jpql - generated JPQL text

parameters - structured query parameters

explanation - short human-readable explanation of the query intent

warnings - warnings produced during generation

GeneratedJpqlResult

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

Parameters:

jpql - generated JPQL text

parameters - structured query parameters

explanation - short human-readable explanation of the query intent

warnings - warnings produced during generation

maxResults - requested maximum number of rows

firstResult - requested row offset

Method Details

getJpql

public String getJpql()

Returns the generated JPQL text.

Returns:

JPQL text

getParameters

public List<GeneratedJpqlParameter> getParameters()

Returns the structured parameters produced together with the JPQL draft.

Returns:

query parameters

getExplanation

public String getExplanation()

Returns a short human-readable explanation of the generated query intent.

Returns:

query explanation

getWarnings

public List<String> getWarnings()

Returns warnings produced during generation, for example ambiguity notes.

Returns:

generation warnings

getMaxResults

public @Nullable Integer getMaxResults()

Returns the requested maximum number of rows, if the generation layer provided it.

This value is still part of the generation-stage result and may later be normalized together with the JPQL text by post-processing.

Returns:

maximum number of rows, or null if not specified

getFirstResult

public @Nullable Integer getFirstResult()

Returns the requested row offset, if the generation layer provided it.

This value is still part of the generation-stage result and may later be normalized together with the JPQL text by post-processing.

Returns:

row offset, or null if not specified

toString

public String toString()

Overrides:

toString in class Object