org.dromara.pdf.pdfbox.core.ext.extractor

Class DocumentExtractor

java.lang.Object

org.dromara.pdf.pdfbox.core.ext.AbstractExpander

org.dromara.pdf.pdfbox.core.ext.extractor.AbstractExtractor

org.dromara.pdf.pdfbox.core.ext.extractor.DocumentExtractor

All Implemented Interfaces:

Closeable, AutoCloseable

public class DocumentExtractor
extends AbstractExtractor
implements Closeable

文档提取器

Since:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-pdfbox is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

Author:

xsx

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractBookmarkExtractor	bookmarkExtractor 书签提取器
protected AbstractCommentExtractor	commentExtractor 评论提取器
protected AbstractFormExtractor	formExtractor 表单提取器
protected AbstractImageExtractor	imageExtractor 图像提取器
protected AbstractTextExtractor	textExtractor 文本提取器

Fields inherited from class org.dromara.pdf.pdfbox.core.ext.AbstractExpander

document, log

Constructor Summary

Constructors

Constructor and Description
DocumentExtractor(Document document) 构造方法

Method Summary

Modifier and Type	Method and Description
void	close() 关闭
Map<Integer,org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem>	extractBookmark(int... bookmarkIndexes) 提取书签
Map<Integer,List<String>>	extractComment(int... pageIndexes) 提取评论
Map<Integer,List<String>>	extractCommentByRegex(String regex, int... pageIndexes) 正则提取评论
Map<String,org.apache.pdfbox.pdmodel.interactive.form.PDField>	extractFormField() 表单提取字段
Map<String,BufferedImage>	extractFormImage() 表单提取图像
Map<String,String>	extractFormText() 表单提取文本
Map<Integer,List<BufferedImage>>	extractImage(int... pageIndexes) 提取图像
Map<Integer,List<String>>	extractText(int... pageIndexes) 提取文本
Map<Integer,List<String>>	extractTextByRegex(String regex, int... pageIndexes) 正则提取文本
Map<Integer,Map<String,String>>	extractTextByRegionArea(Map<String,Rectangle> regionArea, int... pageIndexes) 区域提取文本
Map<Integer,Map<String,String>>	extractTextByRegionArea(Map<String,Rectangle> regionArea, String wordSeparator, int... pageIndexes) 区域提取文本
Map<Integer,Map<String,List<List<String>>>>	extractTextForTable(Map<String,Rectangle> regionArea, int... pageIndexes) 表格提取文本
Map<Integer,Map<String,List<List<String>>>>	extractTextForTable(Map<String,Rectangle> regionArea, String wordSeparator, int... pageIndexes) 表格提取文本

Methods inherited from class org.dromara.pdf.pdfbox.core.ext.AbstractExpander

getDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

textExtractor

protected AbstractTextExtractor textExtractor

文本提取器

imageExtractor

protected AbstractImageExtractor imageExtractor

图像提取器

formExtractor

protected AbstractFormExtractor formExtractor

表单提取器

commentExtractor

protected AbstractCommentExtractor commentExtractor

评论提取器

bookmarkExtractor

protected AbstractBookmarkExtractor bookmarkExtractor

书签提取器

Constructor Detail

DocumentExtractor

public DocumentExtractor(Document document)

构造方法

Parameters:

document - 文档

Method Detail

extractText

public Map<Integer,List<String>> extractText(int... pageIndexes)

提取文本

Parameters:

pageIndexes - 页面索引

Returns:

返回文本字典

key=页面索引，value=提取文本

extractTextByRegex

public Map<Integer,List<String>> extractTextByRegex(String regex,
                                                    int... pageIndexes)

正则提取文本

Parameters:

regex - 正则表达式

pageIndexes - 页面索引

Returns:

返回文本字典

key=页面索引，value=提取文本

extractTextByRegionArea

public Map<Integer,Map<String,String>> extractTextByRegionArea(Map<String,Rectangle> regionArea,
                                                               int... pageIndexes)

区域提取文本

Parameters:

regionArea - 区域

pageIndexes - 页面索引

Returns:

返回文本字典

一级，key = 页面索引，value = 提取文本字典二级，key = 区域名称，value = 提取文本

extractTextByRegionArea

public Map<Integer,Map<String,String>> extractTextByRegionArea(Map<String,Rectangle> regionArea,
                                                               String wordSeparator,
                                                               int... pageIndexes)

区域提取文本

Parameters:

regionArea - 区域

wordSeparator - 单词分隔符

pageIndexes - 页面索引

Returns:

返回文本字典

一级，key = 页面索引，value = 提取文本字典二级，key = 区域名称，value = 提取文本

extractTextForTable

public Map<Integer,Map<String,List<List<String>>>> extractTextForTable(Map<String,Rectangle> regionArea,
                                                                       int... pageIndexes)

表格提取文本

注：单行单列

Parameters:

regionArea - 区域

pageIndexes - 页面索引

Returns:

返回文本字典

一级，key = 页面索引，value = 提取文本字典

二级，key = 区域名称，value = 提取文本

extractTextForTable

public Map<Integer,Map<String,List<List<String>>>> extractTextForTable(Map<String,Rectangle> regionArea,
                                                                       String wordSeparator,
                                                                       int... pageIndexes)

表格提取文本

注：单行单列

Parameters:

regionArea - 区域

wordSeparator - 单词分隔符

pageIndexes - 页面索引

Returns:

返回文本字典

一级，key = 页面索引，value = 提取文本字典

二级，key = 区域名称，value = 提取文本

extractImage

public Map<Integer,List<BufferedImage>> extractImage(int... pageIndexes)

提取图像

Parameters:

pageIndexes - 页面索引

Returns:

返回文本字典

key = 页面索引，value = 提取图像

extractFormText

public Map<String,String> extractFormText()

表单提取文本

Returns:

返回文本字典

key = 字段名称，value = 提取文本

extractFormImage

public Map<String,BufferedImage> extractFormImage()

表单提取图像

Returns:

返回图像字典

key = 字段名称，value = 提取图像

extractFormField

public Map<String,org.apache.pdfbox.pdmodel.interactive.form.PDField> extractFormField()

表单提取字段

Returns:

返回字段字典

key = 字段名称，value = 提取字段

extractComment

public Map<Integer,List<String>> extractComment(int... pageIndexes)

提取评论

Parameters:

pageIndexes - 页面索引

Returns:

返回文本字典

key=页面索引，value=提取评论

extractCommentByRegex

public Map<Integer,List<String>> extractCommentByRegex(String regex,
                                                       int... pageIndexes)

正则提取评论

Parameters:

regex - 正则表达式

pageIndexes - 页面索引

Returns:

返回文本字典

key=页面索引，value=提取评论

extractBookmark

public Map<Integer,org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem> extractBookmark(int... bookmarkIndexes)

提取书签

Parameters:

bookmarkIndexes - 书签索引

Returns:

返回书签字典

key=书签索引，value=提取书签

close

public void close()

关闭

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable