org.apache.poi.xssf.usermodel

Class XSSFTable

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.xssf.usermodel.XSSFTable

public class XSSFTable
extends POIXMLDocumentPart

This class implements the Table Part (Open Office XML Part 4: chapter 3.5.1) This implementation works under the assumption that a table contains mappings to a subtree of an XML. The root element of this subtree an occur multiple times (one for each row of the table). The child nodes of the root element can be only attributes or element with maxOccurs=1 property set

Author:

Roberto Manicardi

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
XSSFTable()
XSSFTable(PackagePart part, PackageRelationship rel)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
String	getCommonXpath() Calculates the xpath of the root element for the table.
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTTable	getCTTable()
String	getDisplayName()
CellReference	getEndCellReference()
String	getName()
long	getNumerOfMappedColumns()
int	getRowCount()
CellReference	getStartCellReference()
List<XSSFXmlColumnPr>	getXmlColumnPrs()
XSSFSheet	getXSSFSheet()
boolean	mapsTo(long id) Checks if this Table element contains even a single mapping to the map identified by id
void	readFrom(InputStream is)
void	setDisplayName(String name) Changes the display name of the Table
void	setName(String name) Changes the name of the Table
void	updateHeaders() Synchronize table headers with cell values in the parent sheet.
void	writeTo(OutputStream out)

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFTable

public XSSFTable()

XSSFTable

public XSSFTable(PackagePart part,
         PackageRelationship rel)
          throws IOException

Throws:

IOException

Method Detail

readFrom

public void readFrom(InputStream is)
              throws IOException

Throws:

IOException

getXSSFSheet

public XSSFSheet getXSSFSheet()

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();
   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

getCTTable

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTTable getCTTable()

mapsTo

public boolean mapsTo(long id)

Checks if this Table element contains even a single mapping to the map identified by id

Parameters:

id - the XSSFMap ID

Returns:

true if the Table element contain mappings

getCommonXpath

public String getCommonXpath()

Calculates the xpath of the root element for the table. This will be the common part of all the mapping's xpaths

Returns:

the xpath of the table's root element

getXmlColumnPrs

public List<XSSFXmlColumnPr> getXmlColumnPrs()

getName

public String getName()

Returns:

the name of the Table, if set

setName

public void setName(String name)

Changes the name of the Table

getDisplayName

public String getDisplayName()

Returns:

the display name of the Table, if set

setDisplayName

public void setDisplayName(String name)

Changes the display name of the Table

getNumerOfMappedColumns

public long getNumerOfMappedColumns()

Returns:

the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4)

getStartCellReference

public CellReference getStartCellReference()

Returns:

The reference for the cell in the top-left part of the table (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)

getEndCellReference

public CellReference getEndCellReference()

Returns:

The reference for the cell in the bottom-right part of the table (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref)

getRowCount

public int getRowCount()

Returns:

the total number of rows in the selection. (Note: in this version autofiltering is ignored)

updateHeaders

public void updateHeaders()

Synchronize table headers with cell values in the parent sheet. Headers must be in sync, otherwise Excel will display a "Found unreadable content" message on startup.