Java Doc for PDDocumentInformation.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.PDDocumentInformation

PDDocumentInformation
public class PDDocumentInformation implements COSObjectable(Code)
This is the document metadata. Each getXXX method will return the entry if it exists or null if it does not exist. If you pass in null for the setXXX method then it will clear the value.
author:
   Ben Litchfield
version:
   $Revision: 1.12 $



Constructor Summary
public  PDDocumentInformation()
     Default Constructor.
public  PDDocumentInformation(COSDictionary dic)
     Constructor that is used for a preexisting dictionary.

Method Summary
public  StringgetAuthor()
     This will get the author of the document.
public  COSBasegetCOSObject()
     Convert this standard java object to a COS object.
public  CalendargetCreationDate()
     This will get the creation date of the document.
public  StringgetCreator()
     This will get the creator of the document.
public  StringgetCustomMetadataValue(String fieldName)
     This will get the value of a custom metadata information field for the document. This will return null if one is not found.
Parameters:
  fieldName - Name of custom metadata field from pdf document.
public  COSDictionarygetDictionary()
     This will get the underlying dictionary that this object wraps.
public  StringgetKeywords()
     This will get the keywords of the document.
public  CalendargetModificationDate()
     This will get the modification date of the document.
public  StringgetProducer()
     This will get the producer of the document.
public  StringgetSubject()
     This will get the subject of the document.
public  StringgetTitle()
     This will get the title of the document.
public  StringgetTrapped()
     This will get the trapped value for the document.
public  voidsetAuthor(String author)
     This will set the author of the document.
public  voidsetCreationDate(Calendar date)
     This will set the creation date of the document.
public  voidsetCreator(String creator)
     This will set the creator of the document.
public  voidsetCustomMetadataValue(String fieldName, String fieldValue)
     Set the custom metadata value.
public  voidsetKeywords(String keywords)
     This will set the keywords of the document.
public  voidsetModificationDate(Calendar date)
     This will set the modification date of the document.
public  voidsetProducer(String producer)
     This will set the producer of the document.
public  voidsetSubject(String subject)
     This will set the subject of the document.
public  voidsetTitle(String title)
     This will set the title of the document.
public  voidsetTrapped(String value)
     This will set the trapped of the document.


Constructor Detail
PDDocumentInformation
public PDDocumentInformation()(Code)
Default Constructor.



PDDocumentInformation
public PDDocumentInformation(COSDictionary dic)(Code)
Constructor that is used for a preexisting dictionary.
Parameters:
  dic - The underlying dictionary.




Method Detail
getAuthor
public String getAuthor()(Code)
This will get the author of the document. This will return null if no author exists. The author of the document.



getCOSObject
public COSBase getCOSObject()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getCreationDate
public Calendar getCreationDate() throws IOException(Code)
This will get the creation date of the document. This will return null if no creation date exists. The creation date of the document.
throws:
  IOException - If there is an error creating the date.



getCreator
public String getCreator()(Code)
This will get the creator of the document. This will return null if no creator exists. The creator of the document.



getCustomMetadataValue
public String getCustomMetadataValue(String fieldName)(Code)
This will get the value of a custom metadata information field for the document. This will return null if one is not found.
Parameters:
  fieldName - Name of custom metadata field from pdf document. String Value of metadata field
author:
   Gerardo Ortiz



getDictionary
public COSDictionary getDictionary()(Code)
This will get the underlying dictionary that this object wraps. The underlying info dictionary.



getKeywords
public String getKeywords()(Code)
This will get the keywords of the document. This will return null if no keywords exists. The keywords of the document.



getModificationDate
public Calendar getModificationDate() throws IOException(Code)
This will get the modification date of the document. This will return null if no modification date exists. The modification date of the document.
throws:
  IOException - If there is an error creating the date.



getProducer
public String getProducer()(Code)
This will get the producer of the document. This will return null if no producer exists. The producer of the document.



getSubject
public String getSubject()(Code)
This will get the subject of the document. This will return null if no subject exists. The subject of the document.



getTitle
public String getTitle()(Code)
This will get the title of the document. This will return null if no title exists. The title of the document.



getTrapped
public String getTrapped()(Code)
This will get the trapped value for the document. This will return null if one is not found. The trapped value for the document.



setAuthor
public void setAuthor(String author)(Code)
This will set the author of the document.
Parameters:
  author - The new author for the document.



setCreationDate
public void setCreationDate(Calendar date)(Code)
This will set the creation date of the document.
Parameters:
  date - The new creation date for the document.



setCreator
public void setCreator(String creator)(Code)
This will set the creator of the document.
Parameters:
  creator - The new creator for the document.



setCustomMetadataValue
public void setCustomMetadataValue(String fieldName, String fieldValue)(Code)
Set the custom metadata value.
Parameters:
  fieldName - The name of the custom metadata field.
Parameters:
  fieldValue - The value to the custom metadata field.



setKeywords
public void setKeywords(String keywords)(Code)
This will set the keywords of the document.
Parameters:
  keywords - The new keywords for the document.



setModificationDate
public void setModificationDate(Calendar date)(Code)
This will set the modification date of the document.
Parameters:
  date - The new modification date for the document.



setProducer
public void setProducer(String producer)(Code)
This will set the producer of the document.
Parameters:
  producer - The new producer for the document.



setSubject
public void setSubject(String subject)(Code)
This will set the subject of the document.
Parameters:
  subject - The new subject for the document.



setTitle
public void setTitle(String title)(Code)
This will set the title of the document.
Parameters:
  title - The new title for the document.



setTrapped
public void setTrapped(String value)(Code)
This will set the trapped of the document. This will be 'True', 'False', or 'Unknown'.
Parameters:
  value - The new trapped value for the document.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.