io.jmix.data.impl.querymacro

Class AbstractQueryMacroHandler

java.lang.Object

io.jmix.data.impl.querymacro.AbstractQueryMacroHandler

All Implemented Interfaces:

QueryMacroHandler

Direct Known Subclasses:

DateAfterMacroHandler, DateBeforeMacroHandler, DateEqualsMacroHandler, EnumQueryMacroHandler, TimeBetweenQueryMacroHandler, TimeTodayQueryMacroHandler

public abstract class AbstractQueryMacroHandler
extends java.lang.Object
implements QueryMacroHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected java.util.Map<java.lang.String,java.lang.Class>	expandedParamTypes
protected java.util.regex.Pattern	macroPattern

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueryMacroHandler(java.util.regex.Pattern macroPattern)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	doExpand(java.lang.String macro)
java.lang.String	expandMacro(java.lang.String queryString) Replaces macro with real JPQL code.
protected java.util.TimeZone	getTimeZoneFromArgs(java.lang.String[] args, int pos)
void	setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)
void	setExpandedParamTypes(java.util.Map<java.lang.String,java.lang.Class> expandedParamTypes) Sets expanded parameter types of the expanded query to the macro handler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.data.impl.QueryMacroHandler

getParams, replaceQueryParams, setQueryParams

Field Detail

count

protected int count

macroPattern

protected final java.util.regex.Pattern macroPattern

expandedParamTypes

protected java.util.Map<java.lang.String,java.lang.Class> expandedParamTypes

currentAuthentication

protected io.jmix.core.security.CurrentAuthentication currentAuthentication

Constructor Detail

AbstractQueryMacroHandler

protected AbstractQueryMacroHandler(java.util.regex.Pattern macroPattern)

Method Detail

setCurrentAuthentication

@Autowired
public void setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)

expandMacro

public java.lang.String expandMacro(java.lang.String queryString)

Description copied from interface: QueryMacroHandler

Replaces macro with real JPQL code. If macro is not found, the source query string is returned.

Specified by:

expandMacro in interface QueryMacroHandler

Parameters:

queryString - source query string

Returns:

query string with macros replaced

doExpand

protected abstract java.lang.String doExpand(java.lang.String macro)

setExpandedParamTypes

public void setExpandedParamTypes(java.util.Map<java.lang.String,java.lang.Class> expandedParamTypes)

Description copied from interface: QueryMacroHandler

Sets expanded parameter types of the expanded query to the macro handler.

Specified by:

setExpandedParamTypes in interface QueryMacroHandler

Parameters:

expandedParamTypes - all expanded parameter types

getTimeZoneFromArgs

@Nullable
protected java.util.TimeZone getTimeZoneFromArgs(java.lang.String[] args,
                                                           int pos)