Package org.apache.poi.xssf.model

Class CalculationChain

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.model.CalculationChain

public class CalculationChain
extends POIXMLDocumentPart

The cells in a workbook can be calculated in different orders depending on various optimizations and dependencies. The calculation chain object specifies the order in which the cells in a workbook were last calculated.

Nested Class Summary

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

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor	Description
CalculationChain()
CalculationChain(PackagePart part)

Method Summary

Modifier and Type	Method	Description
protected void	commit()	Save the content in the underlying package part.
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCalcChain	getCTCalcChain()
void	readFrom(InputStream is)
void	removeItem(int sheetId, String ref)	Remove a formula reference from the calculation chain
void	writeTo(OutputStream out)

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

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CalculationChain

public CalculationChain()

CalculationChain

public CalculationChain(PackagePart part)
                 throws IOException

Throws:

IOException

Since:

POI 3.14-Beta1

Method Detail

readFrom

public void readFrom(InputStream is)
              throws IOException

Throws:

IOException

writeTo

public void writeTo(OutputStream out)
             throws IOException

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();
   try (OutputStream out = part.getOutputStream()) {
     XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
     bean.save(out, DEFAULT_XML_OPTIONS);
   }
 }
 

Overrides:

commit in class POIXMLDocumentPart

Throws:

IOException - a subclass may throw an IOException if the changes can't be committed

getCTCalcChain

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCalcChain getCTCalcChain()

removeItem

public void removeItem(int sheetId,
                       String ref)

Remove a formula reference from the calculation chain

Parameters:

sheetId - the sheet Id of a sheet the formula belongs to.

ref - A1 style reference to the cell containing the formula.