Package org.apache.poi.xssf.model
Class MapInfo
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xssf.model.MapInfo
This class implements the Custom XML Mapping Part (Open Office XML Part 1:
chapter 12.3.6)
An instance of this part type contains a schema for an XML file, and
information on the behavior that is used when allowing this custom XML schema
to be mapped into the spreadsheet.
- Author:
- Roberto Manicardi
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
commit()
Save the content in the underlying package part.org.openxmlformats.schemas.spreadsheetml.x2006.main.CTMapInfo
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSchema
getCTSchemaById
(String schemaId) Gets theReturns the parent XSSFWorkbookgetXSSFMapById
(int id) getXSSFMapByName
(String name) void
readFrom
(InputStream is) protected 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, isCommited, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toString
-
Constructor Details
-
MapInfo
public MapInfo() -
MapInfo
- Throws:
IOException
- Since:
- POI 3.14-Beta1
-
-
Method Details
-
readFrom
- Throws:
IOException
-
getWorkbook
Returns the parent XSSFWorkbook- Returns:
- the parent XSSFWorkbook
-
getCTMapInfo
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTMapInfo getCTMapInfo()- Returns:
- the internal data object
-
getCTSchemaById
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSchema getCTSchemaById(String schemaId) Gets the- Parameters:
schemaId
- the schema ID- Returns:
- CTSchema by it's ID
-
getXSSFMapById
-
getXSSFMapByName
-
getAllXSSFMaps
- Returns:
- all the mappings configured in this document
-
writeTo
- Throws:
IOException
-
commit
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 classPOIXMLDocumentPart
- Throws:
IOException
- a subclass may throw an IOException if the changes can't be committed
-