er.pdf.builder

Class Fop2PdfImpl

java.lang.Object

er.pdf.builder.Fop2PdfImpl

All Implemented Interfaces:

FOPBuilder

public class Fop2PdfImpl
extends Object
implements FOPBuilder

Properties

Name	Description
er.pdf.builder.fop.resolution	Resolution of the pdf. Defaults to 300.
er.pdf.builder.fop.author	Name of the author. Defaults to 'ERPDFGeneration'.
er.pdf.builder.fop.generator	Name of the generator. Defaults to 'ERPDFGeneration'.
er.pdf.builder.fop.config.filename	Set to the name of the fop configuration file. Defaults to 'fop.xconf'.
er.pdf.builder.fop.config.framework	Name of the framework the config file exists within. Defaults to 'ERPDFGeneration'.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHOR_KEY
static String	DEFAULT_AUTHOR
static int	DEFAULT_RESOLUTION
static String	FOP_CONF_FILENAME
static String	FOP_CONF_FILENAME_KEY
static String	FOP_CONF_FRAMEWORK
static String	FOP_CONF_FRAMEWORK_KEY
static String	GENERATOR_NAME
static String	GENERATOR_NAME_KEY
static String	TARGET_RESOLUTION_KEY

Constructor Summary

Constructors

Constructor and Description
Fop2PdfImpl()

Method Summary

Modifier and Type	Method and Description
NSDictionary<String,Object>	agentDefaults()
NSDictionary<String,Object>	configuration()
NSDictionary<String,Object>	configurationDefaults()
void	createDocument(OutputStream os) create the output file pdf.
void	createDocument(OutputStream os, NSDictionary<String,Object> agentAttributes)
void	setConfiguration(NSMutableDictionary<String,Object> config) this is here for extension in order to pass configuration of the fop engine from the program.
void	setXML(String xmlToTransform) set the xml string to be transformed.
void	setXSL(String fopxslLocation) set the location of the transform file.

Methods inherited from class java.lang.Object

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

Field Detail

GENERATOR_NAME_KEY

public static final String GENERATOR_NAME_KEY

See Also:

Constant Field Values

GENERATOR_NAME

public static final String GENERATOR_NAME

See Also:

Constant Field Values

AUTHOR_KEY

public static final String AUTHOR_KEY

See Also:

Constant Field Values

DEFAULT_AUTHOR

public static final String DEFAULT_AUTHOR

See Also:

Constant Field Values

TARGET_RESOLUTION_KEY

public static final String TARGET_RESOLUTION_KEY

See Also:

Constant Field Values

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION

See Also:

Constant Field Values

FOP_CONF_FILENAME_KEY

public static final String FOP_CONF_FILENAME_KEY

See Also:

Constant Field Values

FOP_CONF_FILENAME

public static final String FOP_CONF_FILENAME

See Also:

Constant Field Values

FOP_CONF_FRAMEWORK_KEY

public static final String FOP_CONF_FRAMEWORK_KEY

See Also:

Constant Field Values

FOP_CONF_FRAMEWORK

public static final String FOP_CONF_FRAMEWORK

See Also:

Constant Field Values

Constructor Detail

Fop2PdfImpl

public Fop2PdfImpl()

Method Detail

setXSL

public void setXSL(String fopxslLocation)

Description copied from interface: FOPBuilder

set the location of the transform file. This is passed to getResourceAsStream so it's intended to be loaded from the classpath somewhere. It should work with jars or anything that can be found using getResource(asStream)

Specified by:

setXSL in interface FOPBuilder

setXML

public void setXML(String xmlToTransform)

Description copied from interface: FOPBuilder

set the xml string to be transformed.

Specified by:

setXML in interface FOPBuilder

agentDefaults

public NSDictionary<String,Object> agentDefaults()

Returns:

a configuration dictionary for the user agent

createDocument

public void createDocument(OutputStream os)
                    throws Throwable

Description copied from interface: FOPBuilder

create the output file pdf.

Specified by:

createDocument in interface FOPBuilder

Throws:

Throwable

createDocument

public void createDocument(OutputStream os,
                           NSDictionary<String,Object> agentAttributes)
                    throws Throwable

Specified by:

createDocument in interface FOPBuilder

Throws:

Throwable

configurationDefaults

public NSDictionary<String,Object> configurationDefaults()

configuration

public NSDictionary<String,Object> configuration()

setConfiguration

public void setConfiguration(NSMutableDictionary<String,Object> config)

Description copied from interface: FOPBuilder

this is here for extension in order to pass configuration of the fop engine from the program. For now, I'm relying on environment configuration and some specific inline configuration. We'll see if this is important.

Specified by:

setConfiguration in interface FOPBuilder