com.qoppa.pdfPreflight.results

Interface PreflightResults

public interface PreflightResults

Interface representing the results of a preflight operation on a document. The results contain information about the document, the preflight run and a list of ResultRecord objects that detail each issue found in the document. Also provides various forms of processing the results that include adding the results as annotations to the document, saving the results as a report, and appending the report to the document that was preflighted.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
void	addResultAnnotations() Deprecated. - use PDFPreflight.addResultAnnotations(PreflightResults)
void	appendPreflightReport(int pageWidth, int pageHeight) Deprecated. - use PDFPreflight.appendPreflightReport(PreflightResults, int, int, PreflightReportOptions)
void	echoResults() Echoes the result records to the console.
void	echoResults(PrintStream out) Echos the result records to a given print stream.
DocumentInfo	getDocumentInfo() Deprecated. - use PDFPreflight.getDocumentInfo()
PreflightInfo	getPFInfo() Returns a PreflightInfo object that holds information about the preflight run that created this results.
List<ResultRecord>	getResults() Gets a list of result records.
boolean	isSuccessful() Returns a boolean value indicating whether the document that was preflighted successfully passed the given Profile specification.
void	savePreflightReport(OutputStream outStream, int pageWidth, int pageHeight) Deprecated. - use PreflightResults.savePreflightReport(OutputStream, int, int, PreflightReportOptions)
void	savePreflightReport(OutputStream outStream, int pageWidth, int pageHeight, PreflightReportOptions reportOptions) Saves a Preflight report as a PDF document to an OutputStream.
void	savePreflightReport(String fileName, int pageWidth, int pageHeight) Deprecated. - use PreflightResults.savePreflightReport(String, int, int, PreflightReportOptions)
void	savePreflightReport(String fileName, int pageWidth, int pageHeight, PreflightReportOptions reportOptions) Saves a Preflight report as a PDF document to a file.

Method Detail

getResults

List<ResultRecord> getResults()

Gets a list of result records. Objects in the list are of type ResultRecord.

Returns:

A list of result records.

echoResults

void echoResults()

Echoes the result records to the console.

echoResults

void echoResults(PrintStream out)

Echos the result records to a given print stream.

Parameters:

out - The output print stream to echo the results to.

getPFInfo

PreflightInfo getPFInfo()

Returns a PreflightInfo object that holds information about the preflight run that created this results.

Returns:

A PreflightInfo object that provides information about the preflight engine.

getDocumentInfo

@Deprecated
DocumentInfo getDocumentInfo()

Deprecated. - use PDFPreflight.getDocumentInfo()

Gets the information for the document that was preflighted.

Returns:

The document information object.

isSuccessful

boolean isSuccessful()

Returns a boolean value indicating whether the document that was preflighted successfully passed the given Profile specification.

Returns:

A boolean indicating the success of the preflight execution.

addResultAnnotations

@Deprecated
void addResultAnnotations()
                                throws PDFException

Deprecated. - use PDFPreflight.addResultAnnotations(PreflightResults)

Adds the ResultRecords as Annotations to the document that was preflighted.

Throws:

PDFException

appendPreflightReport

@Deprecated
void appendPreflightReport(int pageWidth,
                                        int pageHeight)
                                 throws PDFException,
                                        IOException

Deprecated. - use PDFPreflight.appendPreflightReport(PreflightResults, int, int, PreflightReportOptions)

Appends the Preflight report to the document that was preflighted.

Parameters:

pageWidth - Width of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in standard US Letter page would have a width of 612, and a 210 mm x 297 mm standard European A4 page would have a width of 595.

pageHeight - Height of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in standard US Letter page would have a height of 792, and a 210 mm x 297 mm standard European A4 page would have a height of 842.

Throws:

IOException

PDFException

savePreflightReport

void savePreflightReport(OutputStream outStream,
                         int pageWidth,
                         int pageHeight)
                  throws PDFException,
                         IOException

Deprecated. - use PreflightResults.savePreflightReport(OutputStream, int, int, PreflightReportOptions)

Saves a Preflight report as a PDF document to an OutputStream.

Parameters:

outStream - OutputStream where the report document will be written to.

pageWidth - Width of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a width of 612, and a 210 mm x 297 mm standard European A4 page would have a width of 595.

pageHeight - Height of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a height of 792, and a 210 mm x 297 mm standard European A4 page would have a height of 842.

Throws:

IOException

PDFException

savePreflightReport

void savePreflightReport(OutputStream outStream,
                         int pageWidth,
                         int pageHeight,
                         PreflightReportOptions reportOptions)
                  throws PDFException,
                         IOException

Saves a Preflight report as a PDF document to an OutputStream.

Parameters:

outStream - OutputStream where the report document will be written to.

pageWidth - Width of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a width of 612, and a 210 mm x 297 mm standard European A4 page would have a width of 595.

pageHeight - Height of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a height of 792, and a 210 mm x 297 mm standard European A4 page would have a height of 842.

reportOptions - PreflightReportOptions that determine the format of what to include in the report

Throws:

IOException

PDFException

savePreflightReport

void savePreflightReport(String fileName,
                         int pageWidth,
                         int pageHeight)
                  throws PDFException,
                         IOException

Deprecated. - use PreflightResults.savePreflightReport(String, int, int, PreflightReportOptions)

Saves a Preflight report as a PDF document to a file.

Parameters:

fileName - Name of the file to save the document.

pageWidth - Width of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a width of 612, and a 210 mm x 297 mm standard European A4 page would have a width of 595.

pageHeight - Height of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a height of 792, and a 210 mm x 297 mm standard European A4 page would have a height of 842.

Throws:

IOException

PDFException

savePreflightReport

void savePreflightReport(String fileName,
                         int pageWidth,
                         int pageHeight,
                         PreflightReportOptions reportOptions)
                  throws PDFException,
                         IOException

Saves a Preflight report as a PDF document to a file.

Parameters:

fileName - Name of the file to save the document.

pageWidth - Width of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a width of 612, and a 210 mm x 297 mm standard European A4 page would have a width of 595.

pageHeight - Height of the report pages, in points. Points are defined to be 72 DPI so an 8.5 in x 11 in page would have a height of 792, and a 210 mm x 297 mm standard European A4 page would have a height of 842.

reportOptions - PreflightReportOptions that determine the format of what to include in the report

Throws:

IOException

PDFException