Skip to main content

POI Spreadsheet Manager - Part 2

Part 1 was just laying some foundation. Now it's time to tackle some of the more troublesome bits of managing XLSX through POI. The first challenge I wanted to tackle is how to define Fonts and CellStyles. Every time you create one of these elements, it gets added to the .xlsx file, even if it is a duplicate of something you've already created. Also, there is a maximum number of each, so if you create your cells dynamically, you can run out of room to create new cells. You can get around this by first creating your spreadsheet, and then applying styling to groups of cells. Buy my goal was dynamic reports. I want to write a report without knowing what kind of data is going to be in each row or cell.

The first question I asked myself is how I wanted to define and keep track of CellStyles and Fonts. I used Enums. Here is how I define fonts.

public enum Fonts {
   REPORT_HEADER(20, 700, Color.BLACK, false),
   REPORT_SUBHEADER(14, 700, Color.BLACK, false),
   COLUMN_HEADER(10, 700, Color.BLACK, false),
   DATA(10, 400, Color.BLACK, false),
   TOTAL(10, 700, Color.BLACK, false),
   ERROR(14, 700, Color.RED, false);

   private short fontHeight;
   private short fontWeight;
   private Color color;
   private boolean italic;

   private Fonts(int fontHeight, int fontWeight, Color color, boolean italic)
   {
      this.fontHeight = (short) fontHeight;
      this.fontWeight = (short) fontWeight;
      this.color = color;
      this.italic = italic;
   }

   public short getFontHeight() {
      return fontHeight;
   }

   public short getFontWeight() {
      return fontWeight;
   }

   public XSSFColor getColor() {
      /**
       * Reverse black and white due to bug
       */
      if (color.equals(Color.BLACK)) {
         return new XSSFColor(Color.WHITE);
      } else if (color.equals(Color.WHITE)) {
         return new XSSFColor(Color.BLACK);
      } else {
         return new XSSFColor(color);
      }
   }

   public boolean isItalic() {
      return italic;
   }
}
And now I need a manager class to handle the creation and lookup of fonts. This class takes a Fonts argument, such as Fonts.REPORT_HEADER and returns the existing font if it has already been created, or creates a new one and returns that. In this way, I only ever create a font once.
public class FontManager {
   private final Workbook wb = null;
   private final Map styleMap;

   protected FontManager(Workbook wb) {
      this.wb = wb;
      this.fontMap = new HashMap;
   }

   public Font get(Fonts f) {
      if (!fontMap.containsKey(f)) {
         fontMap.put(f, createFont(f));
      }
      return fontMap.get(f);
   }
   private Font createFont(Fonts f) {
      XSSFFont font = (XSSFFont) wb.createFont();
      font.setBoldweight(f.getFontWeight());
      font.setFontHeightInPoints(f.getFontHeight());
      font.setFontName(Fonts.FONTNAME);
      font.setColor(f.getColor());
      return font;
   }
}
StyleManager works exactly the same and will be in Part 3...

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