Class ecrion.ultrascale.LocalDocumentTemplate

Top Previous Topic Next Topic  Print this topic

LocalDocumentTemplate represents a XSL or XFD template available locally to the client Java application.

 

Ecrion.Ultrascale.Java.jar will combine XML data with the template and will send the resulting XSL-FO or HTML to the server. The server will process this input and will return back a PDF document (or any other supported output format).

 

LocalDocumentTemplateProcessFlow(Java)

For more information about local vs. server templates see also Choosing between Local and Server Templates.

 

Members/Properties

 

Name

Description

XSLTEngine

The engine to use when applying XSL Transformations to generate XSL-FO from XML.

XsltParameters

Represents the parameters transmitted to xslt engine. Inherited from ecrion.ultrascale.DocumentTemplate.

LanguageID

Specifies the language used for XFD translations. Inherited from ecrion.ultrascale.DocumentTemplate.

 

Methods

 

Name

Description

LocalDocumentTemplate

Creates a new instance of a server template using a file path.

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters.

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters.

The transformation engine is also specified.

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters.

The transformation engine and translation language are also specified.

 

LocalDocumentTemplate

Creates a new instance of a server template using a file path.

 

 

public LocalDocumentTemplate(String templateFilePath)

                       

 

Parameters

 

templateFilePath

       The template file used to perform layout.

 

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters.

 

 

public LocalDocumentTemplate(String templateFilePath, Map parameters)

 

                       

Parameters

 

templateFilePath

       The template file used to perform layout.

parameters

       Pairs of key/values that must be used during the transformation.

 

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters. The transformation engine is also specified.

 

 

public LocalDocumentTemplate(String templateFilePath, Map parameters,

                                    int xsltEngine)

 

                       

Parameters

 

templateFilePath

       The template file used to perform layout.

parameters

       Pairs of key/values that must be used during the transformation.

xsltEngine

       The XSLT engine that must be used for transformation.

 

 

LocalDocumentTemplate

Creates a new instance of a LocalDocumentTemplate using a file path and a set of parameters. The transformation engine and translation language are also specified.

 

 

public LocalDocumentTemplate(String templateFilePath, Map parameters,

                                    Engine.XsltEngine xsltEngine, String languageId)

 

                       

Parameters

 

templateFilePath

       The template file used to perform layout.

parameters

       Pairs of key/values that must be used during the transformation.

xsltEngine

       The XSLT engine that must be used for transformation.

languageId

       When the template is an XFD (XF Designer) layout template, this parameter specifies the language used for translations.

 

 

XSLTEngine

The engine to use when applying XSL Transformations to generate XSLFO from XML. Default is MSXML.

 

 

public Engine.XsltEngine XSLTEngine

 

 

XsltParameters

The parameters transmitted to XSLT engine. Inherited from Ecrion.Ultrascale.DocumentTemplate.

 

 

public Map XsltParameters

 

 

LanguageID

Specifies the language used for XFD translations.  Inherited from Ecrion.Ultrascale.DocumentTemplate.

 

 

public String LanguageID