com.hfg.xml.msoffice2003.spreadsheetml.ExcelWorkbook Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.xml.msoffice2003.spreadsheetml;

import com.hfg.util.collection.CollectionUtil;
import com.hfg.util.StringUtil;
import com.hfg.xml.XMLTag;

import java.util.List;
import java.util.Map;
import java.util.HashMap;

//------------------------------------------------------------------------------
/**
 Excel workbook.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------
// TODO: Add a validate() method to check the workbook structure for problems like duplicate worksheet names.

public class ExcelWorkbook extends XMLTag
{
   private XMLTag mStylesTag = new XMLTag(SpreadsheetML.STYLES);

   private Map mStyleMap = new HashMap();


   //---------------------------------------------------------------------------
   public ExcelWorkbook()
   {
      super(SpreadsheetML.WORKBOOK);
      addSubtag(mStylesTag);
   }

   //---------------------------------------------------------------------------
   public ExcelWorksheet addWorksheet()
   {
      ExcelWorksheet worksheet = new ExcelWorksheet();
      addWorksheet(worksheet);

      return worksheet;
   }

   //---------------------------------------------------------------------------
   public ExcelWorksheet addWorksheet(String inName)
   {
      ExcelWorksheet worksheet = new ExcelWorksheet(inName);
      addWorksheet(worksheet);

      return worksheet;
   }

   //---------------------------------------------------------------------------
   public void addWorksheet(ExcelWorksheet inWorksheet)
   {
      checkWorksheetNameForUniqueness(inWorksheet.getName());
      addSubtag(inWorksheet);
   }

   //---------------------------------------------------------------------------
   public List getWorksheets()
   {
      return (List) (Object) getSubtagsByName(SpreadsheetML.WORKSHEET.getLocalName());
   }

   //---------------------------------------------------------------------------
   public ExcelWorkbook addStyle(ExcelStyle inStyle)
   {
      mStylesTag.addSubtag(inStyle);
      mStyleMap.put(inStyle.getId(), inStyle);
      return this;
   }

   //---------------------------------------------------------------------------
   public ExcelStyle getStyle(String inStyleId)
   {
      return mStyleMap.get(inStyleId);
   }

   //---------------------------------------------------------------------------
   private void checkWorksheetNameForUniqueness(String inName)
   {
      List sheets = getWorksheets();
      if (CollectionUtil.hasValues(sheets))
      {
         for (ExcelWorksheet sheet : sheets)
         {
            if (inName.equals(sheet.getName()))
            {
               throw new ExcelFormatException("The worksheet name " + StringUtil.singleQuote(inName) + " is not unique!");
            }
         }
      }
   }
}