org.apache.poi.xssf.usermodel
Class XSSFPivotCacheDefinition
java.lang.Object
org.apache.poi.POIXMLDocumentPart
org.apache.poi.xssf.usermodel.XSSFPivotCacheDefinition
public class XSSFPivotCacheDefinition
- extends POIXMLDocumentPart
|
Method Summary |
protected void |
commit()
Save the content in the underlying package part. |
protected void |
createCacheFields(Sheet sheet)
Generates a cache field for each column in the reference area for the pivot table. |
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCacheDefinition |
getCTPivotCacheDefinition()
|
void |
readFrom(java.io.InputStream is)
|
| Methods inherited from class org.apache.poi.POIXMLDocumentPart |
_invokeOnDocumentRead, addRelation, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelationParts, 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 |
XSSFPivotCacheDefinition
@Beta
public XSSFPivotCacheDefinition()
XSSFPivotCacheDefinition
@Beta
protected XSSFPivotCacheDefinition(PackagePart part)
throws java.io.IOException
- Creates an XSSFPivotCacheDefintion representing the given package part and relationship.
Should only be called when reading in an existing file.
- Parameters:
part - - The package part that holds xml data representing this pivot cache definition.
- Throws:
java.io.IOException- Since:
- POI 3.14-Beta1
XSSFPivotCacheDefinition
@Deprecated
protected XSSFPivotCacheDefinition(PackagePart part,
PackageRelationship rel)
throws java.io.IOException
- Deprecated. in POI 3.14, scheduled for removal in POI 3.16
- Throws:
java.io.IOException
readFrom
@Beta
public void readFrom(java.io.InputStream is)
throws java.io.IOException
- Throws:
java.io.IOException
getCTPivotCacheDefinition
@Beta
@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCacheDefinition getCTPivotCacheDefinition()
commit
@Beta
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();
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:
java.io.IOException
createCacheFields
@Beta
protected void createCacheFields(Sheet sheet)
- Generates a cache field for each column in the reference area for the pivot table.
- Parameters:
sheet - The sheet where the data i collected from