com.hfg.xml.msofficexml.part.OfficeXMLPart 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.part;

import java.io.File;

import com.hfg.util.FileUtil;
import com.hfg.xml.XMLDoc;
import com.hfg.xml.XMLName;
import com.hfg.xml.XMLTag;
import com.hfg.xml.msofficexml.OfficeOpenXmlDocument;


//------------------------------------------------------------------------------
/**
 * Base class for OfficeOpenXml document parts.
 *
 * @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 OfficeXMLPart extends XMLDoc
{
   private File mFile;
   private OfficeOpenXmlDocument mParentDoc;

   //---------------------------------------------------------------------------
   public OfficeXMLPart(OfficeOpenXmlDocument inOfficeDoc)
   {
      mParentDoc = inOfficeDoc;
      mParentDoc.addPart(this);
   }

   //---------------------------------------------------------------------------
   public OfficeXMLPart setFile(File inValue)
   {
      mFile = inValue;

      return this;
   }

   //---------------------------------------------------------------------------
   public File getFile()
   {
      return mFile;
   }

   //---------------------------------------------------------------------------
   public OfficeXMLPart setParentDoc(OfficeOpenXmlDocument inValue)
   {
      mParentDoc = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public OfficeOpenXmlDocument getParentDoc()
   {
      return mParentDoc;
   }

   //---------------------------------------------------------------------------
   @Override
   public OfficeXMLPart clone()
   {
      return (OfficeXMLPart) super.clone();
   }

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return (getFile() != null ? FileUtil.convertSeparatorsToUnix(getFile().getPath()) : super.toString());
   }

   //###########################################################################
   // PROTECTED METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   protected XMLTag getOrCreateSubtag(XMLName inTagName)
   {
      XMLTag subtag = getRootNode().getOptionalSubtagByName(inTagName.getLocalName());
      if (null == subtag)
      {
         subtag = new XMLTag(inTagName);
         getRootNode().addSubtag(subtag);
      }

      return subtag;
   }

}