Package com.pd4ml.pdf

Class PdfDocumentBase

java.lang.Object

com.pd4ml.pdf.PdfDocumentBase

Direct Known Subclasses:

PdfDocument

public abstract class PdfDocumentBase
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
com.pd4ml.pdf.parser.PdfDoc	pdf

Constructor Summary

Constructors

Constructor	Description
PdfDocumentBase(byte[] bytes, String password)
PdfDocumentBase(InputStream stream, String password)
PdfDocumentBase(URL url, String password)

Method Summary

Modifier and Type	Method	Description
void	append(PdfDocumentBase toMerge)
static boolean[]	computeScope(String scope, int pageNum)	Utility method converts page scope description to a boolean array of flags.
int	deletePage(int pageNumber)	deletes a page of a loaded document.
String	dumpOutlines()
String	getAuthor()
String	getCreationDate()
String	getCreator()
String	getKeywords()
String	getMetadata()
String	getModDate()
int	getNumberOfPages()
float[]	getPageBox(int pageIndex, String boxName)	returns PDF page boundaries array.
String	getPageContent(int pageIndex)
PageSize	getPageSize(int pageIndex)	returns page size
String	getPdfFormatVersion()
int	getPermissions()
String	getProducer()
String	getSubject()
String	getTitle()
void	overlay(PdfDocumentBase anotherDoc, int opacity)
void	overlay(PdfDocumentBase anotherDoc, String srcScope, String destScope, int opacity)
void	read()	reads and parses given PDF document stream
void	setAuthor(String author)
void	setCreator(String creator)
void	setKeywords(String keywords)
void	setModDate()	sets the document modification date to "now"
void	setSubject(String subject)
void	setTitle(String title)
void	underlay(PdfDocumentBase anotherDoc, int opacity)
void	underlay(PdfDocumentBase anotherDoc, String srcScope, String destScope, int opacity)
void	write(OutputStream out)	writes current PDF document state to given output stream.
void	write(OutputStream out, String password, int permissions)	writes current PDF document state to given output stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pdf

public com.pd4ml.pdf.parser.PdfDoc pdf

Constructor Detail

PdfDocumentBase

public PdfDocumentBase(byte[] bytes,
                       String password)
                throws InvokeException

Parameters:

bytes - PDF document as an array of bytes

password - if any. "null" for not protected PDF documents

Throws:

InvokeException - by invalid call parameters

PdfDocumentBase

public PdfDocumentBase(InputStream stream,
                       String password)
                throws InvokeException

Parameters:

stream - PDF document input stream

password - if any. "null" for not protected PDF documents

Throws:

InvokeException - by invalid call parameters

PdfDocumentBase

public PdfDocumentBase(URL url,
                       String password)
                throws InvokeException

Parameters:

url - PDF document URL

password - if any. "null" for not protected PDF documents

Throws:

InvokeException - by invalid call parameters

Method Detail

write

public void write(OutputStream out)
           throws IOException,
                  InvokeException

writes current PDF document state to given output stream.

Parameters:

out - an output stream to write to

Throws:

IOException - write errors

InvokeException - if the document is already appended to another one (document objects reassigned to another root).

write

public void write(OutputStream out,
                  String password,
                  int permissions)
           throws IOException,
                  InvokeException,
                  InvalidPasswordException

writes current PDF document state to given output stream.

Parameters:

out - an output stream to write to

password - password string. null if no password to be applied

permissions - PDF file access permissions See PD4Constants.Allow* constants. Example AllowAnnotate | AllowDegradedPrint. Use PD4Constants#DefaultPermissions for defaults.

Throws:

IOException - write errors

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - if the document is already appended to another one (document objects reassigned to another root).

See Also:

Constants.DefaultPermissions

append

public void append(PdfDocumentBase toMerge)
            throws IOException

Parameters:

toMerge - another PDF document to append to the current one. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - by an attempt to merge with more than one document

overlay

public void overlay(PdfDocumentBase anotherDoc,
                    int opacity)
             throws IOException

Parameters:

anotherDoc - another PDF document whose page content is to be combined with the pages of the current document. Implicitly invokes read() if has not been triggered before. The method applies all pages of anotherDoc to all pages of this doc.

opacity - transparency of the overlay: 0 = fully transparent, 255 (or any negative value) = opaque

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - by an attempt to merge with more than one document

See Also:

computeScope(String, int)

overlay

public void overlay(PdfDocumentBase anotherDoc,
                    String srcScope,
                    String destScope,
                    int opacity)
             throws IOException

Parameters:

anotherDoc - another PDF document whose page content is to be combined with the pages of the current document. Implicitly invokes read() if has not been triggered before.

srcScope - a page range of an overlay document to use.

destScope - a page range in the current document the overlay is to apply to.

opacity - transparency of the overlay: 0 = fully transparent, 255 (or any negative value) = opaque

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - by an attempt to merge with more than one document

See Also:

computeScope(String, int)

underlay

public void underlay(PdfDocumentBase anotherDoc,
                     int opacity)
              throws IOException

Parameters:

anotherDoc - another PDF document whose page content is to be placed under of the current document content. Implicitly invokes read() if has not been triggered before. The method applies all pages of anotherDoc to all pages of this doc.

opacity - transparency of the overlay: 0 = fully transparent, 255 (or any negative value) = opaque

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - by an attempt to merge with more than one document

See Also:

computeScope(String, int)

underlay

public void underlay(PdfDocumentBase anotherDoc,
                     String srcScope,
                     String destScope,
                     int opacity)
              throws IOException

Parameters:

anotherDoc - another PDF document whose page content is to be placed under of the current document content. Implicitly invokes read() if has not been triggered before.

srcScope - a page range of an underlay document to use.

destScope - a page range in the current document the underlay is to apply to.

opacity - transparency of the overlay: 0 = fully transparent, 255 (or any negative value) = opaque

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

InvokeException - by an attempt to merge with more than one document

See Also:

computeScope(String, int)

getNumberOfPages

public int getNumberOfPages()
                     throws IOException,
                            InvalidPasswordException

Returns:

returns a number of pages in the current PDF. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getPermissions

public int getPermissions()
                   throws IOException,
                          InvalidPasswordException

Returns:

returns permissions flag of the document

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getTitle

public String getTitle()
                throws IOException,
                       InvalidPasswordException

Returns:

PDF "Title" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setTitle

public void setTitle(String title)
              throws IOException,
                     InvalidPasswordException

Parameters:

title - new document title. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getAuthor

public String getAuthor()
                 throws IOException,
                        InvalidPasswordException

Returns:

PDF "Author" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setAuthor

public void setAuthor(String author)
               throws IOException

Parameters:

author - a value to override document "Author" name. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getPdfFormatVersion

public String getPdfFormatVersion()
                           throws IOException,
                                  InvalidPasswordException

Returns:

PDF format version from PDF document prefix.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getMetadata

public String getMetadata()
                   throws IOException,
                          InvalidPasswordException

Returns:

PDF medatata as an XMP XML string. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getCreationDate

public String getCreationDate()
                       throws IOException,
                              InvalidPasswordException

Returns:

PDF creation date as a string. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

dumpOutlines

public String dumpOutlines()
                    throws IOException,
                           InvalidPasswordException

Returns:

dumps document outline (bookmark) structure. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getKeywords

public String getKeywords()
                   throws IOException,
                          InvalidPasswordException

Returns:

PDF "Keywords" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setKeywords

public void setKeywords(String keywords)
                 throws IOException,
                        InvalidPasswordException

Parameters:

keywords - a value to override document "Keywords" string. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getCreator

public String getCreator()
                  throws IOException,
                         InvalidPasswordException

Returns:

PDF "Creator" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setCreator

public void setCreator(String creator)
                throws IOException,
                       InvalidPasswordException

Parameters:

creator - a value to override document "Creator" name. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getProducer

public String getProducer()
                   throws IOException,
                          InvalidPasswordException

Returns:

PDF "Producer" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getSubject

public String getSubject()
                  throws IOException,
                         InvalidPasswordException

Returns:

PDF "Subject" metadata value (if any). Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setSubject

public void setSubject(String subject)
                throws IOException,
                       InvalidPasswordException

Parameters:

subject - a value to override document "Subject" string. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

setModDate

public void setModDate()
                throws IOException,
                       InvalidPasswordException

sets the document modification date to "now"

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getModDate

public String getModDate()
                  throws IOException,
                         InvalidPasswordException

Returns:

Document modification date. Implicitly invokes read() if has not been triggered before.

Throws:

IOException - reflects a variety of PDF read/parse errors by read()

InvalidPasswordException - invalid password given to the object constructor, i.e. PdfDocumentBase(byte[], String).

getPageSize

public PageSize getPageSize(int pageIndex)
                     throws InvalidPasswordException,
                            IOException

returns page size

Parameters:

pageIndex - page number (starting from 1)

Returns:

page size object

Throws:

InvalidPasswordException - thrown for encrypted documents in a case given password does not match

IOException - general document read exception

getPageBox

public float[] getPageBox(int pageIndex,
                          String boxName)
                   throws InvalidPasswordException,
                          IOException

returns PDF page boundaries array.

Parameters:

boxName - "ArtBox", "BleedBox", "TrimBox" – used for printing; "MediaBox" – target paper size, i.e., finished size of printed document; "CropBox" – page visible in the viewer, i.e., what the user sees on the screen; "BBox" – the bounds of the actual content on the page

pageIndex - page number (starting from 1)

Returns:

array of four numbers

Throws:

InvalidPasswordException - thrown for encrypted documents in a case given password does not match

IOException - general document read exception

read

public void read()
          throws IOException,
                 InvokeException,
                 InvalidPasswordException

reads and parses given PDF document stream

Throws:

IOException - read/parsing errors

InvokeException - PDF parsing specific errors

InvalidPasswordException - PDF encryption password do not match

getPageContent

public String getPageContent(int pageIndex)
                      throws InvalidPasswordException,
                             IOException

Parameters:

pageIndex - page number (0 is the first page)

Returns:

page content stream

Throws:

IOException - read/parsing errors

InvalidPasswordException - PDF encryption password do not match

deletePage

public int deletePage(int pageNumber)
               throws InvalidPasswordException,
                      IOException

deletes a page of a loaded document. If the document has only one page or not existent page number is given, the method call takes no effect.

Parameters:

pageNumber - index of page to delete (first page is 1)

Returns:

number of pages remain in the doc.

Throws:

IOException - read/parsing errors

InvalidPasswordException - PDF encryption password do not match

computeScope

public static boolean[] computeScope(String scope,
                                     int pageNum)

Utility method converts page scope description to a boolean array of flags. "true" = page number matches the scope, "false" = does not. Note: in scope definition the first page is "1"; it corresponds to '0" index in the returned array.

Parameters:

scope - "null" = all pages. Allowed syntax: "1", "3-5", "2+", "last", "even", "odd", "1+,skiplast", "5+,even"

pageNum - number of pages

Returns:

an array of scope match flags. Each array item corresponds a page.