org.mapfish.print

Class MapPrinter

java.lang.Object

org.mapfish.print.MapPrinter

public class MapPrinter
extends java.lang.Object

The main class for printing maps. Will parse the spec, create the PDF document and generate it. This class should not be directly created but rather obtained from an application context object so that all plugins and dependencies are correctly injected into it

Constructor Summary

Constructors

Constructor and Description
MapPrinter()

Method Summary

Methods

Modifier and Type	Method and Description
Config	getConfig()
java.lang.String	getOutputFilename(java.lang.String layout, java.lang.String defaultName)
OutputFormat	getOutputFormat(PJsonObject jsonSpec)
boolean	isRunning()
static PJsonObject	parseSpec(java.lang.String spec)
RenderingContext	print(PJsonObject jsonSpec, java.io.OutputStream outputStream, java.util.Map<java.lang.String,java.lang.String> headers) Generate the PDF using the given spec.
void	printClientConfig(org.json.JSONWriter json) Use by /info.json to generate its returned content.
MapPrinter	setConfig(java.io.InputStream inputConfig)
MapPrinter	setConfig(java.lang.String strConfig)
MapPrinter	setConfigDir(java.lang.String configDir)
MapPrinter	setYamlConfigFile(java.io.File configFile) Sets both the configuration by parsing the configFile and the configDir relative to the configFile
void	stop() Stop the thread pool or others.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapPrinter

public MapPrinter()

Method Detail

setYamlConfigFile

public MapPrinter setYamlConfigFile(java.io.File configFile)
                             throws java.io.FileNotFoundException

Sets both the configuration by parsing the configFile and the configDir relative to the configFile

Parameters:

configFile -

Returns:

this

Throws:

java.io.FileNotFoundException

setConfig

public MapPrinter setConfig(java.lang.String strConfig)

setConfig

public MapPrinter setConfig(java.io.InputStream inputConfig)

setConfigDir

public MapPrinter setConfigDir(java.lang.String configDir)

print

public RenderingContext print(PJsonObject jsonSpec,
                     java.io.OutputStream outputStream,
                     java.util.Map<java.lang.String,java.lang.String> headers)
                       throws com.itextpdf.text.DocumentException,
                              java.lang.InterruptedException

Generate the PDF using the given spec.

Returns:

The context that was used for printing.

Throws:

java.lang.InterruptedException

com.itextpdf.text.DocumentException

parseSpec

public static PJsonObject parseSpec(java.lang.String spec)

printClientConfig

public void printClientConfig(org.json.JSONWriter json)
                       throws org.json.JSONException

Use by /info.json to generate its returned content.

Parameters:

json - the writer for outputting the config specification

Throws:

org.json.JSONException

stop

@PreDestroy
public void stop()

Stop the thread pool or others.

getOutputFilename

public java.lang.String getOutputFilename(java.lang.String layout,
                                 java.lang.String defaultName)

getConfig

public Config getConfig()

getOutputFormat

public OutputFormat getOutputFormat(PJsonObject jsonSpec)

isRunning

public boolean isRunning()