Class XSSFPivotTable

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xssf.usermodel.XSSFPivotTable

public class XSSFPivotTable extends POIXMLDocumentPart
  • Field Details

  • Constructor Details

    • XSSFPivotTable

      @Beta protected XSSFPivotTable()
    • XSSFPivotTable

      @Beta protected XSSFPivotTable(PackagePart part) throws IOException
      Creates an XSSFPivotTable representing the given package part and relationship. Should only be called when reading in an existing file.
      Parameters:
      part - - The package part that holds xml data representing this pivot table.
      Throws:
      IOException
      Since:
      POI 3.14-Beta1
  • Method Details

    • readFrom

      @Beta public void readFrom(InputStream is) throws IOException
      Throws:
      IOException
    • setPivotCache

      @Beta public void setPivotCache(XSSFPivotCache pivotCache)
    • getPivotCache

      @Beta public XSSFPivotCache getPivotCache()
    • getParentSheet

      @Beta public Sheet getParentSheet()
    • setParentSheet

      @Beta public void setParentSheet(XSSFSheet parentSheet)
    • getCTPivotTableDefinition

      @Beta @Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotTableDefinition getCTPivotTableDefinition()
    • setCTPivotTableDefinition

      @Beta @Internal public void setCTPivotTableDefinition(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotTableDefinition pivotTableDefinition)
    • getPivotCacheDefinition

      @Beta public XSSFPivotCacheDefinition getPivotCacheDefinition()
    • setPivotCacheDefinition

      @Beta public void setPivotCacheDefinition(XSSFPivotCacheDefinition pivotCacheDefinition)
    • getPivotCacheRecords

      @Beta public XSSFPivotCacheRecords getPivotCacheRecords()
    • setPivotCacheRecords

      @Beta public void setPivotCacheRecords(XSSFPivotCacheRecords pivotCacheRecords)
    • getDataSheet

      @Beta public Sheet getDataSheet()
    • commit

      @Beta protected void commit() throws IOException
      Description copied from class: POIXMLDocumentPart
      Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.

      Sub-classes should override and add logic to marshal the "model" into Ooxml4J.

      For example, the code saving a generic XML entry may look as follows:

       protected void commit() throws IOException {
         PackagePart part = getPackagePart();
         OutputStream out = part.getOutputStream();
         XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
         bean.save(out, DEFAULT_XML_OPTIONS);
         out.close();
       }
       
      Overrides:
      commit in class POIXMLDocumentPart
      Throws:
      IOException - a subclass may throw an IOException if the changes can't be committed
    • setDefaultPivotTableDefinition

      @Beta protected void setDefaultPivotTableDefinition()
      Set default values for the table definition.
    • getPivotArea

      protected AreaReference getPivotArea()
    • addRowLabel

      @Beta public void addRowLabel(int columnIndex)
      Add a row label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.
    • getRowLabelColumns

      @Beta public List<Integer> getRowLabelColumns()
    • addColLabel

      @Beta public void addColLabel(int columnIndex, String valueFormat)
      Add a col label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFormat - format of column value (e.g. for date: "DD.MM.YYYY")
    • addColLabel

      @Beta public void addColLabel(int columnIndex)
      Add a col label using data from the given column.
      Parameters:
      columnIndex - the index of the source column to be used as row label. columnIndex is 0-based indexed and relative to the first column in the source.
    • getColLabelColumns

      @Beta public List<Integer> getColLabelColumns()
    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex, String valueFieldName, String valueFormat)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFieldName - the name of pivot table value field
      valueFormat - format of value field (e.g. "#,##0.00")
    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex, String valueFieldName)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label. columnIndex is 0-based indexed and relative to the first column in the source.
      valueFieldName - the name of pivot table value field
    • addColumnLabel

      @Beta public void addColumnLabel(DataConsolidateFunction function, int columnIndex)
      Add a column label using data from the given column and specified function
      Parameters:
      function - the function to be used on the data The following functions exists: Sum, Count, Average, Max, Min, Product, Count numbers, StdDev, StdDevp, Var, Varp
      columnIndex - the index of the source column to be used as column label columnIndex is 0-based indexed and relative to the first column in the source..
    • addDataColumn

      @Beta public void addDataColumn(int columnIndex, boolean isDataField)
      Add column containing data from the referenced area.
      Parameters:
      columnIndex - the index of the column containing the data
      isDataField - true if the data should be displayed in the pivot table.
    • addReportFilter

      @Beta public void addReportFilter(int columnIndex)
      Add filter for the column with the corresponding index and cell value
      Parameters:
      columnIndex - index of column to filter on
    • createSourceReferences

      @Beta protected void createSourceReferences(CellReference position, Sheet sourceSheet, XSSFPivotTable.PivotTableReferenceConfigurator refConfig)
      Creates cacheSource and workSheetSource for pivot table and sets the source reference as well assets the location of the pivot table
      Parameters:
      position - Position for pivot table in sheet
      sourceSheet - Sheet where the source will be collected from
      refConfig - an configurator that knows how to configure pivot table references
    • createDefaultDataColumns

      @Beta protected void createDefaultDataColumns()