org.apache.poi.xssf.model
Class CommentsTable

java.lang.Object
  extended by org.apache.poi.POIXMLDocumentPart
      extended by org.apache.poi.xssf.model.CommentsTable

@Internal
public class CommentsTable
extends POIXMLDocumentPart


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
 
Field Summary
static java.lang.String DEFAULT_AUTHOR
           
static int DEFAULT_AUTHOR_ID
           
 
Constructor Summary
CommentsTable()
           
CommentsTable(PackagePart part)
           
CommentsTable(PackagePart part, PackageRelationship rel)
          Deprecated. in POI 3.14, scheduled for removal in POI 3.16
 
Method Summary
protected  void commit()
          Save the content in the underlying package part.
 int findAuthor(java.lang.String author)
           
 XSSFComment findCellComment(CellAddress cellAddress)
          Finds the cell comment at cellAddress, if one exists
 XSSFComment findCellComment(java.lang.String cellRef)
          Deprecated. 2015-11-23 (circa POI 3.14beta1). Use findCellComment(CellAddress) instead
 java.lang.String getAuthor(long authorId)
           
 java.util.Map<CellAddress,XSSFComment> getCellComments()
          Returns all cell comments on this sheet.
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(CellAddress cellRef)
          Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(java.lang.String ref)
          Deprecated. 2015-11-23 (circa POI 3.14beta1). Use getCTComment(CellAddress) instead
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments getCTComments()
          Returns the underlying CTComments list xmlbean
 int getNumberOfAuthors()
           
 int getNumberOfComments()
           
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(CellAddress ref)
          Create a new comment located` at cell address
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(java.lang.String ref)
          Deprecated. 2015-11-23 (circa POI 3.14beta1). Use newComment(CellAddress) instead
 void readFrom(java.io.InputStream is)
           
 void referenceUpdated(CellAddress oldReference, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
          Called after the reference is updated, so that we can reflect that in our cache
 void referenceUpdated(java.lang.String oldReference, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
          Deprecated. 2015-11-23 (circa POI 3.14beta1). Use referenceUpdated(CellAddress, CTComment) instead
 boolean removeComment(CellAddress cellRef)
          Remove the comment at cellRef location, if one exists
 boolean removeComment(java.lang.String cellRef)
          Deprecated. 2015-11-23 (circa POI 3.14beta1). Use removeComment(CellAddress) instead
 void writeTo(java.io.OutputStream out)
           
 
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
 

Field Detail

DEFAULT_AUTHOR

public static final java.lang.String DEFAULT_AUTHOR
See Also:
Constant Field Values

DEFAULT_AUTHOR_ID

public static final int DEFAULT_AUTHOR_ID
See Also:
Constant Field Values
Constructor Detail

CommentsTable

public CommentsTable()

CommentsTable

public CommentsTable(PackagePart part)
              throws java.io.IOException
Throws:
java.io.IOException
Since:
POI 3.14-Beta1

CommentsTable

@Deprecated
public CommentsTable(PackagePart part,
                                PackageRelationship rel)
              throws java.io.IOException
Deprecated. in POI 3.14, scheduled for removal in POI 3.16

Throws:
java.io.IOException
Method Detail

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)
Deprecated. 2015-11-23 (circa POI 3.14beta1). Use referenceUpdated(CellAddress, CTComment) instead

Called after the reference is updated, so that we can reflect that in our cache


referenceUpdated

public void referenceUpdated(CellAddress oldReference,
                             org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
Called after the reference is updated, so that we can reflect that in our cache

Parameters:
oldReference - the comment to remove from the commentRefs map
comment - the comment to replace in the commentRefs map

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)
Deprecated. 2015-11-23 (circa POI 3.14beta1). Use findCellComment(CellAddress) instead

Finds the cell comment at cellAddress, if one exists

Parameters:
cellRef - the address of the cell to find a comment
Returns:
cell comment if one exists, otherwise returns null

findCellComment

public XSSFComment findCellComment(CellAddress cellAddress)
Finds the cell comment at cellAddress, if one exists

Parameters:
cellAddress - the address of the cell to find a comment
Returns:
cell comment if one exists, otherwise returns null

getCTComment

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(java.lang.String ref)
Deprecated. 2015-11-23 (circa POI 3.14beta1). Use getCTComment(CellAddress) instead

Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists

Parameters:
ref - the location of the cell comment
Returns:
CTComment xmlbean if comment exists, otherwise return null.

getCTComment

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(CellAddress cellRef)
Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists

Parameters:
cellRef - the location of the cell comment
Returns:
CTComment xmlbean if comment exists, otherwise return null.

getCellComments

public java.util.Map<CellAddress,XSSFComment> getCellComments()
Returns all cell comments on this sheet.

Returns:
A map of each Comment in this sheet, keyed on the cell address where the comment is located.

newComment

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(java.lang.String ref)
Deprecated. 2015-11-23 (circa POI 3.14beta1). Use newComment(CellAddress) instead

Create a new comment located at cell address

Parameters:
ref - the location to add the comment
Returns:
a new CTComment located at ref with default author

newComment

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(CellAddress ref)
Create a new comment located` at cell address

Parameters:
ref - the location to add the comment
Returns:
a new CTComment located at ref with default author

removeComment

public boolean removeComment(java.lang.String cellRef)
Deprecated. 2015-11-23 (circa POI 3.14beta1). Use removeComment(CellAddress) instead

Remove the comment at cellRef location, if one exists

Parameters:
cellRef - the location of the comment to remove
Returns:
returns true if a comment was removed

removeComment

public boolean removeComment(CellAddress cellRef)
Remove the comment at cellRef location, if one exists

Parameters:
cellRef - the location of the comment to remove
Returns:
returns true if a comment was removed

getCTComments

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments getCTComments()
Returns the underlying CTComments list xmlbean

Returns:
underlying comments list xmlbean


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.