PDFBox - Propriétés du document

Comme les autres fichiers, un document PDF possède également des propriétés de document. Ces propriétés sont des paires clé-valeur. Chaque propriété donne des informations particulières sur le document.

Voici les propriétés d'un document PDF -

S.No.	Propriété et description
1	File Cette propriété contient le nom du fichier.
2	Title En utilisant cette propriété, vous pouvez définir le titre du document.
3	Author À l'aide de cette propriété, vous pouvez définir le nom de l'auteur du document.
4	Subject En utilisant cette propriété, vous pouvez spécifier le sujet du document PDF.
5	Keywords En utilisant cette propriété, vous pouvez lister les mots-clés avec lesquels nous pouvons rechercher le document.
6	Created À l'aide de cette propriété, vous pouvez définir la date de création du document.
sept	Modified Grâce à cette propriété, vous pouvez définir la date de modification du document.
8	Application À l'aide de cette propriété, vous pouvez définir l'application du document.

Voici une capture d'écran du tableau des propriétés du document d'un document PDF.

Définition des propriétés du document

PDFBox vous fournit une classe nommée PDDocumentInformation. Cette classe a un ensemble de méthodes setter et getter.

Les méthodes setter de cette classe sont utilisées pour définir des valeurs sur diverses propriétés d'un document et les méthodes getter qui sont utilisées pour récupérer ces valeurs.

Voici les méthodes de pose du PDDocumentInformation classe.

S.No.	Méthode et description
1	setAuthor(String author) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé Author.
2	setTitle(String title) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé Title.
3	setCreator(String creator) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé Creator.
4	setSubject(String subject) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé Subject.
5	setCreationDate(Calendar date) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé CreationDate.
6	setModificationDate(Calendar date) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé ModificationDate.
sept	setKeywords(String keywords list) Cette méthode est utilisée pour définir la valeur de la propriété du document PDF nommé Keywords.

Exemple

PDFBox fournit une classe appelée PDDocumentInformationet cette classe fournit diverses méthodes. Ces méthodes peuvent définir diverses propriétés du document et les récupérer.

Cet exemple montre comment ajouter des propriétés telles que Author, Title, Date, and Subjectà un document PDF. Ici, nous allons créer un document PDF nommédoc_attributes.pdf, ajoutez-y divers attributs et enregistrez-le dans le chemin C:/PdfBox_Examples/. Enregistrez ce code dans un fichier avec un nomAddingAttributes.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();

   }
}

Compilez et exécutez le fichier Java enregistré à partir de l'invite de commande à l'aide des commandes suivantes.

javac AddingAttributes.java 
java AddingAttributes

Lors de l'exécution, le programme ci-dessus ajoute tous les attributs spécifiés au document affichant le message suivant.

Properties added successfully

Maintenant, si vous visitez le chemin donné, vous pouvez trouver le PDF qui y est créé. Cliquez avec le bouton droit sur le document et sélectionnez l'option des propriétés du document comme indiqué ci-dessous.

Cela vous donnera la fenêtre des propriétés du document et ici vous pouvez observer que toutes les propriétés du document ont été définies sur des valeurs spécifiées.

Récupération des propriétés du document

Vous pouvez récupérer les propriétés d'un document à l'aide du getter méthodes fournies par le PDDocumentInformation classe.

Voici les méthodes getter du PDDocumentInformation classe.

S.No.	Méthode et description
1	getAuthor() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé Author.
2	getTitle() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé Title.
3	getCreator() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé Creator.
4	getSubject() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé Subject.
5	getCreationDate() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé CreationDate.
6	getModificationDate() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé ModificationDate.
sept	getKeywords() Cette méthode est utilisée pour récupérer la valeur de la propriété du document PDF nommé Keywords.

Exemple

Cet exemple montre comment récupérer les propriétés d'un document PDF existant. Ici, nous allons créer un programme Java et charger le document PDF nommédoc_attributes.pdf, qui est enregistré dans le chemin C:/PdfBox_Examples/et récupérez ses propriétés. Enregistrez ce code dans un fichier avec un nomRetrivingDocumentAttributes.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();        
   }  
}

Compilez et exécutez le fichier Java enregistré à partir de l'invite de commande à l'aide des commandes suivantes.

javac RetrivingDocumentAttributes.java 
java RetrivingDocumentAttributes

Lors de l'exécution, le programme ci-dessus récupère tous les attributs du document et les affiche comme indiqué ci-dessous.

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