com.github.pjfanning.poi.xssf.streaming

Class CommentsTableBase

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

com.github.pjfanning.poi.xssf.streaming.CommentsTableBase

All Implemented Interfaces:

java.lang.AutoCloseable, org.apache.poi.xssf.model.Comments

Direct Known Subclasses:

MapBackedCommentsTable, TempFileCommentsTable

public abstract class CommentsTableBase
extends org.apache.poi.ooxml.POIXMLDocumentPart
implements org.apache.poi.xssf.model.Comments, java.lang.AutoCloseable

Table of comments.

The comments table contains all the necessary information for displaying the string: the text, formatting properties, and phonetic properties (for East Asian languages).

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.ooxml.POIXMLDocumentPart.RelationPart

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentMap<java.lang.Integer,java.lang.String>	authors
protected java.util.concurrent.ConcurrentMap<java.lang.String,com.github.pjfanning.poi.xssf.streaming.SerializableComment>	comments
protected boolean	fullFormat
protected boolean	ignoreDrawing
protected org.apache.poi.ss.usermodel.Sheet	sheet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommentsTableBase(boolean fullFormat)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Iterator<java.lang.Integer>	authorsKeyIterator()
protected abstract java.util.Iterator<java.lang.String>	commentsKeyIterator()
void	commentUpdated(org.apache.poi.xssf.usermodel.XSSFComment comment)
protected void	commit()
org.apache.poi.xssf.usermodel.XSSFComment	createNewComment(org.apache.poi.ss.usermodel.ClientAnchor clientAnchor)
int	findAuthor(java.lang.String author)
org.apache.poi.xssf.usermodel.XSSFComment	findCellComment(org.apache.poi.ss.util.CellAddress cellAddress)
java.lang.String	getAuthor(long authorId)
java.util.Iterator<org.apache.poi.ss.util.CellAddress>	getCellAddresses()
protected abstract org.slf4j.Logger	getLogger()
int	getNumberOfAuthors()
int	getNumberOfComments()
boolean	isIgnoreDrawing()
void	readFrom(java.io.InputStream is) Read this comments table from an XML file.
void	referenceUpdated(org.apache.poi.ss.util.CellAddress oldReference, org.apache.poi.xssf.usermodel.XSSFComment comment)
boolean	removeComment(org.apache.poi.ss.util.CellAddress cellRef)
void	setIgnoreDrawing(boolean ignoreDrawing)
void	setSheet(org.apache.poi.ss.usermodel.Sheet sheet)
void	writeTo(java.io.OutputStream out) Write this table out as XML.

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

ignoreDrawing

protected boolean ignoreDrawing

fullFormat

protected final boolean fullFormat

comments

protected java.util.concurrent.ConcurrentMap<java.lang.String,com.github.pjfanning.poi.xssf.streaming.SerializableComment> comments

authors

protected java.util.concurrent.ConcurrentMap<java.lang.Integer,java.lang.String> authors

Constructor Detail

CommentsTableBase

protected CommentsTableBase(boolean fullFormat)

Method Detail

getLogger

protected abstract org.slf4j.Logger getLogger()

authorsKeyIterator

protected abstract java.util.Iterator<java.lang.Integer> authorsKeyIterator()

commentsKeyIterator

protected abstract java.util.Iterator<java.lang.String> commentsKeyIterator()

setIgnoreDrawing

public void setIgnoreDrawing(boolean ignoreDrawing)

Parameters:

ignoreDrawing - set to true if you don't need the drawing/shape data on the comments (default is false) - ignoring the drawing/shape data can save memory

isIgnoreDrawing

public boolean isIgnoreDrawing()

Returns:

whether to ignore the drawing/shape data (default is false) - ignoring the drawing/shape data can save memory

setSheet

@Internal
public void setSheet(org.apache.poi.ss.usermodel.Sheet sheet)

Specified by:

setSheet in interface org.apache.poi.xssf.model.Comments

commit

protected void commit()
               throws java.io.IOException

Overrides:

commit in class org.apache.poi.ooxml.POIXMLDocumentPart

Throws:

java.io.IOException

readFrom

public void readFrom(java.io.InputStream is)
              throws java.io.IOException

Read this comments table from an XML file.

Parameters:

is - The input stream containing the XML document.

Throws:

java.io.IOException - if an error occurs while reading.

getNumberOfComments

public int getNumberOfComments()

Specified by:

getNumberOfComments in interface org.apache.poi.xssf.model.Comments

getNumberOfAuthors

public int getNumberOfAuthors()

Specified by:

getNumberOfAuthors in interface org.apache.poi.xssf.model.Comments

getAuthor

public java.lang.String getAuthor(long authorId)

Specified by:

getAuthor in interface org.apache.poi.xssf.model.Comments

findAuthor

public int findAuthor(java.lang.String author)

Specified by:

findAuthor in interface org.apache.poi.xssf.model.Comments

findCellComment

public org.apache.poi.xssf.usermodel.XSSFComment findCellComment(org.apache.poi.ss.util.CellAddress cellAddress)

Specified by:

findCellComment in interface org.apache.poi.xssf.model.Comments

removeComment

public boolean removeComment(org.apache.poi.ss.util.CellAddress cellRef)

Specified by:

removeComment in interface org.apache.poi.xssf.model.Comments

getCellAddresses

public java.util.Iterator<org.apache.poi.ss.util.CellAddress> getCellAddresses()

Specified by:

getCellAddresses in interface org.apache.poi.xssf.model.Comments

createNewComment

public org.apache.poi.xssf.usermodel.XSSFComment createNewComment(org.apache.poi.ss.usermodel.ClientAnchor clientAnchor)

Specified by:

createNewComment in interface org.apache.poi.xssf.model.Comments

referenceUpdated

public void referenceUpdated(org.apache.poi.ss.util.CellAddress oldReference,
                             org.apache.poi.xssf.usermodel.XSSFComment comment)

Specified by:

referenceUpdated in interface org.apache.poi.xssf.model.Comments

commentUpdated

public void commentUpdated(org.apache.poi.xssf.usermodel.XSSFComment comment)

Specified by:

commentUpdated in interface org.apache.poi.xssf.model.Comments

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Write this table out as XML.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - if an error occurs while writing.