com.haulmont.cuba.core.sys

Interface QueryMacroHandler

All Known Implementing Classes:

AbstractQueryMacroHandler, DateAfterMacroHandler, DateBeforeMacroHandler, DateEqualsMacroHandler, EnumQueryMacroHandler, TimeBetweenQueryMacroHandler, TimeTodayQueryMacroHandler

public interface QueryMacroHandler

Interface to be implemented by JPQL macro handlers.

The implementation must be a managed bean with "prototype" scope.

Method Summary

Modifier and Type	Method and Description
java.lang.String	expandMacro(java.lang.String queryString) Replaces macro with real JPQL code.
java.util.Map<java.lang.String,java.lang.Object>	getParams()
java.lang.String	replaceQueryParams(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> params) Replaces param names in queryString with its values from the params parameter.
void	setQueryParams(java.util.Map<java.lang.String,java.lang.Object> namedParameters) Sets parameters of the expanded query to the macro handler.

Method Detail

expandMacro

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

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

Parameters:

queryString - source query string

Returns:

query string with macros replaced

setQueryParams

void setQueryParams(java.util.Map<java.lang.String,java.lang.Object> namedParameters)

Sets parameters of the expanded query to the macro handler.

Parameters:

namedParameters - all named parameters of the expanded query

getParams

java.util.Map<java.lang.String,java.lang.Object> getParams()

Returns:

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

replaceQueryParams

java.lang.String replaceQueryParams(java.lang.String queryString,
                                    java.util.Map<java.lang.String,java.lang.Object> params)

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