Package org.apache.poi.xssf.usermodel

Class XSSFPivotCacheDefinition

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.usermodel.XSSFPivotCacheDefinition

public class XSSFPivotCacheDefinition
extends POIXMLDocumentPart

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor	Description
XSSFPivotCacheDefinition()

Method Summary

Modifier and Type	Method	Description
CTPivotCacheDefinition	getCTPivotCacheDefinition()
AreaReference	getPivotArea(Workbook wb)	Find the 2D base data area for the pivot table, either from its direct reference or named table/range.
void	readFrom(InputStream is)

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommited, setCommited, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XSSFPivotCacheDefinition

@Beta
public XSSFPivotCacheDefinition()

Method Detail

readFrom

@Beta
public void readFrom(InputStream is)
              throws IOException

Throws:

IOException

getCTPivotCacheDefinition

@Beta
@Internal
public CTPivotCacheDefinition getCTPivotCacheDefinition()

getPivotArea

@Beta
public AreaReference getPivotArea(Workbook wb)
                           throws IllegalArgumentException

Find the 2D base data area for the pivot table, either from its direct reference or named table/range.

Returns:

AreaReference representing the current area defined by the pivot table

Throws:

IllegalArgumentException - if the ref attribute is not contiguous or the name attribute is not found.