Skip to main content

POI Spreadsheet Manager - Part 1

I've been working on this project for about two years off and on now. Some parts of it shaped up early on, while others have undergone significant refactoring. Most of my reports are in Excel, but some few are done in Word. So I started with a class that accepts any POI XML document and a file name, and sends that file to the browser.


This is pretty straightforward, but is the black magic behind delivering the actual spreadsheet through the browser.

package itd.poi;

import itd.extlib.utils.jsf.JSFUtils;

import java.io.OutputStream;
import java.io.Serializable;

import javax.faces.context.FacesContext;

import org.apache.poi.POIXMLDocument;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.xwpf.usermodel.XWPFDocument;

import com.ibm.xsp.webapp.XspHttpServletResponse;

/*
 * This is a bridge between an XAgent and a PoiXmlDocument. It handles writing
 * the document back to the browser.
 */
public abstract class PoiBase implements Serializable {
    protected static final long serialVersionUID = 1L;

    protected static void write(POIXMLDocument poiXmlDoc, String filename) {
        // Create variables
        FacesContext facesContext = FacesContext.getCurrentInstance();
        XspHttpServletResponse response = JSFUtils.getResponse();
        OutputStream pageOut = null;

        try {
            pageOut = response.getOutputStream();
            if (poiXmlDoc instanceof XWPFDocument) {
                response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
            } else if (poiXmlDoc instanceof XSSFWorkbook) {
                response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            }
            response.setHeader("Cache-Control", "no-cache");
            response.setHeader("Content-Disposition", "attachment; filename=" + filename);

            poiXmlDoc.write(pageOut);
            pageOut.flush();
            pageOut.close();
        } catch (Exception e) {
            throw new RuntimeException("Error generating dynamic XML document: " + e.getMessage());
        } finally {
            facesContext.responseComplete();
        }
    }

Comments

Popular posts from this blog

Pass data between XPages and existing LS scripts

I'm working on modernizing a fairly hefty application with a lot of existing script libraries which we want to leverage within the XPages environment. Here is a technique that works very well. First, create an in-memory document in SSJS. We can set any input values needed for the back end. Then we pass that document to a LS Agent which can work it's magic using the values set in SSJS and use the same document to return values back to the XPage. Here is how it works in detail:

Quick tip: Convert a number to String in EL

I just had a need to do this and a Google search didn't immediately turn up a solution. So I thought for a couple of minutes and came up with this: value="0#{numberVar}" This takes advantage of the way Java auto-converts objects to strings when doing a concatenation. So if your number is 13, Java EL turns this into new String("0"+13), which becomes "013". You can then strip off the leading zero or just parse the string back into a number.

Project in Review - Part 3: What didn't work

Of course, not everything was an unmitigated success. I tried many things that didn't work out. Much of which I've removed and forgotten about, but a few things remain - either scarred into my psyche or woven too deeply to fix. What didn't work Storing my entire configuration in application.properties Using properties files is great. It let me get configuration out of a profile document and into something much easier to edit - particularly configuration that users will never see or maintain (and thus there is no need for an interface for). But I took it too far. The paths to the other databases are there, and that's good. But view aliases are also there, and that was a mistake. I already have a ViewDefinition enum that describes each view and all the information I need to know about it. I could have set view names there, but instead I'm reading them from the application config. I can change where a view is pointing without having to go into my code. Except of co