com.helger.poi.excel.EExcelVersion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-poi Show documentation
Wrapper around Apache POI
There is a newer version: 6.0.3
/**
 * Copyright (C) 2014-2021 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.poi.excel;

import java.io.IOException;
import java.io.InputStream;

import javax.annotation.CheckForSigned;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.WillClose;

import org.apache.poi.hssf.usermodel.HSSFRichTextString;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.openxml4j.exceptions.NotOfficeXmlFileException;
import org.apache.poi.poifs.filesystem.OfficeXmlFileException;
import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import com.helger.commons.CGlobal;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.id.IHasID;
import com.helger.commons.lang.EnumHelper;
import com.helger.commons.mime.CMimeType;
import com.helger.commons.mime.IMimeType;
import com.helger.poi.POISetup;

/**
 * Encapsulates the main differences between the different excel versions.
 *
 * @author Philip Helger
 */
public enum EExcelVersion implements IHasID 
{
  XLS ("xls")
  {
    @Override
    @Nonnull
    public HSSFWorkbook createWorkbook ()
    {
      return new HSSFWorkbook ();
    }

    @Override
    @Nullable
    public HSSFWorkbook readWorkbook (@Nonnull @WillClose final InputStream aIS)
    {
      try
      {
        // Closes the input stream internally
        return new HSSFWorkbook (aIS);
      }
      catch (final OfficeXmlFileException | IOException ex)
      {
        // No XLS
        return null;
      }
    }

    @Override
    @Nonnull
    public HSSFRichTextString createRichText (final String sValue)
    {
      return new HSSFRichTextString (sValue);
    }

    @Override
    @Nonnull
    public String getFileExtension ()
    {
      return ".xls";
    }

    @Override
    @Nonnull
    public IMimeType getMimeType ()
    {
      return CMimeType.APPLICATION_MS_EXCEL;
    }

    @Override
    public int getRowLimitPerSheet ()
    {
      // Max row limit is 65536. The index is therefore 0up to (limit-1)
      return 65536;
    }
  },
  XLSX ("xlsx")
  {
    @Override
    @Nonnull
    public XSSFWorkbook createWorkbook ()
    {
      return new XSSFWorkbook ();
    }

    @Override
    @Nullable
    public XSSFWorkbook readWorkbook (@Nonnull @WillClose final InputStream aIS)
    {
      try
      {
        // Closes the input stream internally
        return new XSSFWorkbook (aIS);
      }
      catch (final NotOfficeXmlFileException | IOException ex)
      {
        // No XLSX
        return null;
      }
    }

    @Override
    @Nonnull
    public XSSFRichTextString createRichText (final String sValue)
    {
      return new XSSFRichTextString (sValue);
    }

    @Override
    @Nonnull
    public String getFileExtension ()
    {
      return ".xlsx";
    }

    @Override
    @Nonnull
    public IMimeType getMimeType ()
    {
      return CMimeType.APPLICATION_MS_EXCEL_2007;
    }

    @Override
    public int getRowLimitPerSheet ()
    {
      return CGlobal.ILLEGAL_UINT;
    }
  };

  static
  {
    // Ensure the static system properties are set
    POISetup.initOnDemand ();
  }

  private final String m_sID;

  private EExcelVersion (@Nonnull @Nonempty final String sID)
  {
    m_sID = sID;
  }

  @Nonnull
  @Nonempty
  public String getID ()
  {
    return m_sID;
  }

  /**
   * @return A newly created workbook of this version
   */
  @Nonnull
  public abstract Workbook createWorkbook ();

  /**
   * Open an existing work book for reading.
   *
   * @param aIS
   *        The input stream to read from. May not be null.
   * @return null in case the workbook cannot be opened.
   */
  @Nullable
  public abstract Workbook readWorkbook (@Nonnull InputStream aIS);

  @Nonnull
  public abstract RichTextString createRichText (String sValue);

  /**
   * @return The file extension incl. the leading dot.
   */
  @Nonnull
  public abstract String getFileExtension ();

  /**
   * @return The MIME type for this excel version.
   */
  @Nonnull
  public abstract IMimeType getMimeType ();

  /**
   * @return true if this Excel version has a row limit inside a
   *         sheet
   */
  public boolean hasRowLimitPerSheet ()
  {
    return getRowLimitPerSheet () > 0;
  }

  /**
   * @return the maximum number of rows per sheet (incl.) or
   *         {@link CGlobal#ILLEGAL_UINT} if no limit exists
   */
  @CheckForSigned
  public abstract int getRowLimitPerSheet ();

  @Nullable
  public static EExcelVersion getFromIDOrNull (@Nullable final String sID)
  {
    return EnumHelper.getFromIDOrNull (EExcelVersion.class, sID);
  }

  @Nullable
  public static EExcelVersion getFromIDOrDefault (@Nullable final String sID, @Nullable final EExcelVersion eDefault)
  {
    return EnumHelper.getFromIDOrDefault (EExcelVersion.class, sID, eDefault);
  }
}