Package net.sf.jasperreports.engine.query

Class JRAbstractQueryExecuter

    • Field Detail

      • EXCEPTION_MESSAGE_KEY_NUMERIC_TYPE_REQUIRED

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_NUMERIC_TYPE_REQUIRED
        See Also:
        Constant Field Values

      • EXCEPTION_MESSAGE_KEY_PARAMETER_NOT_FOUND

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_PARAMETER_NOT_FOUND
        See Also:
        Constant Field Values

      • EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_CIRCULARLY_NESTED_PARAMETER

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_CIRCULARLY_NESTED_PARAMETER
        See Also:
        Constant Field Values

      • EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_ID_FIRST_TOKEN_MISSING

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_ID_FIRST_TOKEN_MISSING
        See Also:
        Constant Field Values

      • EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_NOT_FOUND

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_NOT_FOUND
        See Also:
        Constant Field Values

      • EXCEPTION_MESSAGE_KEY_UNSUPPORTED_PARAMETER_TYPE

        public static final java.lang.String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_PARAMETER_TYPE
        See Also:
        Constant Field Values

      • clauseFunctions

        protected final java.util.Map<java.lang.String,​JRClauseFunction> clauseFunctions
        Clause function registry.

    • Method Detail

      • registerClauseFunction

        protected void registerClauseFunction​(java.lang.String id,
                                      JRClauseFunction function)
        Registers a clause function.
        Parameters:
        id - the function ID
        function - the function

      • unregisterClauseFunction

        protected void unregisterClauseFunction​(java.lang.String id)
        Unregisters a clause function.
        Parameters:
        id - the function ID

      • resolveFunction

        protected JRClauseFunction resolveFunction​(java.lang.String id)
        Resolves a clause function ID to a function instance.
        Parameters:
        id - the function ID
        Returns:
        the clause function registered for the ID
        Throws:
        JRRuntimeException - if no function for the ID is found

      • findExtensionQueryFunction

        protected JRClauseFunction findExtensionQueryFunction​(java.lang.String id)

      • getCanonicalQueryLanguage

        protected java.lang.String getCanonicalQueryLanguage()
        Returns a canonical query language for this query executer implementation.

        The canonical language is used to retrieve extensions for the query executer.

        The default implementation returns the runtime query language used in the dataset, but query executer implementations should override this method and return a fixed language.

        Returns:
        a canonical query language

      • parseQuery

        protected void parseQuery()
        Parses the query and replaces the parameter clauses by the parameter values and the parameters by the return value of getParameterReplacement.

      • appendQueryChunk

        protected void appendQueryChunk​(java.lang.StringBuffer sbuffer,
                                JRQueryChunk chunk)

      • appendTextChunk

        protected void appendTextChunk​(java.lang.StringBuffer sbuffer,
                               java.lang.String text)

      • appendParameterChunk

        protected void appendParameterChunk​(java.lang.StringBuffer sbuffer,
                                    java.lang.String chunkText)

      • addQueryParameter

        protected void addQueryParameter​(java.lang.String parameterName)
        Records a query parameter.
        Parameters:
        parameterName - the parameter name
        See Also:
        getCollectedParameters()

      • addQueryParameter

        protected void addQueryParameter​(java.lang.Class<?> type,
                                 java.lang.Object value)

      • appendParameterClauseChunk

        protected void appendParameterClauseChunk​(java.lang.StringBuffer sbuffer,
                                          java.lang.String chunkText)

      • appendClauseChunk

        protected void appendClauseChunk​(java.lang.StringBuffer sbuffer,
                                 java.lang.String[] clauseTokens)
        Handles a clause query chunk.

        The default implementation considers the first token as a clause function ID and delegates the call to the function.

        Extending query executers can override this to implement custom query clause handling.

        Parameters:
        sbuffer - the query text buffer
        clauseTokens - clause tokens
        Throws:
        JRRuntimeException - if there is no first token or no clause function is found for the ID
        See Also:
        registerClauseFunction(String, JRClauseFunction)

      • getQueryString

        protected java.lang.String getQueryString()
        Returns the parsed query string with the parameter clauses replaced by the parameter values and the parameters replaced by getParameterReplacement.
        Returns:
        the parsed query string

      • getCollectedParameterNames

        protected java.util.List<java.lang.String> getCollectedParameterNames()
        Returns the list of parameter names in the order in which they appear in the query.
        Returns:
        the list of parameter names

      • getParameterValue

        protected java.lang.Object getParameterValue​(java.lang.String parameterName,
                                             boolean ignoreMissing)
        Returns the value of a fill parameter.
        Parameters:
        parameterName - the parameter name
        ignoreMissing - if true, the method will return null for non existing parameters; otherwise, an exception will be thrown if the parameter does not exist
        Returns:
        the parameter value

      • getParameterValue

        protected java.lang.Object getParameterValue​(java.lang.String parameterName)
        Returns the value of a fill parameter.
        Parameters:
        parameterName - the parameter name
        Returns:
        the parameter value

      • parameterHasValue

        protected boolean parameterHasValue​(java.lang.String parameter)

      • getStringParameter

        protected java.lang.String getStringParameter​(java.lang.String parameter,
                                              java.lang.String property)

      • getStringParameterOrProperty

        protected java.lang.String getStringParameterOrProperty​(java.lang.String name)

      • getBooleanParameter

        protected boolean getBooleanParameter​(java.lang.String parameter,
                                      java.lang.String property,
                                      boolean defaultValue)

      • getBooleanParameterOrProperty

        protected boolean getBooleanParameterOrProperty​(java.lang.String name,
                                                boolean defaultValue)

      • getBooleanParameter

        protected java.lang.Boolean getBooleanParameter​(java.lang.String parameter,
                                                java.lang.String property)

      • getBooleanParameterOrProperty

        protected java.lang.Boolean getBooleanParameterOrProperty​(java.lang.String name)

      • getIntegerParameter

        protected int getIntegerParameter​(java.lang.String parameter,
                                  java.lang.String property,
                                  int defaultValue)

      • getIntegerParameterOrProperty

        protected int getIntegerParameterOrProperty​(java.lang.String name,
                                            int defaultValue)

      • getIntegerParameter

        protected java.lang.Integer getIntegerParameter​(java.lang.String parameter,
                                                java.lang.String property)

      • getIntegerParameterOrProperty

        protected java.lang.Integer getIntegerParameterOrProperty​(java.lang.String name)

      • getParameter

        protected JRFillParameter getParameter​(java.lang.String parameterName)
        Deprecated.
        getValueParameter(String) should be used instead
        Return a fill parameter from the parameter map.
        Parameters:
        parameterName - the parameter name
        Returns:
        the parameter

      • checkParameter

        protected void checkParameter​(java.lang.String parameterName)

      • getValueParameter

        protected JRValueParameter getValueParameter​(java.lang.String parameterName,
                                             boolean ignoreMissing)
        Return a value parameter from the parameters map.
        Parameters:
        parameterName - the parameter name
        ignoreMissing - if true, the method will return null for non existing parameters; otherwise, an exception will be thrown if the parameter does not exist
        Returns:
        the parameter

      • getValueParameter

        protected JRValueParameter getValueParameter​(java.lang.String parameterName)
        Return a value parameter from the parameters map.
        Parameters:
        parameterName - the parameter name
        Returns:
        the parameter

      • getParameterReplacement

        protected abstract java.lang.String getParameterReplacement​(java.lang.String parameterName)
        Returns the replacement text for a query parameter.
        Parameters:
        parameterName - the parameter name
        Returns:
        the replacement text
        See Also:
        JRQueryChunk.TYPE_PARAMETER