-
Notifications
You must be signed in to change notification settings - Fork 102
/
ExcelCompare.java
285 lines (249 loc) · 11 KB
/
ExcelCompare.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
package com.ka.excelcmp;
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import org.apache.poi.ss.usermodel.Cell;
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;
public class ExcelCompare {
static String usage(){
return "Usage> excel_cmp <file1> <file2> [--ignore1 <sheet-ignore-spec> <sheet-ignore-spec> ..] [--ignore2 <sheet-ignore-spec> <sheet-ignore-spec> ..]" + "\n"
+ "\n"
+ "Notes: * Prints all diffs & extra cells on stdout" + "\n"
+ " * Process exits with 0 if workbooks match, 1 otherwise" + "\n"
+ " * Works with both xls, xlsx. You may compare an xls with xlsx too" + "\n"
+ " * Compares only cell \"contents\". Formatting, macros are not diffed" + "\n"
+ " * Using --ignore1 & --ignore2 (optional) you may tell the diff to ignore cells" + "\n"
+ " * Give one and only one <sheet-ignore-spec> for a sheet" + "\n"
+ "\n"
+ "Sheet Ignore Spec: <sheet-name>:<row-ignore-spec>:<column-ignore-spec>:<cell-ignore-spec>" + "\n"
+ " * Everything except <sheet-name> is optional" + "\n"
+ " * To ignore whole sheet, just provide <sheet-name>" + "\n"
+ " * Any cell satisfying any ignore spec in the sheet (row, col, or cell) will be ignored in diff" + "\n"
+ " * You may provide only <cell-ignore-spec> as - <sheet-name>:::<cell-ignore-spec>" + "\n"
+ "\n"
+ "Row Ignore Spec: <comma sep list of row or row-range>" + "\n"
+ " * Row numbers begin from 1" + "\n"
+ " * Range of rows may be provide as: 1-10" + "\n"
+ " * Rows and ranges may be mixed as: 1-10,12,20-30 etc." + "\n"
+ "\n"
+ "Column Ignore Spec: <comma sep list of column or column-range>" + "\n"
+ " * Similar to Row Ignore Spec" + "\n"
+ " * Columns are letters starting with A" + "\n"
+ "\n"
+ "Cell Ignore Spec: <comma sep list of cell or cell-range>" + "\n"
+ " * Similar to Row Ignore Spec" + "\n"
+ " * Cells are in usual Excel notation A1 D10" + "\n"
+ " * Range may be provided as A1-D10" + "\n"
+ "\n"
+ "Example command line: " + "\n"
+ "excel_cmp 1.xlsx 2.xlsx --ignore1 Sheet1:::A1,B1,J10,K11,D4 Sheet2:::A1 --ignore2 Sheet1:::A1,D4,J10 Sheet3:::A1" + "\n"
;
}
/*
* TODO: Provide API (callbacks)
* TODO: Add tests
* TODO: Better display of results
*/
public static void main(String[] args) throws Exception{
if ((args.length < 2)){
System.out.println(usage());
return;
}
final File file1 = new File(args[0]);
final File file2 = new File(args[1]);
Workbook wb1 = WorkbookFactory.create(file1);
Workbook wb2 = WorkbookFactory.create(file2);
Map<String,SheetIgnores> sheetIgnores1 = parseSheetIgnores(args, "--ignore1");
Map<String,SheetIgnores> sheetIgnores2 = parseSheetIgnores(args, "--ignore2");
WorkbookIterator wi1 = new WorkbookIterator(wb1, sheetIgnores1);
WorkbookIterator wi2 = new WorkbookIterator(wb2, sheetIgnores2);
DiffReportCallback call = new DiffReportCallback() {
Set<Object> sheets = new LinkedHashSet<Object>();
Set<Object> rows = new LinkedHashSet<Object>();
Set<Object> cols = new LinkedHashSet<Object>();
Set<Object> sheets1 = new LinkedHashSet<Object>();
Set<Object> rows1 = new LinkedHashSet<Object>();
Set<Object> cols1 = new LinkedHashSet<Object>();
Set<Object> sheets2 = new LinkedHashSet<Object>();
Set<Object> rows2 = new LinkedHashSet<Object>();
Set<Object> cols2 = new LinkedHashSet<Object>();
@Override
public void reportWorkbooksDiffer(boolean differ) {
reportSummary();
System.out.println("Excel files " + file1 +" and " + file2 +" " + (differ ? "differ" : "match"));
}
@Override
public void reportExtraCell(boolean firstWb, CellPos c) {
if (firstWb){
sheets1.add(c.sheet()); rows1.add(c.row()); cols1.add(c.col());
} else {
sheets2.add(c.sheet()); rows2.add(c.row()); cols2.add(c.col());
}
String wb = firstWb ? "WB1" : "WB2";
System.out.println("EXTRA Cell in " + wb + " " + c.cellPos() +" => '" + c.value() + "'");
}
@Override
public void reportDiffCell(CellPos c1, CellPos c2) {
sheets.add(c1.sheet()); rows.add(c1.row()); cols.add(c1.col());
System.out.println("DIFF Cell at " + c1.cellPos()+" => '"+ c1.value() +"' v/s '" + c2.value() + "'");
}
private void reportSummary(){
reportS("DIFF", sheets, rows, cols);
reportS("EXTRA WB1", sheets1, rows1, cols1);
reportS("EXTRA WB2", sheets2, rows2, cols2);
System.out.println("-----------------------------------------");
}
private void reportS(String what, Set<Object> sheets, Set<Object> rows, Set<Object> cols){
System.out.println("----------------- "+what+" -------------------");
System.out.println("Sheets: " + sheets);
System.out.println("Rows: " + rows);
System.out.println("Cols: " + cols);
}
};
boolean differ = doDiff(wi1, wi2, call);
System.exit(differ ? 1 : 0);
}
private static boolean doDiff(WorkbookIterator wi1, WorkbookIterator wi2, DiffReportCallback call){
boolean isDiff = false;
CellPos c1 = null, c2 = null;
while (true){
if ((c1==null) && wi1.hasNext()) c1 = wi1.next();
if ((c2==null) && wi2.hasNext()) c2 = wi2.next();
if ((c1!=null) && (c2!=null)){
int c = c1.compareTo(c2);
if (c == 0){
if (!c1.value().equals(c2.value())){
isDiff = true;
call.reportDiffCell(c1, c2);
}
c1 = c2 = null;
}
else if (c < 0){
isDiff = true;
call.reportExtraCell(true, c1);
c1 = null;
}
else {
isDiff = true;
call.reportExtraCell(false, c2);
c2 = null;
}
} else {
break;
}
}
if ((c1!=null) && (c2==null)){
do {
isDiff = true;
call.reportExtraCell(true, c1);
c1 = wi1.hasNext() ? wi1.next() : null;
} while (c1 != null);
}
else if ((c1==null) && (c2!=null)){
do {
isDiff = true;
call.reportExtraCell(false, c2);
c2 = wi2.hasNext() ? wi2.next() : null;
} while (c2 != null);
}
if ((c1!=null) || (c2!=null)){
throw new IllegalStateException("Something wrong");
}
call.reportWorkbooksDiffer(isDiff);
return isDiff;
}
private static Map<String,SheetIgnores> parseSheetIgnores(String[] args, String opt){
int start = -1, end = -1;
for (int i=0; i<args.length; i++){
if (start == -1){
if (opt.equals(args[i])){
start = i+1;
}
}
else {
if (args[i].startsWith("--")){
end = i;
}
}
}
if (end == -1) end = args.length;
Map<String,SheetIgnores> ret = new HashMap<String,SheetIgnores>();
if (start != -1){
for (int i=start; i<end; i++){
SheetIgnores s = SheetIgnores.newSheetIgnore(args[i]);
ret.put(s.sheetName(), s);
}
}
return ret;
}
}
class WorkbookIterator{
Workbook wb;
Map<String,SheetIgnores> sheetIgnores;
int currSheetIdx;
SheetIgnores currSheetIgnores;
Iterator<Row> rows;
Iterator<Cell> cells;
WorkbookIterator(Workbook wb, Map<String,SheetIgnores> sheetIgnores){
this.wb = wb;
this.sheetIgnores = sheetIgnores;
this.currSheetIdx = -1;
_seenNext = false;
}
boolean _seenNext;
Cell _nextCell;
boolean hasNext(){
if (!_seenNext){
_nextCell = null;
_seenNext = true;
while (_nextCell == null){
if ((cells != null) && (cells.hasNext())){
Cell cell = cells.next();
if (!ignoreCol(cell) && !ignoreCell(cell)){
_nextCell = cell;
}
}
else if ((rows != null) && (rows.hasNext())){
Row row = rows.next();
if (!ignoreRow(row)){
cells = row.cellIterator();
}
}
else if (currSheetIdx < (wb.getNumberOfSheets()-1)){
currSheetIdx++;
Sheet sheet = wb.getSheetAt(currSheetIdx);
currSheetIgnores = sheetIgnores.get(wb.getSheetName(currSheetIdx));
if (!ignoreSheet()){
rows = sheet.rowIterator();
}
}
else{
break;
}
}
}
return _nextCell != null;
}
boolean ignoreSheet(){
return (currSheetIgnores!=null) && currSheetIgnores.isWholeSheetIgnored();
}
boolean ignoreRow(Row row){
return (currSheetIgnores!=null) && (currSheetIgnores.isRowIgnored(row.getRowNum()));
}
boolean ignoreCol(Cell cell){
return (currSheetIgnores!=null) && (currSheetIgnores.isColIgnored(cell.getColumnIndex()));
}
boolean ignoreCell(Cell cell){
return (currSheetIgnores!=null) && (currSheetIgnores.isCellIgnored(cell.getRowIndex(), cell.getColumnIndex()));
}
CellPos next(){
_seenNext = false;
return new CellPos(wb, currSheetIdx, _nextCell);
}
}