net.sf.jasperreports.engine.query.SQLLessOrGreaterBaseClause Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.engine.query;
import net.sf.jasperreports.engine.JRRuntimeException;
/**
* @author sanda zaharia ([email protected])
*/
public abstract class SQLLessOrGreaterBaseClause implements JRClauseFunction
{
public static final String EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_DB_COLUMN_TOKEN_MISSING = "query.less.greater.clause.db.column.token.missing";
public static final String EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_NAME_TOKEN_MISSING = "query.less.greater.clause.name.token.missing";
public static final String EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_PARAMETER_TOKEN_MISSING = "query.less.greater.clause.parameter.token.missing";
protected static final int POSITION_CLAUSE_ID = 0;
protected static final int POSITION_DB_COLUMN = 1;
protected static final int POSITION_PARAMETER = 2;
protected static final String OPERATOR_LESS = "<";
protected static final String OPERATOR_LESS_OR_EQUAL = "<=";
protected static final String OPERATOR_GREATER = ">";
protected static final String OPERATOR_GREATER_OR_EQUAL = ">=";
protected static final String CLAUSE_TRUISM = "0 = 0";
protected SQLLessOrGreaterBaseClause()
{
//NOP
}
/**
* Creates either a LESS or a GREATER SQL clause, depending on the clause ID.
*
*
* The method expects two clause tokens (after the ID token):
*
* - The first token is the SQL column (or column combination) to be used in the clause.
* - The second token is the name of the report parameter that contains the value to compare to.
*
*
*
* The method constructs one of the following clauses:
*
* column < ?
if the clause ID is LESS
* column <= ?
if the clause ID is LESS]
* column >= ?
if the clause ID is GREATER
* column > ?
if the clause ID is [GREATER
*
* If the value to compare to is null, the method generates a SQL clause that
* will always evaluate to true (e.g. 0 = 0
).
*
*/
@Override
public void apply(JRClauseTokens clauseTokens, JRQueryClauseContext queryContext)
{
String clauseId = clauseTokens.getToken(POSITION_CLAUSE_ID);
String col = clauseTokens.getToken(POSITION_DB_COLUMN);
String param = clauseTokens.getToken(POSITION_PARAMETER);
if (clauseId == null)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_NAME_TOKEN_MISSING,
(Object[])null);
}
if (col == null)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_DB_COLUMN_TOKEN_MISSING,
(Object[])null);
}
if (param == null)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_QUERY_LESS_GREATER_CLAUSE_PARAMETER_TOKEN_MISSING,
(Object[])null);
}
ClauseFunctionParameterHandler paramHandler = createParameterHandler(queryContext, clauseId, param);
StringBuffer sbuffer = queryContext.queryBuffer();
if(!paramHandler.hasValue())
{
sbuffer.append(CLAUSE_TRUISM);
return;
}
sbuffer.append(col);
sbuffer.append(' ');
handleLessOrGreaterOperator(sbuffer, clauseId);
sbuffer.append(' ');
sbuffer.append('?');
paramHandler.addQueryParameter();
}
protected abstract ClauseFunctionParameterHandler createParameterHandler(JRQueryClauseContext queryContext,
String clauseId, String parameterName);
/**
* Appends the appropriate inequality sign to the query string, depending on the clause ID value
*
* @param sBuffer the StringBuffer that contains the generated query
* @param clauseId the clause ID
*/
protected void handleLessOrGreaterOperator(StringBuffer sBuffer, String clauseId)
{
if(JRJdbcQueryExecuter.CLAUSE_ID_LESS.equals(clauseId))
{
sBuffer.append(OPERATOR_LESS);
}
else if (JRJdbcQueryExecuter.CLAUSE_ID_LESS_OR_EQUAL.equals(clauseId))
{
sBuffer.append(OPERATOR_LESS_OR_EQUAL);
}
else if (JRJdbcQueryExecuter.CLAUSE_ID_GREATER.equals(clauseId))
{
sBuffer.append(OPERATOR_GREATER);
}
else if (JRJdbcQueryExecuter.CLAUSE_ID_GREATER_OR_EQUAL.equals(clauseId))
{
sBuffer.append(OPERATOR_GREATER_OR_EQUAL);
}
}
}