From b60641017da36586a9cd3f142a964196be13cf65 Mon Sep 17 00:00:00 2001
From: PJ Fanning <fanningpj@apache.org>
Date: Sun, 10 Oct 2021 17:16:21 +0000
Subject: [PATCH] refactor XSSFReader to make it more extensible

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894112 13f79535-47bb-0310-9956-ffa450edef68
---
 .../poi/xssf/eventusermodel/XSSFReader.java     | 17 +++++++----------
 .../poi/xssf/eventusermodel/TestXSSFReader.java |  3 ++-
 2 files changed, 9 insertions(+), 11 deletions(-)

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
index 7ba0a96df5..47eeecf396 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/eventusermodel/XSSFReader.java
@@ -44,10 +44,7 @@ import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
 import org.apache.poi.openxml4j.opc.PackageRelationshipTypes;
 import org.apache.poi.openxml4j.opc.PackagingURIHelper;
 import org.apache.poi.util.XMLHelper;
-import org.apache.poi.xssf.model.CommentsTable;
-import org.apache.poi.xssf.model.SharedStringsTable;
-import org.apache.poi.xssf.model.StylesTable;
-import org.apache.poi.xssf.model.ThemesTable;
+import org.apache.poi.xssf.model.*;
 import org.apache.poi.xssf.usermodel.XSSFDrawing;
 import org.apache.poi.xssf.usermodel.XSSFRelation;
 import org.apache.poi.xssf.usermodel.XSSFShape;
@@ -342,7 +339,7 @@ public class XSSFReader {
          * Returns the comments associated with this sheet,
          * or null if there aren't any
          */
-        public CommentsTable getSheetComments() {
+        public Comments getSheetComments() {
             PackagePart sheetPkg = getSheetPart();
 
             // Do we have a comments relationship? (Only ever one if so)
@@ -363,7 +360,7 @@ public class XSSFReader {
         }
 
         //to allow subclassing
-        protected CommentsTable parseComments(PackagePart commentsPart) throws IOException {
+        protected Comments parseComments(PackagePart commentsPart) throws IOException {
             return new CommentsTable(commentsPart);
         }
 
@@ -374,7 +371,7 @@ public class XSSFReader {
         public List<XSSFShape> getShapes() {
             PackagePart sheetPkg = getSheetPart();
             List<XSSFShape> shapes = new LinkedList<>();
-            // Do we have a comments relationship? (Only ever one if so)
+            // Do we have a shapes relationship? (Only ever one if so)
             try {
                 PackageRelationshipCollection drawingsList = sheetPkg.getRelationshipsByType(XSSFRelation.DRAWINGS.getRelation());
                 for (int i = 0; i < drawingsList.size(); i++) {
@@ -410,7 +407,7 @@ public class XSSFReader {
         }
     }
 
-    protected static final class XSSFSheetRef {
+    public static final class XSSFSheetRef {
         //do we need to store sheetId, too?
         private final String id;
         private final String name;
@@ -430,7 +427,7 @@ public class XSSFReader {
     }
 
     //scrapes sheet reference info and order from workbook.xml
-    private static class XMLSheetRefReader extends DefaultHandler {
+    public static class XMLSheetRefReader extends DefaultHandler {
         private static final String SHEET = "sheet";
         private static final String ID = "id";
         private static final String NAME = "name";
@@ -459,7 +456,7 @@ public class XSSFReader {
             }
         }
 
-        List<XSSFSheetRef> getSheetRefs() {
+        public List<XSSFSheetRef> getSheetRefs() {
             return Collections.unmodifiableList(sheetRefs);
         }
     }
diff --git a/poi-ooxml/src/test/java/org/apache/poi/xssf/eventusermodel/TestXSSFReader.java b/poi-ooxml/src/test/java/org/apache/poi/xssf/eventusermodel/TestXSSFReader.java
index bb7d6e3342..463656d4db 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xssf/eventusermodel/TestXSSFReader.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xssf/eventusermodel/TestXSSFReader.java
@@ -45,6 +45,7 @@ import org.apache.poi.ss.usermodel.Name;
 import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.util.IOUtils;
 import org.apache.poi.xssf.XSSFTestDataSamples;
+import org.apache.poi.xssf.model.Comments;
 import org.apache.poi.xssf.model.CommentsTable;
 import org.apache.poi.xssf.model.StylesTable;
 import org.apache.poi.xssf.usermodel.XSSFShape;
@@ -173,7 +174,7 @@ public final class TestXSSFReader {
 
               if (count == 1) {
                   assertNotNull(it.getSheetComments());
-                  CommentsTable ct = it.getSheetComments();
+                  Comments ct = it.getSheetComments();
                   assertEquals(1, ct.getNumberOfAuthors());
                   assertEquals(3, ct.getNumberOfComments());
               } else {
-- 
2.39.5