org.apache.poi.xssf.model
Class CommentsTable
java.lang.Object
org.apache.poi.POIXMLDocumentPart
org.apache.poi.xssf.model.CommentsTable
public class CommentsTable
- extends POIXMLDocumentPart
Method Summary |
protected void |
commit()
Save the content in the underlying package part. |
int |
findAuthor(java.lang.String author)
|
XSSFComment |
findCellComment(java.lang.String cellRef)
|
java.lang.String |
getAuthor(long authorId)
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment |
getCTComment(java.lang.String cellRef)
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments |
getCTComments()
|
int |
getNumberOfAuthors()
|
int |
getNumberOfComments()
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment |
newComment()
|
void |
readFrom(java.io.InputStream is)
|
void |
referenceUpdated(java.lang.String oldReference,
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
Called after the reference is updated, so that
we can reflect that in our cache |
boolean |
removeComment(java.lang.String cellRef)
|
void |
writeTo(java.io.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, read, rebase, removeRelation, removeRelation, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
CommentsTable
public CommentsTable()
CommentsTable
public CommentsTable(PackagePart part,
PackageRelationship rel)
throws java.io.IOException
- Throws:
java.io.IOException
readFrom
public void readFrom(java.io.InputStream is)
throws java.io.IOException
- Throws:
java.io.IOException
writeTo
public 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();
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
referenceUpdated
public void referenceUpdated(java.lang.String oldReference,
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
- Called after the reference is updated, so that
we can reflect that in our cache
getNumberOfComments
public int getNumberOfComments()
getNumberOfAuthors
public int getNumberOfAuthors()
getAuthor
public java.lang.String getAuthor(long authorId)
findAuthor
public int findAuthor(java.lang.String author)
findCellComment
public XSSFComment findCellComment(java.lang.String cellRef)
getCTComment
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(java.lang.String cellRef)
newComment
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment()
removeComment
public boolean removeComment(java.lang.String cellRef)
getCTComments
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments getCTComments()
Copyright 2012 The Apache Software Foundation or
its licensors, as applicable.