org.zkoss.poi.xssf.usermodel

Class XSSFPivotTable

java.lang.Object

org.zkoss.poi.POIXMLDocumentPart

org.zkoss.poi.xssf.usermodel.XSSFPivotTable

All Implemented Interfaces:

Serializable, PivotTable

public class XSSFPivotTable
extends POIXMLDocumentPart
implements PivotTable, Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
XSSFPivotTable(PackagePart part, PackageRelationship rel, List<PivotCache> pivotCaches)

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 of the PivotTable.
List<PivotField>	getColumnFields() Returns all column fields.
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColFields	getCTColFields()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLocation	getCTLocation()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRowFields	getCTRowFields()
String	getDataCaption() Returns the data caption.
List<DataField>	getDataFields() Returns all data fields.
boolean	getDataOnRows() Returns whether data on rows or not.
CellReference	getFirstDataRef() Returns the first data CellReference
String	getGrandTotalCaption() Returns the grand total caption.
AreaReference	getLocationRef() Returns the location range of the PivotTable.
String	getName() Returns the name of the PivotTable.
boolean	getOutline()
boolean	getOutlineData()
PivotCache	getPivotCache() Returns the PivotCache of the PivotTable.
PivotField	getPivotField(String name) Returns the PivotField.
List<PivotField>	getPivotFields() Returns all fields of the PivotTable.
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotTableDefinition	getPivotTableDefinition()
List<PivotField>	getRowFields() Returns all row fields.
String	getRowHeaderCaption() Returns the row header caption.
Sheet	getSheet()
protected void	onDocumentCreate() Fired when a new package part is created
void	setColumnField(PivotField field) Sets column type of a pivot field.
void	setColumnItems(List<List<ItemInfo>> items) Serts column items
void	setDataCaption(String caption) Sets the data caption.
void	setDataField(PivotField field, String name, Calculation subtotal) Sets data field
void	setDataOnRows(boolean dataOnRows) Sets data on rows
void	setFirstData(int row, int col) Sets the first data row/column index.
void	setFirstHeaderRow(int row) Sets the first header row.
void	setGrandTotalCaption(String caption) Sets the grand total caption.
void	setLocationRef(AreaReference ref) Sets the location range of the PivotTable.
void	setName(String name) Sets the name of PivotTable.
void	setOutline(boolean outline)
void	setOutlineData(boolean outlineData)
void	setPivotCache(PivotCache pivotCache)
void	setRowField(PivotField field) Sets row type of a pivot field.
void	setRowHeaderCaption(String caption) Sets the row header caption.
void	setRowItems(List<List<ItemInfo>> items) Sets row items.

Methods inherited from class org.zkoss.poi.POIXMLDocumentPart

addRelation, clearMemoryPackagePart, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationCounter, getRelationId, getRelations, getTargetPart, onDocumentRead, 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

XSSFPivotTable

public XSSFPivotTable(PackagePart part,
                      PackageRelationship rel,
                      List<PivotCache> pivotCaches)
               throws IOException,
                      org.apache.xmlbeans.XmlException

Throws:

IOException

org.apache.xmlbeans.XmlException

Method Detail

onDocumentCreate

protected void onDocumentCreate()

Description copied from class: POIXMLDocumentPart

Fired when a new package part is created

Overrides:

onDocumentCreate in class POIXMLDocumentPart

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

getPivotTableDefinition

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotTableDefinition getPivotTableDefinition()

setPivotCache

public void setPivotCache(PivotCache pivotCache)

getCacheId

public long getCacheId()

Description copied from interface: PivotTable

Returns the cache id of the PivotTable.

Specified by:

getCacheId in interface PivotTable

Returns:

cache id

getColumnFields

public List<PivotField> getColumnFields()

Description copied from interface: PivotTable

Returns all column fields.

Specified by:

getColumnFields in interface PivotTable

Returns:

setColumnField

public void setColumnField(PivotField field)

Description copied from interface: PivotTable

Sets column type of a pivot field.

Specified by:

setColumnField in interface PivotTable

setDataCaption

public void setDataCaption(String caption)

Description copied from interface: PivotTable

Sets the data caption.

Specified by:

setDataCaption in interface PivotTable

getDataCaption

public String getDataCaption()

Description copied from interface: PivotTable

Returns the data caption.

Specified by:

getDataCaption in interface PivotTable

Returns:

getDataFields

public List<DataField> getDataFields()

Description copied from interface: PivotTable

Returns all data fields.

Specified by:

getDataFields in interface PivotTable

Returns:

setDataField

public void setDataField(PivotField field,
                         String name,
                         Calculation subtotal)

Description copied from interface: PivotTable

Sets data field

Specified by:

setDataField in interface PivotTable

setFirstHeaderRow

public void setFirstHeaderRow(int row)

Description copied from interface: PivotTable

Sets the first header row.

Specified by:

setFirstHeaderRow in interface PivotTable

getCTLocation

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLocation getCTLocation()

getCTColFields

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColFields getCTColFields()

getCTRowFields

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRowFields getCTRowFields()

setFirstData

public void setFirstData(int row,
                         int col)

Description copied from interface: PivotTable

Sets the first data row/column index.

Specified by:

setFirstData in interface PivotTable

setLocationRef

public void setLocationRef(AreaReference ref)

Description copied from interface: PivotTable

Sets the location range of the PivotTable.

Specified by:

setLocationRef in interface PivotTable

getLocationRef

public AreaReference getLocationRef()

Description copied from interface: PivotTable

Returns the location range of the PivotTable.

Specified by:

getLocationRef in interface PivotTable

Returns:

getFirstDataRef

public CellReference getFirstDataRef()

Description copied from interface: PivotTable

Returns the first data CellReference

Specified by:

getFirstDataRef in interface PivotTable

Returns:

setGrandTotalCaption

public void setGrandTotalCaption(String caption)

Description copied from interface: PivotTable

Sets the grand total caption.

Specified by:

setGrandTotalCaption in interface PivotTable

getGrandTotalCaption

public String getGrandTotalCaption()

Description copied from interface: PivotTable

Returns the grand total caption.

Specified by:

getGrandTotalCaption in interface PivotTable

Returns:

caption

setName

public void setName(String name)

Description copied from interface: PivotTable

Sets the name of PivotTable.

Specified by:

setName in interface PivotTable

getName

public String getName()

Description copied from interface: PivotTable

Returns the name of the PivotTable.

Specified by:

getName in interface PivotTable

Returns:

name

getPivotCache

public PivotCache getPivotCache()

Description copied from interface: PivotTable

Returns the PivotCache of the PivotTable.

Specified by:

getPivotCache in interface PivotTable

Returns:

getPivotField

public PivotField getPivotField(String name)

Description copied from interface: PivotTable

Returns the PivotField.

Specified by:

getPivotField in interface PivotTable

Returns:

getPivotFields

public List<PivotField> getPivotFields()

Description copied from interface: PivotTable

Returns all fields of the PivotTable.

Specified by:

getPivotFields in interface PivotTable

Returns:

getRowFields

public List<PivotField> getRowFields()

Description copied from interface: PivotTable

Returns all row fields.

Specified by:

getRowFields in interface PivotTable

Returns:

getSheet

public Sheet getSheet()

setColumnItems

public void setColumnItems(List<List<ItemInfo>> items)

Description copied from interface: PivotTable

Serts column items

Specified by:

setColumnItems in interface PivotTable

setRowItems

public void setRowItems(List<List<ItemInfo>> items)

Description copied from interface: PivotTable

Sets row items.

Specified by:

setRowItems in interface PivotTable

setRowField

public void setRowField(PivotField field)

Description copied from interface: PivotTable

Sets row type of a pivot field.

Specified by:

setRowField in interface PivotTable

setDataOnRows

public void setDataOnRows(boolean dataOnRows)

Description copied from interface: PivotTable

Sets data on rows

Specified by:

setDataOnRows in interface PivotTable

getDataOnRows

public boolean getDataOnRows()

Description copied from interface: PivotTable

Returns whether data on rows or not.

Specified by:

getDataOnRows in interface PivotTable

Returns:

getRowHeaderCaption

public String getRowHeaderCaption()

Description copied from interface: PivotTable

Returns the row header caption.

Specified by:

getRowHeaderCaption in interface PivotTable

Returns:

setRowHeaderCaption

public void setRowHeaderCaption(String caption)

Description copied from interface: PivotTable

Sets the row header caption.

Specified by:

setRowHeaderCaption in interface PivotTable

setOutline

public void setOutline(boolean outline)

Specified by:

setOutline in interface PivotTable

getOutline

public boolean getOutline()

Specified by:

getOutline in interface PivotTable

setOutlineData

public void setOutlineData(boolean outlineData)

Specified by:

setOutlineData in interface PivotTable

getOutlineData

public boolean getOutlineData()

Specified by:

getOutlineData in interface PivotTable