/*
* DynamicJasper: A library for creating reports dynamically by specifying
* columns, groups, styles, etc. at runtime. It also saves a lot of development
* time in many cases! (http://sourceforge.net/projects/dynamicjasper)
*
* Copyright (C) 2008 FDV Solutions (http://www.fdvsolutions.com)
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
*
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*
*/
package ar.com.fdvs.dj.util;
import java.sql.Connection;
import java.sql.ResultSet;
import java.util.Collection;
import java.util.Iterator;
import net.sf.jasperreports.engine.JRDataSource;
import net.sf.jasperreports.engine.JRResultSetDataSource;
import net.sf.jasperreports.engine.JRVariable;
import net.sf.jasperreports.engine.data.JRBeanArrayDataSource;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;
import net.sf.jasperreports.engine.design.JRDesignExpression;
import net.sf.jasperreports.engine.design.JRDesignField;
import net.sf.jasperreports.engine.design.JRDesignParameter;
import net.sf.jasperreports.engine.design.JasperDesign;
import ar.com.fdvs.dj.core.DJConstants;
import ar.com.fdvs.dj.core.DJDefaultScriptlet;
import ar.com.fdvs.dj.domain.ColumnProperty;
import ar.com.fdvs.dj.domain.CustomExpression;
import ar.com.fdvs.dj.domain.DJCalculation;
import ar.com.fdvs.dj.domain.DJDataSource;
import ar.com.fdvs.dj.domain.DynamicJasperDesign;
import ar.com.fdvs.dj.domain.entities.DJGroup;
import ar.com.fdvs.dj.domain.entities.Subreport;
import ar.com.fdvs.dj.domain.entities.SubreportParameter;
import ar.com.fdvs.dj.domain.entities.columns.PercentageColumn;
public class ExpressionUtils {
private static final String REPORT_PARAMETERS_MAP = "$P{REPORT_PARAMETERS_MAP}";
/**
* Returns an expression that points to a java.util.Map object with the parameters to
* be used during the subreport fill time.
* Posibilities are:<br>
* - Use Partent report Map<br>
* - Use a Map that is a parameter of the partents map<br>
* - Use a property of the current row.
* @param sr
* @return
*/
public static JRDesignExpression getParameterExpression(Subreport sr) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClassName(java.util.Map.class.getName());
if (sr.isUseParentReportParameters()){
exp.setText(REPORT_PARAMETERS_MAP);
return exp;
}
if (sr.getParametersExpression() == null)
return null;
if (sr.getParametersMapOrigin() == DJConstants.SUBREPORT_PARAMETER_MAP_ORIGIN_PARAMETER){
exp.setText(REPORT_PARAMETERS_MAP + ".get( \""+ sr.getParametersExpression() +"\" )");
return exp;
}
if (sr.getParametersMapOrigin() == DJConstants.SUBREPORT_PARAMETER_MAP_ORIGIN_FIELD){
exp.setText("$F{"+ sr.getParametersExpression() +"}");
return exp;
}
return null;
}
/**
* Returns the expression string required
* @param ds
* @return
*/
public static JRDesignExpression getDataSourceExpression(DJDataSource ds) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClass(JRDataSource.class);
String dsType = getDataSourceTypeStr(ds.getDataSourceType());
String expText = null;
if (ds.getDataSourceOrigin() == DJConstants.DATA_SOURCE_ORIGIN_FIELD){
expText = dsType + "$F{" + ds.getDataSourceExpression() + "})";
} else if (ds.getDataSourceOrigin() == DJConstants.DATA_SOURCE_ORIGIN_PARAMETER){
expText = dsType + REPORT_PARAMETERS_MAP + ".get( \""+ ds.getDataSourceExpression() +"\" ) )";
} else if (ds.getDataSourceOrigin() == DJConstants.DATA_SOURCE_TYPE_SQL_CONNECTION) {
expText = dsType + REPORT_PARAMETERS_MAP + ".get( \""+ ds.getDataSourceExpression() +"\" ) )";
} else if (ds.getDataSourceOrigin() == DJConstants.DATA_SOURCE_ORIGIN_REPORT_DATASOURCE) {
expText = "((" + JRDataSource.class.getName()+ ")" + REPORT_PARAMETERS_MAP + ".get( \"REPORT_DATA_SOURCE\" ) )";
}
exp.setText(expText);
return exp;
}
public static JRDesignExpression getConnectionExpression(DJDataSource ds) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClass(Connection.class);
String dsType = getDataSourceTypeStr(ds.getDataSourceType());
String expText = dsType + REPORT_PARAMETERS_MAP + ".get( \""+ ds.getDataSourceExpression() +"\" ) )";
exp.setText(expText);
return exp;
}
/**
* Returns a JRDesignExpression that points to the main report connection
* @return
*/
public static JRDesignExpression getReportConnectionExpression() {
JRDesignExpression connectionExpression = new JRDesignExpression();
connectionExpression.setText("$P{"+JRDesignParameter.REPORT_CONNECTION+"}");
connectionExpression.setValueClass(Connection.class);
return connectionExpression;
}
protected static String getDataSourceTypeStr(int datasourceType) {
//TODO Complete all other possible types
String dsType = "(";
if (DJConstants.DATA_SOURCE_TYPE_COLLECTION == datasourceType){
dsType = "new "+JRBeanCollectionDataSource.class.getName()+"((java.util.Collection)";
}
else if (DJConstants.DATA_SOURCE_TYPE_ARRAY == datasourceType){
dsType = "new "+JRBeanArrayDataSource.class.getName()+"((Object[])";
}
else if (DJConstants.DATA_SOURCE_TYPE_RESULTSET == datasourceType){
dsType = "new "+JRResultSetDataSource.class.getName()+"(("+ResultSet.class.getName() +")";
}
else if (DJConstants.DATA_SOURCE_TYPE_JRDATASOURCE == datasourceType){
dsType = "(("+JRDataSource.class.getName() +")";
}
else if (DJConstants.DATA_SOURCE_TYPE_SQL_CONNECTION == datasourceType){
dsType = "(("+Connection.class.getName() +")";
}
return dsType;
}
public static JRDesignExpression createStringExpression(String text) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClass(String.class);
exp.setText(text);
return exp;
}
public static JRDesignExpression createExpression(String text, Class clazz) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClass(clazz);
exp.setText(text);
return exp;
}
public static JRDesignExpression createExpression(String text, String className) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClassName(className);
exp.setText(text);
return exp;
}
public static JRDesignExpression createExpression(JasperDesign jasperDesign,SubreportParameter sp) {
JRDesignExpression exp = new JRDesignExpression();
exp.setValueClassName(sp.getClassName());
String text = null;
if (sp.getParameterOrigin()== DJConstants.SUBREPORT_PARAM_ORIGIN_FIELD){
text = "$F{" + sp.getExpression() + "}";
//We need to set proper class type to expression according to field class
if (sp.getClassName() == null){
JRDesignField jrField = (JRDesignField) jasperDesign.getFieldsMap().get(sp.getExpression());
if (jrField != null)
exp.setValueClass(jrField.getValueClass());
else
exp.setValueClass(Object.class);
}
} else if (sp.getParameterOrigin()== DJConstants.SUBREPORT_PARAM_ORIGIN_PARAMETER){
text = REPORT_PARAMETERS_MAP + ".get( \""+ sp.getExpression() +"\")";
} else if (sp.getParameterOrigin()== DJConstants.SUBREPORT_PARAM_ORIGIN_VARIABLE){
text = "$V{" + sp.getExpression() + "}";
} else { //CUSTOM
text = sp.getExpression();
}
exp.setText(text);
return exp;
}
public static JRDesignExpression createAndRegisterExpression(DynamicJasperDesign design, String name, CustomExpression expression) {
LayoutUtils.registerCustomExpressionParameter(design, name, expression);
return createExpression(name, expression);
}
public static JRDesignExpression createExpression(String name, CustomExpression expression) {
String text = ExpressionUtils.createCustomExpressionInvocationText(name);
return createExpression(text, expression.getClassName());
}
/**
*
* @param Collection of ColumnProperty
* @return
*/
public static String getFieldsMapExpression(Collection columnsAndFields) {
StringBuffer fieldsMap = new StringBuffer("new " + PropertiesMap.class.getName() + "()" );
for (Iterator iter = columnsAndFields.iterator(); iter.hasNext();) {
ColumnProperty columnProperty = (ColumnProperty) iter.next();
if (columnProperty != null) {
String propname = columnProperty.getProperty();
fieldsMap.append(".with(\"" + propname + "\",$F{" + propname + "})");
}
}
return fieldsMap.toString();
}
/**
* Collection of JRVariable
* @param variables
* @return
*/
public static String getVariablesMapExpression(Collection variables) {
StringBuffer variablesMap = new StringBuffer("new " + PropertiesMap.class.getName() + "()");
for (Iterator iter = variables.iterator(); iter.hasNext();) {
JRVariable jrvar = (JRVariable) iter.next();
String varname = jrvar.getName();
variablesMap.append(".with(\"" + varname + "\",$V{" + varname + "})");
}
return variablesMap.toString();
}
public static String getParametersMapExpression() {
return "new " + PropertiesMap.class.getName() + "($P{" + DJConstants.CUSTOM_EXPRESSION__PARAMETERS_MAP +"} )";
}
public static String createParameterName(String preffix, Object obj) {
String name = obj.toString().substring(obj.toString().lastIndexOf(".")+1).replaceAll("[\\$@]", "_");
return preffix + name;
}
/**
* If you register a CustomExpression with the name "customExpName", then this will create the text needed
* to invoke it in a JRDesignExpression
* @param customExpName
* @return
*/
public static String createCustomExpressionInvocationText(String customExpName) {
String fieldsMap = "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_SCRIPTLET}).getCurrentFiels()";
String parametersMap = "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_SCRIPTLET}).getCurrentParams()";
String variablesMap = "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_SCRIPTLET}).getCurrentVariables()";
// String stringExpression = "((("+CustomExpression.class.getName()+")$P{"+customExpName+"})."
// +CustomExpression.EVAL_METHOD_NAME+"( "+ fieldsMap +", " + variablesMap + ", " + parametersMap +" ))";
String stringExpression = "(("+CustomExpression.class.getName()+")$P{REPORT_PARAMETERS_MAP}.get(\""+customExpName+"\"))."
+CustomExpression.EVAL_METHOD_NAME+"( "+ fieldsMap +", " + variablesMap + ", " + parametersMap +" )";
return stringExpression;
}
/**
* Same as regular, but instead of invoking directly $P{REPORT_SCRIPTLET}, it does through the $P{REPORT_PARAMETERS_MAP}
* @param customExpName
* @return
*/
public static String createCustomExpressionInvocationText2(String customExpName) {
String fieldsMap = getTextForFieldsFromScriptlet();
String parametersMap = getTextForParametersFromScriptlet();
String variablesMap = getTextForVariablesFromScriptlet();
// String stringExpression = "((("+CustomExpression.class.getName()+")$P{"+customExpName+"})."
// +CustomExpression.EVAL_METHOD_NAME+"( "+ fieldsMap +", " + variablesMap + ", " + parametersMap +" ))";
String stringExpression = "(("+CustomExpression.class.getName()+")$P{REPORT_PARAMETERS_MAP}.get(\""+customExpName+"\"))."
+CustomExpression.EVAL_METHOD_NAME+"( "+ fieldsMap +", " + variablesMap + ", " + parametersMap +" )";
return stringExpression;
}
public static String getTextForVariablesFromScriptlet() {
return "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_PARAMETERS_MAP}.get(\"REPORT_SCRIPTLET\")).getCurrentVariables()";
}
public static String getTextForParametersFromScriptlet() {
return "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_PARAMETERS_MAP}.get(\"REPORT_SCRIPTLET\")).getCurrentParams()";
}
public static String getTextForFieldsFromScriptlet() {
return "(("+DJDefaultScriptlet.class.getName() + ")$P{REPORT_PARAMETERS_MAP}.get(\"REPORT_SCRIPTLET\")).getCurrentFiels()";
}
public static String getValueClassNameForOperation(DJCalculation calc, ColumnProperty prop) {
if (calc == DJCalculation.COUNT || calc == DJCalculation.DISTINCT_COUNT)
return Long.class.getName();
else
return prop.getValueClassName();
}
public static String getInitialValueExpressionForOperation(DJCalculation calc, ColumnProperty prop) {
if (calc == DJCalculation.COUNT || calc == DJCalculation.DISTINCT_COUNT)
return "new java.lang.Long(\"0\")";
else if (calc == DJCalculation.SUM)
return "new " + prop.getValueClassName()+"(\"0\")";
else return null;
}
}