com.github.pjfanning.poi.xssf.streaming

Class MapBackedCommentsTable

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

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

com.github.pjfanning.poi.xssf.streaming.MapBackedCommentsTable

All Implemented Interfaces:

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

public class MapBackedCommentsTable
extends CommentsTableBase

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 inherited from class com.github.pjfanning.poi.xssf.streaming.CommentsTableBase

authors, comments, fullFormat, ignoreDrawing, sheet

Constructor Summary

Constructors

Constructor and Description
MapBackedCommentsTable()
MapBackedCommentsTable(boolean fullFormat)
MapBackedCommentsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg)
MapBackedCommentsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg, boolean fullFormat)

Method Summary

Modifier and Type	Method and Description
protected Iterator<Integer>	authorsKeyIterator()
void	close()
protected Iterator<String>	commentsKeyIterator()
protected org.slf4j.Logger	getLogger()

Methods inherited from class com.github.pjfanning.poi.xssf.streaming.CommentsTableBase

commentUpdated, commit, createNewComment, findAuthor, findCellComment, getAuthor, getCellAddresses, getNumberOfAuthors, getNumberOfComments, isIgnoreDrawing, readFrom, referenceUpdated, removeComment, setIgnoreDrawing, setSheet, writeTo

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

Constructor Detail

MapBackedCommentsTable

public MapBackedCommentsTable()

MapBackedCommentsTable

public MapBackedCommentsTable(boolean fullFormat)

Parameters:

fullFormat - whether to use the full format for the comment text

MapBackedCommentsTable

public MapBackedCommentsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg)
                       throws IOException

Parameters:

pkg - the package to load

Throws:

IOException - if an error occurs while reading the package

MapBackedCommentsTable

public MapBackedCommentsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg,
                              boolean fullFormat)
                       throws IOException

Parameters:

pkg - the package to load

fullFormat - whether to use the full format for the comment text

Throws:

IOException - if an error occurs while reading the package

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class CommentsTableBase

authorsKeyIterator

protected Iterator<Integer> authorsKeyIterator()

Specified by:

authorsKeyIterator in class CommentsTableBase

commentsKeyIterator

protected Iterator<String> commentsKeyIterator()

Specified by:

commentsKeyIterator in class CommentsTableBase

close

public void close()