com.hfg.xml.msofficexml.part.VbaPart 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 java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import com.hfg.util.io.StreamUtil;
import com.hfg.xml.msofficexml.OfficeOpenXMLContentType;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML VBA part.

 @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 abstract class VbaPart
{
   private File        mFile;
   private InputStream mStream;

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

   //---------------------------------------------------------------------------
   public VbaPart(InputStream inStream, String inName)
   {
      if (null == inStream)
      {
         throw new RuntimeException("No InputStream specified!");
      }

      mFile = new File(getDir(), generateFilename(inName));

      mStream = inStream;
   }

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

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

   //---------------------------------------------------------------------------
   public void write(OutputStream inOutStream)
      throws IOException
   {
      StreamUtil.writeToStream(mStream, inOutStream);
   }


   //---------------------------------------------------------------------------
   protected abstract String getDir();

   //---------------------------------------------------------------------------
   private String generateFilename(String inOrigName)
   {
      String name = inOrigName.trim().replaceAll("\\s+", "_");

      return name;
   }
}