/**
Copyright (c) 2005-2008, Engineering Ingegneria Informatica s.p.a.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
* Neither the name of the Engineering Ingegneria Informatica s.p.a. nor the names of its contributors may
be used to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
**/
package it.eng.spagobi.engines.drivers.jasperreport;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.log4j.Logger;
import it.eng.spago.base.SourceBean;
import it.eng.spago.error.EMFInternalError;
import it.eng.spago.error.EMFUserError;
import it.eng.spago.security.IEngUserProfile;
import it.eng.spagobi.analiticalmodel.document.bo.BIObject;
import it.eng.spagobi.analiticalmodel.document.bo.ObjTemplate;
import it.eng.spagobi.analiticalmodel.document.dao.IBIObjectDAO;
import it.eng.spagobi.analiticalmodel.document.dao.IObjTemplateDAO;
import it.eng.spagobi.analiticalmodel.document.dao.ISubreportDAO;
import it.eng.spagobi.behaviouralmodel.analyticaldriver.bo.BIObjectParameter;
import it.eng.spagobi.commons.SingletonConfig;
import it.eng.spagobi.commons.bo.Subreport;
import it.eng.spagobi.commons.dao.DAOFactory;
import it.eng.spagobi.commons.utilities.ParameterValuesEncoder;
import it.eng.spagobi.engines.drivers.AbstractDriver;
import it.eng.spagobi.engines.drivers.EngineURL;
import it.eng.spagobi.engines.drivers.IEngineDriver;
import it.eng.spagobi.engines.drivers.exceptions.InvalidOperationRequest;
/**
* Driver Implementation (IEngineDriver Interface) for Jasper Report Engine.
*/
public class JasperReportDriver extends AbstractDriver implements IEngineDriver {
static Logger logger = Logger.getLogger(JasperReportDriver.class);
/**
* Returns a map of parameters which will be send in the request to the
* engine application.
*
* @param profile
* Profile of the user
* @param roleName
* the name of the execution role
* @param biobject
* the biobject
*
* @return Map The map of the execution call parameters
*/
public Map getParameterMap(Object biobject, IEngUserProfile profile, String roleName) {
logger.debug("IN");
Map map = new Hashtable();
try {
BIObject biobj = (BIObject) biobject;
map = getMap(biobj);
} catch (ClassCastException cce) {
logger.error("The parameter is not a BIObject type", cce);
}
map = applySecurity(map, profile);
logger.debug("OUT");
return map;
}
/**
* Returns a map of parameters which will be send in the request to the
* engine application.
*
* @param subObject
* SubObject to execute
* @param profile
* Profile of the user
* @param roleName
* the name of the execution role
* @param object
* the object
*
* @return Map The map of the execution call parameters
*/
public Map getParameterMap(Object object, Object subObject, IEngUserProfile profile, String roleName) {
return getParameterMap(object, profile, roleName);
}
/**
* Starting from a BIObject extracts from it the map of the paramaeters for
* the execution call
*
* @param biobj
* BIObject to execute
* @return Map The map of the execution call parameters
*/
private Map getMap(BIObject biobj) {
logger.debug("IN");
Map pars = new Hashtable();
String documentId = biobj.getId().toString();
pars.put("document", documentId);
logger.debug("Add document parameter:" + documentId);
pars.put("documentLabel", biobj.getLabel());
logger.debug("Add document parameter:" + biobj.getLabel());
// adding date format parameter
SingletonConfig config = SingletonConfig.getInstance();
String formatSB = config.getConfigValue("SPAGOBI.DATE-FORMAT.format");
String format = (formatSB == null) ? "DD-MM-YYYY" : formatSB;
pars.put("dateformat", format);
pars = addBISubreports(biobj, pars);
pars = addBIParameters(biobj, pars);
pars = addBIParameterDescriptions(biobj, pars);
logger.debug("OUT");
return pars;
}
/**
* Add subreport informations
*/
private Map addBISubreports(BIObject reportBObject, Map pars) {
ISubreportDAO subreportDAO;
IBIObjectDAO bobjectDAO;
IObjTemplateDAO templateDAO;
List<Subreport> subreports;
Subreport subreport;
BIObject subreportBObject;
ObjTemplate subreportTemplate;
String prefixName;
String tempName;
String flgTemplateStandard;
Integer id;
try {
subreportDAO = DAOFactory.getSubreportDAO();
bobjectDAO = DAOFactory.getBIObjectDAO();
templateDAO = DAOFactory.getObjTemplateDAO();
subreports = subreportDAO.loadSubreportsByMasterRptId( reportBObject.getId() );
for (int i = 0; i < subreports.size(); i++) {
subreport = subreports.get(i);
subreportBObject = bobjectDAO.loadBIObjectForDetail(subreport.getSub_rpt_id());
subreportTemplate = templateDAO.getBIObjectActiveTemplate(subreportBObject.getId());
prefixName = subreportBObject.getId() + "_" + subreportTemplate.getBinId();
pars.put("sr." + (i + 1) + ".ids", prefixName);
logger.debug("ids: " + prefixName);
/*
tempName = subreportTemplate.getName().substring(0,subreportTemplate.getName().indexOf("."));
pars.put("subrpt." + (i + 1) + ".tempName", tempName);
logger.debug("tempName: " + tempName);
*/
/*
flgTemplateStandard = "true";
if (subreportTemplate.getName().indexOf(".zip") > -1) {
flgTemplateStandard = "false";
}
pars.put("subrpt." + (i + 1) + ".flgTempStd", flgTemplateStandard);
logger.debug("flgTemplateStandard: " + flgTemplateStandard);
*/
/*
id = subreportBObject.getId();
pars.put("subrpt." + (i + 1) + ".id", id);
logger.debug("id: " + id);
*/
}
//pars.put("srptnum", "" + subreports.size());
} catch (EMFUserError e) {
logger.error("Error while reading subreports:", e);
} catch (EMFInternalError ex) {
logger.error("Error while reading subreports:", ex);
}
return pars;
}
/**
* Add into the parameters map the BIObject's BIParameter names and values
*
* @param biobj
* BIOBject to execute
* @param pars
* Map of the parameters for the execution call
* @return Map The map of the execution call parameters
*/
private Map addBIParameters(BIObject biobj, Map pars) {
logger.debug("IN");
try{
if (biobj == null) {
logger.warn("BIObject is null");
return pars;
}
//add prefix (objId__templateId) of the master template for manage subreport cache
IObjTemplateDAO tempdao = DAOFactory.getObjTemplateDAO();
ObjTemplate objtemp = tempdao.getBIObjectActiveTemplate(biobj.getId());
String prefixName = biobj.getId() + "__" + objtemp.getBinId();
pars.put("prefixName", prefixName);
logger.debug(" prefixName: " + prefixName);
ParameterValuesEncoder parValuesEncoder = new ParameterValuesEncoder();
if (biobj.getBiObjectParameters() != null) {
BIObjectParameter biobjPar = null;
for (Iterator it = biobj.getBiObjectParameters().iterator(); it.hasNext();) {
try {
biobjPar = (BIObjectParameter) it.next();
String value = parValuesEncoder.encode(biobjPar);
if (value != null)
pars.put(biobjPar.getParameterUrlName(), value);
else
logger.warn("value encoded IS null");
logger.debug("Add parameter:" + biobjPar.getParameterUrlName() + "/" + value);
} catch (Exception e) {
logger.error("Error while processing a BIParameter", e);
}
}
}
} catch (EMFUserError e) {
logger.error("Error while reading subreports:", e);
} catch (EMFInternalError ex) {
logger.error("Error while reading subreports:", ex);
}
logger.debug("OUT");
return pars;
}
/**
* Function not implemented. This method should not be called
*
* @param biobject
* The BIOBject to edit
* @param profile
* the profile
*
* @return the edits the document template build url
*
* @throws InvalidOperationRequest
* the invalid operation request
*/
public EngineURL getEditDocumentTemplateBuildUrl(Object biobject, IEngUserProfile profile)
throws InvalidOperationRequest {
logger.warn("Function not implemented");
throw new InvalidOperationRequest();
}
/**
* Function not implemented. Thid method should not be called
*
* @param biobject
* The BIOBject to edit
* @param profile
* the profile
*
* @return the new document template build url
*
* @throws InvalidOperationRequest
* the invalid operation request
*/
public EngineURL getNewDocumentTemplateBuildUrl(Object biobject, IEngUserProfile profile)
throws InvalidOperationRequest {
logger.warn("Function not implemented");
throw new InvalidOperationRequest();
}
}