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.
getAuthor
public String getAuthor()
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()
Convert this standard java object to a COS object.
- getCOSObject in interface COSObjectable
- The cos object that matches this Java object.
getCreationDate
public Calendar getCreationDate()
throws IOException
This will get the creation date of the document. This will return null if no creation date exists.
- The creation date of the document.
getCreator
public String getCreator()
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)
This will get the value of a custom metadata information field for the document.
This will return null if one is not found.
fieldName
- Name of custom metadata field from pdf document.
- String Value of metadata field
getDictionary
public COSDictionary getDictionary()
This will get the underlying dictionary that this object wraps.
- The underlying info dictionary.
getKeywords
public String getKeywords()
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
This will get the modification date of the document. This will return null if no modification date exists.
- The modification date of the document.
getProducer
public String getProducer()
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()
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()
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()
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)
This will set the author of the document.
author
- The new author for the document.
setCreationDate
public void setCreationDate(Calendar date)
This will set the creation date of the document.
date
- The new creation date for the document.
setCreator
public void setCreator(String creator)
This will set the creator of the document.
creator
- The new creator for the document.
setCustomMetadataValue
public void setCustomMetadataValue(String fieldName,
String fieldValue)
Set the custom metadata value.
fieldName
- The name of the custom metadata field.fieldValue
- The value to the custom metadata field.
setKeywords
public void setKeywords(String keywords)
This will set the keywords of the document.
keywords
- The new keywords for the document.
setModificationDate
public void setModificationDate(Calendar date)
This will set the modification date of the document.
date
- The new modification date for the document.
setProducer
public void setProducer(String producer)
This will set the producer of the document.
producer
- The new producer for the document.
setSubject
public void setSubject(String subject)
This will set the subject of the document.
subject
- The new subject for the document.
setTitle
public void setTitle(String title)
This will set the title of the document.
title
- The new title for the document.
setTrapped
public void setTrapped(String value)
This will set the trapped of the document. This will be
'True', 'False', or 'Unknown'.
value
- The new trapped value for the document.