Package io.jmix.flowui.component.codeeditor.autocomplete

Class JpqlUiSuggestionProvider

java.lang.Object

io.jmix.flowui.component.codeeditor.autocomplete.JpqlUiSuggestionProvider

@Component("flowui_JpqlUiSuggestionProvider")
public class JpqlUiSuggestionProvider
extends Object

Provides auto-completion suggestions for JPQL queries in the user interface. Used to provide auto-completion suggestions using Suggester in the CodeEditor component.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CURRENT_USER_PREFIX
protected CurrentAuthentication	currentAuthentication
protected static final String	ENTITY_PLACEHOLDER
protected static final String	INITIAL_QUERY
protected static final String	JOIN
protected Metadata	metadata
protected static final String	QUERY_LANGUAGE
protected QuerySuggestionProvider	querySuggestionProvider
protected static final String	WHERE

Constructor Summary

Constructors

Constructor	Description
JpqlUiSuggestionProvider(CurrentAuthentication currentAuthentication, Metadata metadata, QuerySuggestionProvider querySuggestionProvider)

Method Summary

Modifier and Type	Method	Description
protected void	addCurrentUserAttributesSuggestions(Suggester.SuggestionContext context, List<Suggestion> suggestions)
protected List<Suggestion>	getCurrentUserAttributes()
List<Suggestion>	getSuggestions(Suggester.SuggestionContext context, String query, int queryPosition)
List<Suggestion>	getSuggestions(Suggester.SuggestionContext context, String query, int queryPosition, Supplier<Map<String,String>> parametersSupplier)
List<Suggestion>	getSuggestions(Suggester.SuggestionContext context, String join, String where, String entityName, boolean isJoinClause)
protected Suggestion	propertyToSuggestionMapper(MetaProperty metaProperty)
protected Suggestion	queryOptionToSuggestion(QuerySuggestions.Option option)

Methods inherited from class java.lang.Object

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

Field Details

INITIAL_QUERY

protected static final String INITIAL_QUERY

See Also:

• Constant Field Values

JOIN

protected static final String JOIN

See Also:

• Constant Field Values

WHERE

protected static final String WHERE

See Also:

• Constant Field Values

ENTITY_PLACEHOLDER

protected static final String ENTITY_PLACEHOLDER

See Also:

• Constant Field Values

QUERY_LANGUAGE

protected static final String QUERY_LANGUAGE

See Also:

• Constant Field Values

CURRENT_USER_PREFIX

protected static final String CURRENT_USER_PREFIX

See Also:

• Constant Field Values

currentAuthentication

protected CurrentAuthentication currentAuthentication

metadata

protected Metadata metadata

querySuggestionProvider

protected QuerySuggestionProvider querySuggestionProvider

Constructor Details

JpqlUiSuggestionProvider

public JpqlUiSuggestionProvider(CurrentAuthentication currentAuthentication,
 Metadata metadata,
 QuerySuggestionProvider querySuggestionProvider)

Method Details

getSuggestions

public List<Suggestion> getSuggestions(Suggester.SuggestionContext context,
 @Nullable
 String join,
 @Nullable
 String where,
 String entityName,
 boolean isJoinClause)

Parameters:

context - the current state of the client-side of the component

join - JOIN clause used in the query

where - WHERE clause used in the query

entityName - the name of the entity for which the query is created

isJoinClause - is suggestions requested for JOIN clause

Returns:

list of suggestions for autocompletion of JPQL query based on the current editor state and the context of the call

getSuggestions

public List<Suggestion> getSuggestions(Suggester.SuggestionContext context,
 String query,
 int queryPosition)

Parameters:

context - the current state of the client-side of the component

query - the query for which the suggestions will be provided

queryPosition - the position in the query for which suggestions will be provided

Returns:

list of suggestions for autocompletion of JPQL query

getSuggestions

public List<Suggestion> getSuggestions(Suggester.SuggestionContext context,
 String query,
 int queryPosition,
 @Nullable
 Supplier<Map<String,String>> parametersSupplier)

Parameters:

context - the current state of the client-side of the component

query - the query for which the suggestions will be provided

queryPosition - the position in the query for which suggestions will be provided

parametersSupplier - supplier of parameters for the query

Returns:

list of suggestions for autocompletion of JPQL query

addCurrentUserAttributesSuggestions

protected void addCurrentUserAttributesSuggestions(Suggester.SuggestionContext context,
 List<Suggestion> suggestions)

getCurrentUserAttributes

protected List<Suggestion> getCurrentUserAttributes()

propertyToSuggestionMapper

protected Suggestion propertyToSuggestionMapper(MetaProperty metaProperty)

queryOptionToSuggestion

protected Suggestion queryOptionToSuggestion(QuerySuggestions.Option option)