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

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	commit() Save the content in the underlying package part.
int	findAuthor(String author)
XSSFComment	findCellComment(String cellRef)
String	getAuthor(long authorId)
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment	getCTComment(String cellRef)
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments	getCTComments()
int	getNumberOfAuthors()
int	getNumberOfComments()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment	newComment() Deprecated. Use newComment(String) instead to explicitly set the cell reference to create for
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment	newComment(String ref)
void	readFrom(InputStream is)
void	referenceUpdated(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(String cellRef)
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

CommentsTable

public CommentsTable()

CommentsTable

public CommentsTable(PackagePart part,
             PackageRelationship rel)
              throws IOException

Throws:

IOException

Method Detail

readFrom

public void readFrom(InputStream is)
              throws IOException

Throws:

IOException

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

referenceUpdated

public void referenceUpdated(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 String getAuthor(long authorId)

findAuthor

public int findAuthor(String author)

findCellComment

public XSSFComment findCellComment(String cellRef)

getCTComment

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(String cellRef)

newComment

@Deprecated
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment()

Deprecated. Use newComment(String) instead to explicitly set the cell reference to create for

This method is deprecated and should not be used any more as it silently overwrites the comment in Cell A1 if present

newComment

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(String ref)

removeComment

public boolean removeComment(String cellRef)

getCTComments

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments getCTComments()