PDFBox - 文档属性
与其他文件一样,PDF文档也具有文档属性。这些属性是键值对。每个属性都提供有关文档的特定信息。
以下是PDF文档的属性:
| 序号 | 属性及描述 |
|---|---|
| 1 | 文件 此属性保存文件的名称。 |
| 2 | 标题 使用此属性,您可以设置文档的标题。 |
| 3 | 作者 使用此属性,您可以设置文档的作者姓名。 |
| 4 | 主题 使用此属性,您可以指定PDF文档的主题。 |
| 5 | 关键词 使用此属性,您可以列出可以搜索文档的关键词。 |
| 6 | 创建日期 使用此属性,您可以设置文档的创建日期。 |
| 7 | 修改日期 使用此属性,您可以设置文档的修改日期。 |
| 8 | 应用程序 使用此属性,您可以设置文档的应用程序。 |
以下是PDF文档文档属性表的屏幕截图。(此处应插入截图)
设置文档属性
PDFBox提供了一个名为PDDocumentInformation的类。此类具有一组setter和getter方法。
此类的setter方法用于将值设置为文档的各种属性,getter方法用于检索这些值。
以下是PDDocumentInformation类的setter方法:
| 序号 | 方法及描述 |
|---|---|
| 1 | setAuthor(String author) 此方法用于设置名为Author的PDF文档属性的值。 |
| 2 | setTitle(String title) 此方法用于设置名为Title的PDF文档属性的值。 |
| 3 | setCreator(String creator) 此方法用于设置名为Creator的PDF文档属性的值。 |
| 4 | setSubject(String subject) 此方法用于设置名为Subject的PDF文档属性的值。 |
| 5 | setCreationDate(Calendar date) 此方法用于设置名为CreationDate的PDF文档属性的值。 |
| 6 | setModificationDate(Calendar date) 此方法用于设置名为ModificationDate的PDF文档属性的值。 |
| 7 | setKeywords(String keywords list) 此方法用于设置名为Keywords的PDF文档属性的值。 |
示例
PDFBox提供了一个名为PDDocumentInformation的类,此类提供各种方法。这些方法可以设置文档的各种属性并检索它们。
此示例演示如何向PDF文档添加作者、标题、日期和主题等属性。这里,我们将创建一个名为doc_attributes.pdf的PDF文档,向其中添加各种属性,并将其保存在C:/PdfBox_Examples/路径中。将此代码保存在名为AddingAttributes.java的文件中。
import java.io.IOException;
import java.util.Calendar;
import java.util.GregorianCalendar;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentInformation;
import org.apache.pdfbox.pdmodel.PDPage;
public class AddingDocumentAttributes {
public static void main(String args[]) throws IOException {
//Creating PDF document object
PDDocument document = new PDDocument();
//Creating a blank page
PDPage blankPage = new PDPage();
//Adding the blank page to the document
document.addPage( blankPage );
//Creating the PDDocumentInformation object
PDDocumentInformation pdd = document.getDocumentInformation();
//Setting the author of the document
pdd.setAuthor("Tutorialspoint");
// Setting the title of the document
pdd.setTitle("Sample document");
//Setting the creator of the document
pdd.setCreator("PDF Examples");
//Setting the subject of the document
pdd.setSubject("Example document");
//Setting the created date of the document
Calendar date = new GregorianCalendar();
date.set(2015, 11, 5);
pdd.setCreationDate(date);
//Setting the modified date of the document
date.set(2016, 6, 5);
pdd.setModificationDate(date);
//Setting keywords for the document
pdd.setKeywords("sample, first example, my pdf");
//Saving the document
document.save("C:/PdfBox_Examples/doc_attributes.pdf");
System.out.println("Properties added successfully ");
//Closing the document
document.close();
}
}
使用以下命令从命令提示符编译并执行保存的Java文件。(此处应插入编译运行命令)
javac AddingAttributes.java java AddingAttributes
执行后,上述程序将所有指定的属性添加到文档中,并显示以下消息。(此处应插入运行结果信息)
Properties added successfully
现在,如果您访问指定的路径,您可以在其中找到创建的PDF。右键单击文档并选择文档属性选项,如下所示。(此处应插入截图)
这将为您提供文档属性窗口,您可以在此处观察文档的所有属性是否已设置为指定的值。
检索文档属性
您可以使用PDDocumentInformation类提供的getter方法检索文档的属性。
以下是PDDocumentInformation类的getter方法:
| 序号 | 方法及描述 |
|---|---|
| 1 | getAuthor() 此方法用于检索名为Author的PDF文档属性的值。 |
| 2 | getTitle() 此方法用于检索名为Title的PDF文档属性的值。 |
| 3 | getCreator() 此方法用于检索名为Creator的PDF文档属性的值。 |
| 4 | getSubject() 此方法用于检索名为Subject的PDF文档属性的值。 |
| 5 | getCreationDate() 此方法用于检索名为CreationDate的PDF文档属性的值。 |
| 6 | getModificationDate() 此方法用于检索名为ModificationDate的PDF文档属性的值。 |
| 7 | getKeywords() 此方法用于检索名为Keywords的PDF文档属性的值。 |
示例
此示例演示如何检索现有PDF文档的属性。这里,我们将创建一个Java程序并加载保存在C:/PdfBox_Examples/路径中的名为doc_attributes.pdf的PDF文档,并检索其属性。将此代码保存在名为RetrivingDocumentAttributes.java的文件中。
import java.io.File;
import java.io.IOException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentInformation;
public class RetrivingDocumentAttributes {
public static void main(String args[]) throws IOException {
//Loading an existing document
File file = new File("C:/PdfBox_Examples/doc_attributes.pdf")
PDDocument document = PDDocument.load(file);
//Getting the PDDocumentInformation object
PDDocumentInformation pdd = document.getDocumentInformation();
//Retrieving the info of a PDF document
System.out.println("Author of the document is :"+ pdd.getAuthor());
System.out.println("Title of the document is :"+ pdd.getTitle());
System.out.println("Subject of the document is :"+ pdd.getSubject());
System.out.println("Creator of the document is :"+ pdd.getCreator());
System.out.println("Creation date of the document is :"+ pdd.getCreationDate());
System.out.println("Modification date of the document is :"+
pdd.getModificationDate());
System.out.println("Keywords of the document are :"+ pdd.getKeywords());
//Closing the document
document.close();
}
}
使用以下命令从命令提示符编译并执行保存的Java文件。(此处应插入编译运行命令)
javac RetrivingDocumentAttributes.java java RetrivingDocumentAttributes
执行后,上述程序检索文档的所有属性并显示它们,如下所示。(此处应插入运行结果信息)
Author of the document is :Tutorialspoint Title of the document is :Sample document Subject of the document is :Example document Creator of the document is :PDF Examples Creation date of the document is :11/5/2015 Modification date of the document is :6/5/2016 Keywords of the document are :sample, first example, my pdf