org.mapfish.print.output

Interface OutputFormat

All Known Implementing Classes:

AbstractJasperReportOutputFormat, JasperReportExcelOutputFormat, JasperReportImageOutputFormat, JasperReportPDFOutputFormat, MapExportOutputFormat

public interface OutputFormat

Interface for exporting the generated PDF from MapPrinter.

User: jeichar Date: Oct 18, 2010 Time: 1:49:41 PM

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType() The content type of the output.
java.lang.String	getFileSuffix() The file suffix to use when writing to a file.
Processor.ExecutionContext	print(java.lang.String jobId, PJsonObject spec, Configuration config, java.io.File configDir, java.io.File taskDirectory, java.io.OutputStream outputStream) Performs the print and writes to the report in the correct format to the outputStream.

Method Detail

getContentType

java.lang.String getContentType()

The content type of the output.

getFileSuffix

java.lang.String getFileSuffix()

The file suffix to use when writing to a file.

print

Processor.ExecutionContext print(java.lang.String jobId,
                                 PJsonObject spec,
                                 Configuration config,
                                 java.io.File configDir,
                                 java.io.File taskDirectory,
                                 java.io.OutputStream outputStream)
                          throws java.lang.Exception

Performs the print and writes to the report in the correct format to the outputStream.

Parameters:

jobId - the job ID

spec - the data from the client, required for writing.

config - the configuration object representing the server side configuration.

configDir - the directory that contains the configuration, used for resolving resources like images etc...

taskDirectory - the temporary directory for this printing task.

outputStream - the stream to write the result to

Throws:

java.lang.Exception