PDFBox - Właściwości dokumentu

Podobnie jak inne pliki, dokument PDF również ma właściwości dokumentu. Te właściwości są parami klucz-wartość. Każda właściwość zawiera szczegółowe informacje o dokumencie.

Poniżej przedstawiono właściwości dokumentu PDF -

S.No.	Właściwość i opis
1	File Ta właściwość zawiera nazwę pliku.
2	Title Korzystając z tej właściwości, możesz ustawić tytuł dokumentu.
3	Author Korzystając z tej właściwości, możesz ustawić nazwisko autora dokumentu.
4	Subject Korzystając z tej właściwości, możesz określić temat dokumentu PDF.
5	Keywords Korzystając z tej właściwości, możesz wyświetlić listę słów kluczowych, za pomocą których możemy przeszukiwać dokument.
6	Created Korzystając z tej właściwości, możesz ustawić datę utworzenia dokumentu.
7	Modified Korzystając z tej właściwości, możesz ustawić datę modyfikacji dokumentu.
8	Application Korzystając z tej właściwości, można ustawić aplikację dokumentu.

Poniżej znajduje się zrzut ekranu tabeli właściwości dokumentu PDF.

Ustawianie właściwości dokumentu

PDFBox udostępnia klasę o nazwie PDDocumentInformation. Ta klasa ma zestaw metod ustawiających i pobierających.

Metody ustawiające tej klasy służą do ustawiania wartości różnych właściwości dokumentu i metod pobierających, które są używane do pobierania tych wartości.

Poniżej przedstawiono metody ustawiające PDDocumentInformation klasa.

S.No.	Metoda i opis
1	setAuthor(String author) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie Author.
2	setTitle(String title) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie Title.
3	setCreator(String creator) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie Creator.
4	setSubject(String subject) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie Subject.
5	setCreationDate(Calendar date) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie CreationDate.
6	setModificationDate(Calendar date) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie ModificationDate.
7	setKeywords(String keywords list) Ta metoda służy do ustawiania wartości właściwości dokumentu PDF o nazwie Keywords.

Przykład

PDFBox udostępnia klasę o nazwie PDDocumentInformationa ta klasa udostępnia różne metody. Te metody mogą ustawiać różne właściwości dokumentu i je pobierać.

W tym przykładzie pokazano, jak dodać właściwości, takie jak Author, Title, Date, and Subjectdo dokumentu PDF. Tutaj utworzymy dokument PDF o nazwiedoc_attributes.pdf, dodaj do niego różne atrybuty i zapisz go w ścieżce C:/PdfBox_Examples/. Zapisz ten kod w pliku o nazwieAddingAttributes.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();

   }
}

Skompiluj i uruchom zapisany plik Java z wiersza poleceń, używając następujących poleceń.

javac AddingAttributes.java 
java AddingAttributes

Po wykonaniu powyższy program dodaje wszystkie określone atrybuty do dokumentu wyświetlając następujący komunikat.

Properties added successfully

Teraz, jeśli odwiedzisz podaną ścieżkę, możesz znaleźć utworzony w niej plik PDF. Kliknij dokument prawym przyciskiem myszy i wybierz opcję właściwości dokumentu, jak pokazano poniżej.

Spowoduje to wyświetlenie okna właściwości dokumentu, w którym możesz zaobserwować, że wszystkie właściwości dokumentu zostały ustawione na określone wartości.

Pobieranie właściwości dokumentu

Możesz pobrać właściwości dokumentu za pomocą getter metody dostarczane przez PDDocumentInformation klasa.

Poniżej przedstawiono metody pobierania PDDocumentInformation klasa.

S.No.	Metoda i opis
1	getAuthor() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie Author.
2	getTitle() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie Title.
3	getCreator() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie Creator.
4	getSubject() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie Subject.
5	getCreationDate() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie CreationDate.
6	getModificationDate() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie ModificationDate.
7	getKeywords() Ta metoda służy do pobierania wartości właściwości dokumentu PDF o nazwie Keywords.

Przykład

Ten przykład pokazuje, jak pobrać właściwości istniejącego dokumentu PDF. Tutaj utworzymy program Java i załadujemy dokument PDF o nazwiedoc_attributes.pdf, który jest zapisywany w ścieżce C:/PdfBox_Examples/i pobrać jego właściwości. Zapisz ten kod w pliku o nazwieRetrivingDocumentAttributes.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();        
   }  
}

Skompiluj i uruchom zapisany plik Java z wiersza poleceń, używając następujących poleceń.

javac RetrivingDocumentAttributes.java 
java RetrivingDocumentAttributes

Po wykonaniu powyższy program pobiera wszystkie atrybuty dokumentu i wyświetla je, jak pokazano poniżej.

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