1 /*
2  * JasperReports - Free Java Reporting Library.
3  * Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
4  * http://www.jaspersoft.com
5  *
6  * Unless you have purchased a commercial license agreement from Jaspersoft,
7  * the following license terms apply:
8  *
9  * This program is part of JasperReports.
10  *
11  * JasperReports is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * JasperReports is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
23  */
24 package net.sf.jasperreports.engine.query;
25
26
27
28 /**
29  * Base BETWEEN clause function for SQL queries. 
30  * <p>
31  * The purpose of this clause function is to find that a given 
32  * value can be found in a given A...B interval.
33  * </p>
34  * <p>
35  * The first token in the $X{...} syntax is the function ID token. Possible values for 
36  * the BETWEEN clause function ID token are:
37  * <ul>
38  * <li><code>BETWEEN</code> - in this case the A...B interval will be considered open: (A,B)</li>
39  * <li><code>[BETWEEN</code> - in this case the A...B interval will be considered right-open: [A,B)</li>
40  * <li><code>BETWEEN]</code> - in this case the A...B interval will be considered left-open: (A,B]</li>
41  * <li><code>[BETWEEN]</code> - in this case the A...B interval will be considered closed: [A,B]</li>
42  * </ul> 
43  * </p>
44  * 
45  * @author Sanda Zaharia (shertage@users.sourceforge.net)
46  */
47 public class JRSqlBetweenClause extends SQLBetweenBaseClause
48 {
49
50     protected static final JRSqlBetweenClause singleton = new JRSqlBetweenClause();
51     
52     /**
53      * Returns the singleton function instance.
54      * 
55      * @return the singleton function instance
56      */
57     public static JRSqlBetweenClause instance()
58     {
59         return singleton;
60     }
61
62     @Override
63     protected ClauseFunctionParameterHandler createParameterHandler(JRQueryClauseContext queryContext, 
64             String clauseId, String parameterName, boolean left)
65     {
66         Object paramValue = queryContext.getValueParameter(parameterName).getValue();
67         return new DefaultClauseFunctionParameterHandler(queryContext, parameterName, paramValue);
68     }
69 }
70