JavaライブラリのApache POIを用いて読み込んだエクセルファイルの複数セルにコメントが付与できない問題について

Question

前提・実現したいこと

Apache POI を用いて、読み込んだエクセルファイルの
「複数」セルにコメントを付与する方法を皆様からご教授いただきたい。

発生している問題・エラーメッセージ

下記「該当のソースコード」のswitch文内で
各条件に合致したセルにコメントを付与する処理を記述した。
A2～D2の各セルにコメントが付与される想定だが
セルD2のみにしかコメントを付与しない。

なお、用意したエクセルファイル「コメント挿入.xlsx」には以下を記述
A1セル→文字列
A2セル→ABC
B1セル→数字
B2セル→1
C1セル→真偽値
C2セル→TRUE
D1セル→計算式
D2セル→=SUM(1+1)【備考：セル上では「2」と表示】

該当のソースコード

package com.example.demo;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.ClientAnchor;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class insertComment {

	public static void main(String[] args) throws IOException {
		SpringApplication.run(insertComment.class, args);

		// サンプルテスト開始
		System.out.println("コメント挿入開始");
		Row row = null;
		Cell cell = null;

		OutputStream os = null;
		InputStream in = new FileInputStream("C:\work\tech\コメント挿入.xlsx");
		Workbook wb = WorkbookFactory.create(in);
		Sheet sheet = wb.getSheetAt(0);

		//コメント設定関連
		Drawing<?> patriarch = sheet.createDrawingPatriarch();
		ClientAnchor anchor = new XSSFClientAnchor();
		Comment comment = patriarch.createCellComment(anchor);
		CreationHelper creationHelper = wb.getCreationHelper();
		RichTextString text = creationHelper.createRichTextString("コメントです。");
		comment.setString(text);

		try {
			for (int i = 1; i < 2; i++) {
				row = sheet.getRow(1);

				for (int j = 0; j < 4; j++) {
					cell = row.getCell(j);
					cell.setCellComment(comment);

					CellType cellType = cell.getCellType();

					switch (j) {
					case 0:
						if (cellType == CellType.STRING) {
							cell.setCellComment(comment);
							break;
						}else {
							System.out.println("No STRING");
						}
					case 1:
						if (cellType == CellType.NUMERIC) {
							cell.setCellComment(comment);
							break;
						}else {
							System.out.println("No NUMERIC");
						}
					case 2:
						if (cellType == CellType.BOOLEAN) {
							cell.setCellComment(comment);
							break;
						}else {
							System.out.println("No BOOLEAN");
						}
					case 3:
						if (cellType == CellType.FORMULA) {
							cell.setCellComment(comment);
							break;
						}else {
							System.out.println("No FORMULA");
						}
					}
				}
			}
		} catch (Exception e) {
			System.out.println(e.toString());
		} finally {
			os = new FileOutputStream(new File("C:\work\tech\コメント挿入_チェック済み.xlsx"));
			wb.write(os);
			wb.close();
			os.close();
			System.out.println("処理終了");
		}
	}
}

試したこと

・エクセルのA2~D2セルにはswitchのセルタイプ条件に合致する値を記述しログには
下記が表示されていることを確認。(swich文内のelseには分岐していないことがわかる)

　コメント挿入開始
処理終了

・swich文の条件は上記の「該当のソースコード」ではSTRING、NUMERIC、BOOLEAN、FOMURAだが
「FOMURAの条件を削除」、「セルの取得をA2～D2→A2～C2までに変更（for (int j = 0; j < 3; j++)に変更）」
し処理を実行したところ、今度はC2セルのみにコメントが付与されていた。以上のことから、A2、B2、C2にはコメントが付与
されてはいるが、次のセルにコメントを付与する度に一つ前のセルに付与されたコメントが消えていると想定できる。

Answer 1

コードを読んだ限りですが、発生している状況は、多分、以下の通り。
1.Comment comment = patriarch.createCellComment(anchor); で、コメントオブジェクトを作成
2.case 0 のcell.setCellComment(comment); で該当セルにコメントを設定し、コメントオブジェクトに対象セルとして、A2を設定
3.case 1 のcell.setCellComment(comment); で該当セルにコメントを設定し、コメントオブジェクトに対象セルとして、A2を消して、B2を設定
以下略。

なので、Commentをループの中で作成すれば、全部のセルにコメントが付与されるでしょう。

POIのCommentインターフェースドキュメント
int getColumn()とか、単独セルとの結合のみであることを示唆しています。

Comments

[tukigami_555]

YT0014様

おはようございます。tukigamiです。
ご教授いただいた方法でコードを修正→実行しエクセルファイルを開いたところ以下のような問題が生じました。

ネットでエクセルのxmlエラーについて調べても有益な情報が得られず、何か知っていることが
あれば教えていただけるとありがたいです。
詳細は以下となっております。

■問題
①一部の内容で問題が発生した旨のダイアログが表示

②内容の回復をするか問われたため「はい」をクリック

③クリック後、以下の文言がダイアログで表示
「削除されたパーツ: /xl/comments1.xml パーツに XML エラーがありました。 (コメント) 致命的なエラーです。場所は、行 2、列 149 です。」

④修復のログファイルも見れるため表示
「<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<recoveryLog xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main"><logFileName>error066840_01.xml</logFileName><summary>ファイル 'C:\work\tech\コメント挿入_チェック済み.xlsx' にエラーが検出されました</summary><removedParts><removedPart>削除されたパーツ: /xl/comments1.xml パーツに XML エラーがありました。 (コメント) 致命的なエラーです。場所は、行 2、列 149 です。</removedPart></removedParts></recoveryLog>」

■試したこと
ネットで「エクセル xmlエラー」等で検索を行いましたが有効な情報は得られず

■修正ソース
→「該当のソースコード」のswich文内の各caseのみを修正(swich文以外は修正なし)

package com.example.demo;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.ClientAnchor;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.xssf.usermodel.XSSFClientAnchor;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class insertComment {

public static void main(String[] args) throws IOException {
SpringApplication.run(insertComment.class, args);

// サンプルテスト開始
System.out.println("コメント挿入開始");
Row row = null;
Cell cell = null;

OutputStream os = null;
InputStream in = new FileInputStream("C:\work\tech\コメント挿入.xlsx");
Workbook wb = WorkbookFactory.create(in);
Sheet sheet = wb.getSheetAt(0);

//コメント設定関連
Drawing<?> patriarch = sheet.createDrawingPatriarch();
ClientAnchor anchor = new XSSFClientAnchor();
//Comment comment = patriarch.createCellComment(anchor);
CreationHelper creationHelper = wb.getCreationHelper();
RichTextString text = creationHelper.createRichTextString("コメントです。");
//comment.setString(text);

try {
for (int i = 1; i < 2; i++) {
row = sheet.getRow(1);

for (int j = 0; j < 4; j++) {
cell = row.getCell(j);

CellType cellType = cell.getCellType();

switch (j) {
case 0:
if (cellType == CellType.STRING) {
Comment comment0 = patriarch.createCellComment(anchor);
cell.setCellComment(comment0);
break;
}else {
System.out.println("No STRING");
}
case 1:
if (cellType == CellType.NUMERIC) {
Comment comment1 = patriarch.createCellComment(anchor);
cell.setCellComment(comment1);
break;
}else {
System.out.println("No NUMERIC");
}
case 2:
if (cellType == CellType.BOOLEAN) {
Comment comment2 = patriarch.createCellComment(anchor);
cell.setCellComment(comment2);
break;
}else {
System.out.println("No BOOLEAN");
}
case 3:
if (cellType == CellType.FORMULA) {
Comment comment3 = patriarch.createCellComment(anchor);
cell.setCellComment(comment3);
break;
}else {
System.out.println("No FORMULA");
}
}
}
}
} catch (Exception e) {
System.out.println(e.toString());
} finally {
os = new FileOutputStream(new File("C:\work\tech\コメント挿入_チェック済み.xlsx"));
wb.write(os);
wb.close();
os.close();
System.out.println("処理終了");
}
}
}

[YT0014]

新しくエクセルファイルを作成して、プログラムを実行し、再現するか、ご確認ください。
不具合のあるままの実行が影響していた可能性があります。
再現した場合、修復はせずに、該当ファイルのコピーをZIPとして展開し、該当のXMLファイルを取得して、内容をご確認ください。