Package org.jpedal.examples.images

Class ExtractClippedImages

java.lang.Object

org.jpedal.examples.images.ExtractClippedImages

public class ExtractClippedImages
extends Object

Clipped Image Extraction from PDF files

This class provides a simple Java API to extract clipped images from a PDF file and also a static convenience method if you just want to dump all the images from a PDF file or directory containing PDF files at a set of sizes

See our support pages for more information on extracting images.

Constructor Summary

Constructors

Constructor	Description
ExtractClippedImages(byte[] byteArray)	Sets up an ExtractClippedImages instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractClippedImages(String fileName)	Sets up an ExtractClippedImages instance to open a PDF File

Method Summary

Modifier and Type	Method	Description
void	closePDFfile()	ensure PDF file is closed once no longer needed and all resources released
BufferedImage	getClippedImage(int page, int imageNumber)	extract any image from any page - recommended you process images on each page in turn as quicker
int	getImageCount(int page)	returns an image count for the selected page
int	getPageCount()	number of pages in PDF file (starting at 1)
static void	main(String[] args)	main routine which checks for any files passed and runs the demo
boolean	openPDFFile()	routine to open the PDF File so we can access - needs to be checked as will be false if file cannot be opened for any reason
void	setPassword(String password)	sets the Owner or User Password to use when opening encrypted PDF file
static void	writeAllClippedImagesToDirs(String inputDir, String outDir, String imageType, String[] subDirs)	Convenience method to Extract all the images in a directory of PDF files
static void	writeAllClippedImagesToDirs(String inputDir, String password, String outDir, String imageType, String[] subDirs)	Convenience method to Extract all the images in a directory of PDF files
static void	writeAllClippedImagesToDirs(String inputDir, String password, String outDir, String imageType, String[] subDirs, ErrorTracker errorTracker)	Convenience method to Extract all the images in a directory of PDF files

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractClippedImages

public ExtractClippedImages(String fileName)

Sets up an ExtractClippedImages instance to open a PDF File

Parameters:

fileName - full path to a single PDF file

ExtractClippedImages

public ExtractClippedImages(byte[] byteArray)

Sets up an ExtractClippedImages instance to open a PDF file contained as a BLOB within a byte[] stream

Parameters:

byteArray - pdf file data

Method Details

getClippedImage

public BufferedImage getClippedImage(int page,
 int imageNumber)
                              throws PdfException

extract any image from any page - recommended you process images on each page in turn as quicker

Parameters:

page - logical page number (1 is first page)

imageNumber - image on page (0 is first image)

Returns:

BufferedImage

Throws:

PdfException - PdfException

writeAllClippedImagesToDirs

public static void writeAllClippedImagesToDirs(String inputDir,
 String password,
 String outDir,
 String imageType,
 String[] subDirs,
 ErrorTracker errorTracker)
                                        throws PdfException

Convenience method to Extract all the images in a directory of PDF files

Parameters:

inputDir - directory of input files

password - password to open PDF files

outDir - directory of output files

imageType - 3 letter value for image format to be used

subDirs - sub directory of files

errorTracker - a custom error tracker

Throws:

PdfException - PdfException

writeAllClippedImagesToDirs

public static void writeAllClippedImagesToDirs(String inputDir,
 String password,
 String outDir,
 String imageType,
 String[] subDirs)
                                        throws PdfException

Convenience method to Extract all the images in a directory of PDF files

Parameters:

inputDir - directory of input files

password - password to open PDF files

outDir - directory of output files

imageType - 3 letter value for image format to be used

subDirs - sub directory of files

Throws:

PdfException - PdfException

writeAllClippedImagesToDirs

public static void writeAllClippedImagesToDirs(String inputDir,
 String outDir,
 String imageType,
 String[] subDirs)
                                        throws PdfException

Convenience method to Extract all the images in a directory of PDF files

Parameters:

inputDir - directory of input files

outDir - directory of output files

imageType - 3 letter value for image format to be used

subDirs - sub directory of files

Throws:

PdfException - PdfException

main

public static void main(String[] args)

main routine which checks for any files passed and runs the demo

Parameters:

args - arguments

getImageCount

public int getImageCount(int page)
                  throws PdfException

returns an image count for the selected page

Parameters:

page - logical page number

Returns:

int number of images (0 if no images)

Throws:

PdfException - PdfException

setPassword

public void setPassword(String password)

sets the Owner or User Password to use when opening encrypted PDF file

Parameters:

password - the USER or OWNER password for the PDF file

getPageCount

public int getPageCount()

number of pages in PDF file (starting at 1)

Returns:

page count

openPDFFile

public boolean openPDFFile()
                    throws PdfException

routine to open the PDF File so we can access - needs to be checked as will be false if file cannot be opened for any reason

Returns:

true if successful

Throws:

PdfException - is problem opening file

closePDFfile

public void closePDFfile()

ensure PDF file is closed once no longer needed and all resources released