Package io.jmix.aitools.dataload.execution

Class JpqlExecutionRequest

java.lang.Object

io.jmix.aitools.dataload.execution.JpqlExecutionRequest

public class JpqlExecutionRequest
extends Object

Input for JpqlExecutionService: a JPQL query together with everything needed to run it.

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	firstResult
protected String	jpql
protected Integer	maxResults
protected List<JpqlExecutionParameter>	parameters
protected List<String>	resultProperties
protected String	userText

Constructor Summary

Constructors

Constructor	Description
JpqlExecutionRequest()
JpqlExecutionRequest(String userText, String jpql, List<JpqlExecutionParameter> parameters, @Nullable List<String> resultProperties, @Nullable Integer maxResults, @Nullable Integer firstResult)

Method Summary

Modifier and Type	Method	Description
@Nullable Integer	getFirstResult()	Returns the requested row offset.
String	getJpql()	Returns the JPQL query to execute.
@Nullable Integer	getMaxResults()	Returns the requested maximum number of rows.
List<JpqlExecutionParameter>	getParameters()	Returns the query parameters.
List<String>	getResultProperties()	Returns the properties to select for each result row.
String	getUserText()	Returns the original user request in natural language.
void	setFirstResult(@Nullable Integer firstResult)
void	setJpql(String jpql)
void	setMaxResults(@Nullable Integer maxResults)
void	setParameters(@Nullable List<JpqlExecutionParameter> parameters)
void	setResultProperties(@Nullable List<String> resultProperties)
void	setUserText(String userText)

Methods inherited from class java.lang.Object

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

Field Details

userText

protected String userText

jpql

protected String jpql

parameters

protected List<JpqlExecutionParameter> parameters

resultProperties

protected List<String> resultProperties

maxResults

protected Integer maxResults

firstResult

protected Integer firstResult

Constructor Details

JpqlExecutionRequest

public JpqlExecutionRequest()

JpqlExecutionRequest

public JpqlExecutionRequest(String userText,
 String jpql,
 List<JpqlExecutionParameter> parameters,
 @Nullable List<String> resultProperties,
 @Nullable Integer maxResults,
 @Nullable Integer firstResult)

Parameters:

userText - original user request in natural language

jpql - JPQL query to execute

parameters - query parameters

resultProperties - properties to select, or null for none

maxResults - maximum number of rows, or null for the configured default

firstResult - row offset, or null for no offset

Method Details

getUserText

public String getUserText()

Returns the original user request in natural language.

Returns:

user request text

setUserText

public void setUserText(String userText)

getJpql

public String getJpql()

Returns the JPQL query to execute.

Returns:

JPQL query

setJpql

public void setJpql(String jpql)

getParameters

public List<JpqlExecutionParameter> getParameters()

Returns the query parameters.

Returns:

query parameters, never null

setParameters

public void setParameters(@Nullable List<JpqlExecutionParameter> parameters)

getResultProperties

public List<String> getResultProperties()

Returns the properties to select for each result row.

Returns:

result properties, never null

setResultProperties

public void setResultProperties(@Nullable List<String> resultProperties)

getMaxResults

public @Nullable Integer getMaxResults()

Returns the requested maximum number of rows.

Returns:

maximum number of rows, or null for the configured default

setMaxResults

public void setMaxResults(@Nullable Integer maxResults)

getFirstResult

public @Nullable Integer getFirstResult()

Returns the requested row offset.

Returns:

row offset, or null for no offset

setFirstResult

public void setFirstResult(@Nullable Integer firstResult)