org.apache.poi.xssf.model

Class SingleXmlCells

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.model.SingleXmlCells

public class SingleXmlCells
extends POIXMLDocumentPart

This class implements the Single Cell Tables Part (Open Office XML Part 4: chapter 3.5.2)

Nested Class Summary

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

POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors

Constructor and Description
SingleXmlCells()
SingleXmlCells(PackagePart part)

Method Summary

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
java.util.List<XSSFSingleXmlCell>	getAllSimpleXmlCell()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSingleXmlCells	getCTSingleXMLCells()
XSSFSheet	getXSSFSheet()
void	readFrom(java.io.InputStream is)
protected void	writeTo(java.io.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

SingleXmlCells

public SingleXmlCells()

SingleXmlCells

public SingleXmlCells(PackagePart part)
               throws java.io.IOException

Throws:

java.io.IOException

Since:

POI 3.14-Beta1

Method Detail

readFrom

public void readFrom(java.io.InputStream is)
              throws java.io.IOException

Throws:

java.io.IOException

getXSSFSheet

public XSSFSheet getXSSFSheet()

writeTo

protected void writeTo(java.io.OutputStream out)
                throws java.io.IOException

Throws:

java.io.IOException

commit

protected void commit()
               throws java.io.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:

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

getCTSingleXMLCells

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSingleXmlCells getCTSingleXMLCells()

getAllSimpleXmlCell

public java.util.List<XSSFSingleXmlCell> getAllSimpleXmlCell()

Returns:

all the SimpleXmlCell contained in this SingleXmlCells element