forked from tabulapdf/tabula-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPage.java
More file actions
416 lines (340 loc) · 12.5 KB
/
Page.java
File metadata and controls
416 lines (340 loc) · 12.5 KB
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
package technology.tabula;
import java.awt.geom.Point2D;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import static java.lang.Float.compare;
import static java.util.Collections.min;
@SuppressWarnings("serial")
// TODO: this class should probably be called "PageArea" or something like that
public class Page extends Rectangle {
private int number;
private Integer rotation;
private float minCharWidth;
private float minCharHeight;
private List<TextElement> textElements;
// TODO: Create a class for 'List <Ruling>' that encapsulates all of these lists and their behaviors?
private List<Ruling> rulings,
cleanRulings = null,
verticalRulingLines = null,
horizontalRulingLines = null;
private PDPage pdPage;
private PDDocument pdDoc;
private RectangleSpatialIndex<TextElement> spatialIndex;
private static final float DEFAULT_MIN_CHAR_LENGTH = 7;
private Page(
PageDims pageDims,
int rotation,
int number,
PDPage pdPage,
PDDocument doc,
List<TextElement> characters,
List<Ruling> rulings,
float minCharWidth,
float minCharHeight,
RectangleSpatialIndex<TextElement> index
) {
super(pageDims.getTop(), pageDims.getLeft(), pageDims.getWidth(), pageDims.getHeight());
this.rotation = rotation;
this.number = number;
this.pdPage = pdPage;
this.pdDoc = doc;
this.textElements = characters;
this.rulings = rulings;
this.minCharWidth = minCharWidth;
this.minCharHeight = minCharHeight;
this.spatialIndex = index;
}
/**
*
* @deprecated use {@link Builder} instead
*/
@Deprecated
public Page(float top, float left, float width, float height, int rotation, int number, PDPage pdPage, PDDocument doc) {
super(top, left, width, height);
this.rotation = rotation;
this.number = number;
this.pdPage = pdPage;
this.pdDoc = doc;
}
/**
*
* @deprecated use {@link Builder} instead
*/
public Page(float top, float left, float width, float height, int rotation, int number, PDPage pdPage, PDDocument doc,
List<TextElement> characters, List<Ruling> rulings) {
this(top, left, width, height, rotation, number, pdPage, doc);
this.textElements = characters;
this.rulings = rulings;
}
/**
*
* @deprecated use {@link Builder} instead
*/
public Page(float top, float left, float width, float height, int rotation, int number, PDPage pdPage, PDDocument doc,
ObjectExtractorStreamEngine streamEngine, TextStripper textStripper) {
this(top, left, width, height, rotation, number, pdPage, doc, textStripper.getTextElements(), streamEngine.rulings);
this.minCharWidth = textStripper.getMinCharWidth();
this.minCharHeight = textStripper.getMinCharHeight();
this.spatialIndex = textStripper.getSpatialIndex();
}
/**
*
* @deprecated use {@link Builder} instead
*/
public Page(float top, float left, float width, float height, int rotation, int number, PDPage pdPage, PDDocument doc,
List<TextElement> characters, List<Ruling> rulings,
float minCharWidth, float minCharHeight, RectangleSpatialIndex<TextElement> index) {
this(top, left, width, height, rotation, number, pdPage, doc, characters, rulings);
this.minCharHeight = minCharHeight;
this.minCharWidth = minCharWidth;
this.spatialIndex = index;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
public Page getArea(Rectangle area) {
List<TextElement> areaTextElements = getText(area);
float minimumCharWidth = getMinimumCharWidthFrom(areaTextElements);
float minimumCharHeight = getMinimumCharHeightFrom(areaTextElements);
final Page page = Page.Builder.newInstance()
.withPageDims(PageDims.of(area.getTop(), area.getLeft(), (float) area.getWidth(), (float) area.getHeight()))
.withRotation(rotation)
.withNumber(number)
.withPdPage(pdPage)
.withPdDocument(pdDoc)
.withTextElements(areaTextElements)
.withRulings(Ruling.cropRulingsToArea(getRulings(), area))
.withMinCharWidth(minimumCharWidth)
.withMinCharHeight(minimumCharHeight)
.withIndex(spatialIndex)
.build();
addBorderRulingsTo(page);
return page;
}
private float getMinimumCharWidthFrom(List<TextElement> areaTextElements) {
if (!areaTextElements.isEmpty()) {
return min(areaTextElements, (te1, te2) -> compare(te1.width, te2.width)).width;
}
return DEFAULT_MIN_CHAR_LENGTH;
}
private float getMinimumCharHeightFrom(List<TextElement> areaTextElements) {
if (!areaTextElements.isEmpty()) {
return min(areaTextElements, (te1, te2) -> compare(te1.height, te2.height)).height;
}
return DEFAULT_MIN_CHAR_LENGTH;
}
private void addBorderRulingsTo(Page page) {
Point2D.Double leftTop = new Point2D.Double(page.getLeft(), page.getTop()),
rightTop = new Point2D.Double(page.getRight(), page.getTop()),
rightBottom = new Point2D.Double(page.getRight(), page.getBottom()),
leftBottom = new Point2D.Double(page.getLeft(), page.getBottom());
page.addRuling(new Ruling(leftTop, rightTop));
page.addRuling(new Ruling(rightTop, rightBottom));
page.addRuling(new Ruling(rightBottom, leftBottom));
page.addRuling(new Ruling(leftBottom, leftTop));
}
public Page getArea(float top, float left, float bottom, float right) {
Rectangle area = new Rectangle(top, left, right - left, bottom - top);
return getArea(area);
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
public Integer getRotation() {
return rotation;
}
public int getPageNumber() {
return number;
}
/**
* @deprecated with no replacement
*/
@Deprecated
public float getMinCharWidth() {
return minCharWidth;
}
/**
* @deprecated with no replacement
*/
@Deprecated
public float getMinCharHeight() {
return minCharHeight;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
public List<TextElement> getText() {
return textElements;
}
public List<TextElement> getText(Rectangle area) {
return spatialIndex.contains(area);
}
/**
* @deprecated use {@linkplain #getText(Rectangle)} instead
*/
@Deprecated
public List<TextElement> getText(float top, float left, float bottom, float right) {
return getText(new Rectangle(top, left, right - left, bottom - top));
}
/**
* @deprecated use {@linkplain #getText()} instead
*/
@Deprecated
public List<TextElement> getTexts() {
return textElements;
}
/**
* Returns the minimum bounding box that contains all the TextElements on this Page
*/
public Rectangle getTextBounds() {
List<TextElement> texts = this.getText();
if (!texts.isEmpty()) {
return Utils.bounds(texts);
} else {
return new Rectangle();
}
}
/**
* @deprecated with no replacement
*/
@Deprecated
public boolean hasText() {
return textElements.size() > 0;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
public List<Ruling> getRulings() {
if (cleanRulings != null) {
return cleanRulings;
}
if (rulings == null || rulings.isEmpty()) {
verticalRulingLines = new ArrayList<>();
horizontalRulingLines = new ArrayList<>();
return new ArrayList<>();
}
// TODO: Move as a static method to the Ruling class?
Utils.snapPoints(rulings, minCharWidth, minCharHeight);
verticalRulingLines = getCollapsedVerticalRulings();
horizontalRulingLines = getCollapsedHorizontalRulings();
cleanRulings = new ArrayList<>(verticalRulingLines);
cleanRulings.addAll(horizontalRulingLines);
return cleanRulings;
}
// TODO: Create a class for 'List <Ruling>' and encapsulate these behaviors within it?
private List<Ruling> getCollapsedVerticalRulings() {
List<Ruling> verticalRulings = new ArrayList<>();
for (Ruling ruling : rulings) {
if (ruling.vertical()) {
verticalRulings.add(ruling);
}
}
return Ruling.collapseOrientedRulings(verticalRulings);
}
private List<Ruling> getCollapsedHorizontalRulings() {
List<Ruling> horizontalRulings = new ArrayList<>();
for (Ruling ruling : rulings) {
if (ruling.horizontal()) {
horizontalRulings.add(ruling);
}
}
return Ruling.collapseOrientedRulings(horizontalRulings);
}
public List<Ruling> getVerticalRulings() {
if (verticalRulingLines != null) {
return verticalRulingLines;
}
getRulings();
return verticalRulingLines;
}
public List<Ruling> getHorizontalRulings() {
if (horizontalRulingLines != null) {
return horizontalRulingLines;
}
getRulings();
return horizontalRulingLines;
}
public void addRuling(Ruling ruling) {
if (ruling.oblique()) {
throw new UnsupportedOperationException("Can't add an oblique ruling.");
}
rulings.add(ruling);
// Clear caches:
verticalRulingLines = null;
horizontalRulingLines = null;
cleanRulings = null;
}
public List<Ruling> getUnprocessedRulings() {
return rulings;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
public PDPage getPDPage() {
return pdPage;
}
public PDDocument getPDDoc() {
return pdDoc;
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - //
/**
* @deprecated with no replacement
*/
@Deprecated
public RectangleSpatialIndex<TextElement> getSpatialIndex() {
return spatialIndex;
}
public static class Builder {
private PageDims pageDims;
private int rotation;
private int number;
private PDPage pdPage;
private PDDocument pdDocument;
private List<TextElement> textElements;
private List<Ruling> rulings;
private float minCharWidth;
private float minCharHeight;
private RectangleSpatialIndex<TextElement> index;
private Builder() {}
public static Builder newInstance() {
return new Builder();
}
public Builder withPageDims(PageDims pageDims) {
this.pageDims = pageDims;
return this;
}
public Builder withRotation(int rotation) {
this.rotation = rotation;
return this;
}
public Builder withNumber(int number) {
this.number = number;
return this;
}
public Builder withPdPage(PDPage pdPage) {
this.pdPage = pdPage;
return this;
}
public Builder withPdDocument(PDDocument pdDocument) {
this.pdDocument = pdDocument;
return this;
}
public Builder withTextElements(List<TextElement> textElements) {
this.textElements = textElements;
return this;
}
public Builder withRulings(List<Ruling> rulings) {
this.rulings = rulings;
return this;
}
public Builder withMinCharWidth(float minCharWidth) {
this.minCharWidth = minCharWidth;
return this;
}
public Builder withMinCharHeight(float minCharHeight) {
this.minCharHeight = minCharHeight;
return this;
}
public Builder withIndex(RectangleSpatialIndex<TextElement> index) {
this.index = index;
return this;
}
public Page build() {
return new Page(pageDims, rotation, number, pdPage, pdDocument, textElements, rulings, minCharWidth, minCharHeight, index);
}
}
}