reporthelper.java

Sequoia ERP是一个真正的企业级开源ERP解决方案。它提供的模块包括：电子商务应用(e-commerce), POS系统(point of sales),知识管理,存货与仓库管理

/*
 *  $Id: ReportHelper.java 6395 2005-12-21 21:35:48  mujinsong $
 *
 *  Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a
 *  copy of this software and associated documentation files (the "Software"),
 *  to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
 *  and/or sell copies of the Software, and to permit persons to whom the
 *  Software is furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included
 *  in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
 *  OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 *  THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.ofbiz.marketing.report;

import org.ofbiz.base.util.UtilMisc;
import org.ofbiz.base.util.Debug;
import org.ofbiz.entity.GenericValue;
import org.ofbiz.entity.util.EntityUtil;
import org.ofbiz.marketing.tracking.TrackingCodeEvents;

import java.util.*;

/**
 * Marketing Report Helper
 *
 * @author <a href="mailto:[e-mail]">Mu Jinsong</a>
 * @author <a href="mailto:[e-mail]">Si Chen</a>
 * @version $Rev:  6395
 * @since 3.2
 */
public class ReportHelper {

    public static final String module = ReportHelper.class.getName();
    
/**
 * Calculate conversion rates based on a List of visits and orders.  Designed to be used for reporting on 
 * tracking code or marketing campaigns
 * @param visits
 * @param orders
 * @param keyFieldName - name of key field for visits and orders Lists, ie "trackingCodeId" or "marketingCampaignId"
 * @return a List of Maps with keys (${keyFieldName}, visits - # visits, orders - # orders, orderAmount - total amount of orders,
 * conversionRate - # orders/# visits
 */
    public static List calcConversionRates(List visits, List orders, String keyFieldName) {
        List conversionRates = new ArrayList();
        
        // loop through all the visits
        for (Iterator vit = visits.iterator(); vit.hasNext(); ) {
            GenericValue visit = (GenericValue) vit.next();
            Map reportValue = new HashMap();
            reportValue.put(keyFieldName, visit.getString(keyFieldName));
            reportValue.put("visits", visit.getLong("visitId")); // actually # of visits
            
            // find the matching entry in orders for the given key field
            List ordersForThisKey = EntityUtil.filterByAnd(orders, UtilMisc.toMap(keyFieldName, visit.getString(keyFieldName)));
            
            // if there are matching orders, then calculate orders, order amount, and conversion rate
            if ((ordersForThisKey != null) && (ordersForThisKey.size() > 0)) {
                // note: there should be only one line of order stats per key, so .get(0) should work
                GenericValue orderValue = (GenericValue) ordersForThisKey.get(0);

                reportValue.put("orders", orderValue.getLong("orderId")); // # of orders
                if (orderValue.getDouble("grandTotal") == null) {
                    reportValue.put("orderAmount", new Double(0));                    
                } else {
                    reportValue.put("orderAmount", orderValue.getDouble("grandTotal")); 
                }
                if ((orderValue.getLong("orderId") == null) || (visit.getLong("visitId") == null) || 
                    (visit.getLong("visitId").intValue() == 0)) {
                    reportValue.put("conversionRate", new Double(0));
                } else {
                    reportValue.put("conversionRate", new Double(orderValue.getLong("orderId").doubleValue() / visit.getLong("visitId").doubleValue()));    
                }
            } else {
                // no matching orders - all those values are zeroes
                reportValue.put("orders", new Long(0));
                reportValue.put("orderAmount", new Double(0));
                reportValue.put("conversionRate", new Double(0));
            }
            
            conversionRates.add(reportValue);
        }
        
        return conversionRates;
    }
}