com.hfg.xml.msofficexml.xlsx.part.WorksheetPart Maven / Gradle / Ivy

Go to download
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.msofficexml.xlsx.part;


import java.io.BufferedInputStream;
import java.io.File;

import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeXML;
import com.hfg.xml.msofficexml.docx.RelationshipXML;
import com.hfg.xml.msofficexml.part.OfficeXMLPart;
import com.hfg.xml.msofficexml.xlsx.Xlsx;
import com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlWorksheet;
import com.hfg.xml.msofficexml.xlsx.spreadsheetml.SsmlXML;

//------------------------------------------------------------------------------
/**
 * Worksheet Part of a OfficeOpenXML xlsx Excel document.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding 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]
//------------------------------------------------------------------------------

public class WorksheetPart extends OfficeXMLPart
{
   //###########################################################################
   // PRIVATE FIELDS
   //###########################################################################

   private int                       mSheetIndex;
   private WorksheetRelationshipPart mWorksheetRelationshipPart;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public WorksheetPart(Xlsx inXlsx)
   {
      super(inXlsx);

      XMLTag rootNode = new SsmlWorksheet(this);
      rootNode.addXMLNamespaceDeclaration(OfficeXML.OFFICE_NAMESPACE);
      rootNode.addXMLNamespaceDeclaration(RelationshipXML.RELATIONSHIP_NAMESPACE);
/*
      rootNode.addXMLNamespaceDeclaration(XMLNamespace.getNamespace("ve", "http://schemas.openxmlformats.org/markup-compatibility/2006"));
      rootNode.addXMLNamespaceDeclaration(XMLNamespace.getNamespace("m", "http://schemas.openxmlformats.org/officeDocument/2006/math"));
      rootNode.addXMLNamespaceDeclaration(XMLNamespace.getNamespace("v", "urn:schemas-microsoft-com:vml"));
      rootNode.addXMLNamespaceDeclaration(XMLNamespace.getNamespace("w10", "urn:schemas-microsoft-com:office:word"));
      rootNode.addXMLNamespaceDeclaration(XMLNamespace.getNamespace("wne", "http://schemas.microsoft.com/office/word/2006/wordml"));
*/
      setRootNode(rootNode);
   }

   //---------------------------------------------------------------------------
   public WorksheetPart(Xlsx inXlsx, String inName, XMLTag inSheetTag)
   {
      super(inXlsx);

      SsmlWorksheet worksheet = new SsmlWorksheet(this, inName, inSheetTag);
      setRootNode(worksheet);
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public WorksheetRelationshipPart getWorksheetRelationshipPart()
   {
      if (null == mWorksheetRelationshipPart)
      {
         mWorksheetRelationshipPart = new WorksheetRelationshipPart(this);
      }

      return mWorksheetRelationshipPart;
   }

   //---------------------------------------------------------------------------
   public WorksheetPart setSheetIndex(int inValue)
   {
      mSheetIndex = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public Integer getSheetIndex()
   {
      return mSheetIndex;
   }

   //---------------------------------------------------------------------------
   @Override
   public File getFile()
   {
      return new File(SsmlXML.WORKSHEETS_DIR, "sheet" + mSheetIndex + ".xml");
   }

   //---------------------------------------------------------------------------
   @Override
   public SsmlWorksheet getRootNode()
   {
      SsmlWorksheet rootNode = (SsmlWorksheet) super.getRootNode();
      if (null == rootNode)
      {
         rootNode = new SsmlWorksheet(this);
         setRootNode(rootNode);
      }

      return rootNode;
   }
}