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

XPages Application Framework (Part 1?)

Note: I changed projects and priorities after my last POI article, resulting in a long hiatus. I anticipate using that framework on my current project and will likely refine and complete my related article series. For the past several months, I've been fortunate enough to lead a project overhaul from traditional Domino Webapp to XPages. I had a few goals in mind, but the top three were integrating Bootstrap, embracing MVC principles, and eliminating all SSJS . I imagine the motivation for Bootstrap integration is self-explanatory. There is an OpenNTF project out there called Bootstrap4XPages. I didn't use that for a number of reasons - the main being a policy in the current environment. But you may ask yourself (if you didn't follow that link), why so much hatred for SSJS? I have a litany of reasons. It impacts readability of the XPage source; it hurts maintainability when logic is scattered across dozens of XPages, custom controls, and script libraries; it mixes log...

Rows per page selection: Part 1

I was asked to create a control that would allow users to select the number of rows per page in a view/repeat control (the application uses both). It seemed simple at first, but I ran into a few issues that I thought I'd share the solutions to. First, lets start at the beginning. I went through the relevant design elements and set row="#{viewScope.tableRows}" , and I created an xp:comboBox with value="#{viewScope.tableRows}" and added items for 20, 30, 50, and 100, and I assigned it an onChange event handler that did a partial execution and partial refresh of a div containing the combo box, pager and the table. Then I started fixing all the problems. Problem 1: The combobox value was a string, but the rows parameter requires an integer. This was causing IllegalArgumentException / java.lang.String incompatible with java.lang.Integer. I added a NumberConverter, but this only slightly changed the exception message to java.lang.Long incompatible with java.lang....

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...