org.zkoss.poi.xssf.usermodel

Class XSSFPivotCache

java.lang.Object

org.zkoss.poi.POIXMLDocumentPart

org.zkoss.poi.xssf.usermodel.XSSFPivotCache

All Implemented Interfaces:

Serializable, PivotCache

public class XSSFPivotCache
extends POIXMLDocumentPart
implements PivotCache, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.zkoss.poi.ss.usermodel.PivotCache

PivotCache.CacheField, PivotCache.CacheRecord, PivotCache.SheetSource

Field Summary

Fields inherited from class org.zkoss.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
XSSFPivotCache()
XSSFPivotCache(long cacheId, POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel)
XSSFPivotCache(PackagePart part, PackageRelationship rel)

Method Summary

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
long	getCacheId() Returns the cache id
short	getCreatedVersion()
List<PivotCache.CacheField>	getFields() Returns all cache fields
short	getMinRefreshableVersion()
List<PivotCache.CacheRecord>	getRecords() Returns all cache records
short	getRefreshedVersion()
PivotCache.SheetSource	getSheetSource() Returns PivotCache.SheetSource
Workbook	getWorkbook() Return the parent workbook
protected void	onDocumentCreate() Fired when a new package part is created
protected void	onDocumentRead() Fired when a package part is read
void	setCacheId(long cacheId)
void	setSheetSource(AreaReference sourceRef)

Methods inherited from class org.zkoss.poi.POIXMLDocumentPart

addRelation, clearMemoryPackagePart, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationCounter, getRelationId, getRelations, getTargetPart, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XSSFPivotCache

public XSSFPivotCache()

XSSFPivotCache

public XSSFPivotCache(PackagePart part,
                      PackageRelationship rel)

XSSFPivotCache

public XSSFPivotCache(long cacheId,
                      POIXMLDocumentPart parent,
                      PackagePart part,
                      PackageRelationship rel)
               throws IOException

Throws:

IOException

Method Detail

onDocumentCreate

protected void onDocumentCreate()

Description copied from class: POIXMLDocumentPart

Fired when a new package part is created

Overrides:

onDocumentCreate in class POIXMLDocumentPart

onDocumentRead

protected void onDocumentRead()
                       throws IOException

Description copied from class: POIXMLDocumentPart

Fired when a package part is read

Overrides:

onDocumentRead in class POIXMLDocumentPart

Throws:

IOException

commit

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

getWorkbook

public Workbook getWorkbook()

Description copied from interface: PivotCache

Return the parent workbook

Specified by:

getWorkbook in interface PivotCache

Returns:

the parent workbook

setCacheId

public void setCacheId(long cacheId)

getCacheId

public long getCacheId()

Description copied from interface: PivotCache

Returns the cache id

Specified by:

getCacheId in interface PivotCache

Returns:

getFields

public List<PivotCache.CacheField> getFields()

Description copied from interface: PivotCache

Returns all cache fields

Specified by:

getFields in interface PivotCache

Returns:

getRecords

public List<PivotCache.CacheRecord> getRecords()

Description copied from interface: PivotCache

Returns all cache records

Specified by:

getRecords in interface PivotCache

Returns:

setSheetSource

public void setSheetSource(AreaReference sourceRef)

getSheetSource

public PivotCache.SheetSource getSheetSource()

Description copied from interface: PivotCache

Returns PivotCache.SheetSource

Specified by:

getSheetSource in interface PivotCache

Returns:

getRefreshedVersion

public short getRefreshedVersion()

Specified by:

getRefreshedVersion in interface PivotCache

getMinRefreshableVersion

public short getMinRefreshableVersion()

Specified by:

getMinRefreshableVersion in interface PivotCache

getCreatedVersion

public short getCreatedVersion()

Specified by:

getCreatedVersion in interface PivotCache