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:

Fixing FontAwesome for Windows 10

I ran into an issue with FontAwesome a few months back, where a NoCache header was being injected at the server and FA was broken for any partial refresh. I convinced the admin to reverse that setting and all was well until last week... We had some users who were not getting any icons to appear. Ever. We tracked it down to a new Windows 10 setting for IE11 which disallows untrusted fonts. Since we do not set security protocols for our users, and there is no chance of ever convincing those admins to change this policy that they explicitly turned on, I had to find a new solution. I did some searching and it turned out to not be too difficult. First, here is the original implementation. The theme: <control> <name>Icon.Search</name> <property mode="override"> <name>tagName</name> <value>i</value> </property> <property mode="concat"> <name>styleClass</name> <value>fa fa-search...

XPages Application Framework (Part 2 of ?)

In my last post, I offered a very rough overview of the framework I've been building and adapting. Full credit where it's due, I've been borrowing and adapting from Jesse Gallagher's XPages Scaffolding - an awesome project that I've learned a great deal dissecting. This is one of those projects that, if you make the effort to truly understand it, will give you entirely new tools and approaches for problems. As usual, I've learned the most changin g things and breaking them. My project differ s f rom Jesse's mostly in that it supports 8.5.3 and doesn't require any relaxed security permissions - bec ause I'm on 8.5.3 and because the admins h ere will not grant any relaxed permissions.