Package io.jmix.data.impl.querymacro

Class DateBetweenQueryMacroHandler

java.lang.Object

io.jmix.data.impl.querymacro.AbstractQueryMacroHandler

io.jmix.data.impl.querymacro.DateBetweenQueryMacroHandler

All Implemented Interfaces:

QueryMacroHandler

@Component("data_DateBetweenQueryMacroHandler")
@Scope("prototype")
public class DateBetweenQueryMacroHandler
extends AbstractQueryMacroHandler

A query macro handler that processes the `@dateBetween` macro. This macro is used to filter date fields within a specified custom range. The `@dateBetween` macro expects arguments representing a field name, a start parameter, an end parameter, and an optional time zone.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Pattern	MACRO_PATTERN
protected List<MacroArgs>	macroArgs
protected Map<String,Object>	namedParameters
protected static final Pattern	QUERY_PARAM_PATTERN
protected DateTimeTransformations	transformations

Fields inherited from class io.jmix.data.impl.querymacro.AbstractQueryMacroHandler

count, currentAuthentication, expandedParamTypes, macroPattern

Constructor Summary

Constructors

Constructor	Description
DateBetweenQueryMacroHandler()

Method Summary

Modifier and Type	Method	Description
protected String	doExpand(String macro)
protected String	getParam(String[] args, int index, TimeZone timeZone)
Map<String,Object>	getParams()
String	replaceQueryParams(String queryString, Map<String,Object> params)	Replaces param names in queryString with its values from the params parameter.
void	setQueryParams(Map<String,Object> namedParameters)	Sets parameters of the expanded query to the macro handler.
void	setTransformations(DateTimeTransformations transformations)

Methods inherited from class io.jmix.data.impl.querymacro.AbstractQueryMacroHandler

expandMacro, getTimeZoneFromArgs, setCurrentAuthentication, setExpandedParamTypes

Methods inherited from class java.lang.Object

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

Field Details

MACRO_PATTERN

protected static final Pattern MACRO_PATTERN

QUERY_PARAM_PATTERN

protected static final Pattern QUERY_PARAM_PATTERN

transformations

protected DateTimeTransformations transformations

macroArgs

protected List<MacroArgs> macroArgs

namedParameters

protected Map<String,Object> namedParameters

Constructor Details

DateBetweenQueryMacroHandler

public DateBetweenQueryMacroHandler()

Method Details

setTransformations

@Autowired
public void setTransformations(DateTimeTransformations transformations)

setQueryParams

public void setQueryParams(Map<String,Object> namedParameters)

Description copied from interface: QueryMacroHandler

Sets parameters of the expanded query to the macro handler.

Parameters:

namedParameters - all named parameters of the expanded query

doExpand

protected String doExpand(String macro)

Specified by:

doExpand in class AbstractQueryMacroHandler

getParams

public Map<String,Object> getParams()

Returns:

all named parameters of the expanded query augmented with the macro parameters

getParam

protected String getParam(String[] args,
 int index,
 TimeZone timeZone)

replaceQueryParams

public String replaceQueryParams(String queryString,
 Map<String,Object> params)

Description copied from interface: QueryMacroHandler

Replaces param names in queryString with its values from the params parameter. If macro is not found, the source query string is returned.

Returns:

modified query string