DocumentAssembler Leave feedback

Inheritance: java.lang.Object

public class DocumentAssembler

Provides routines to populate template documents with data and a set of settings to control these routines.

public DocumentAssembler()

Initializes a new instance of this class.

public boolean assembleDocument(String sourcePath, String targetPath, DataSourceInfo[] dataSourceInfos)

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using default LoadSaveOptions.

Parameters:

Returns: boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE_ERROR_MESSAGES option.

public boolean assembleDocument(String sourcePath, String targetPath, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)

Loads a template document from the specified source path, populates the template document with data from the specified single or multiple sources, and stores the result document to the target path using the given LoadSaveOptions.

Parameters:

Returns: boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE_ERROR_MESSAGES option.

public boolean assembleDocument(InputStream sourceStream, OutputStream targetStream, DataSourceInfo[] dataSourceInfos)

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using default LoadSaveOptions.

Parameters:

Returns: boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE_ERROR_MESSAGES option.

public boolean assembleDocument(InputStream sourceStream, OutputStream targetStream, LoadSaveOptions loadSaveOptions, DataSourceInfo[] dataSourceInfos)

Loads a template document from the specified source stream, populates the template document with data from the specified single or multiple sources, and stores the result document to the target stream using the given LoadSaveOptions.

Parameters:

Returns: boolean - A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the DocumentAssemblyOptions.INLINE_ERROR_MESSAGES option.

public int getOptions()

Gets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document.

Returns: int - A set of flags controlling behavior of this DocumentAssembler instance while assembling a document. The returned value is a bitwise combination of DocumentAssemblyOptions constants.

public void setOptions(int value)

Sets a set of flags controlling behavior of this DocumentAssembler instance while assembling a document.

Parameters:

public BarcodeSettings getBarcodeSettings()

Gets a set of settings controlling barcode generation while assembling a document.

Returns: BarcodeSettings - A set of settings controlling barcode generation while assembling a document.

public KnownTypeSet getKnownTypes()

Gets an unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types’ static members, perform type casts, etc.

Returns: KnownTypeSet - An unordered set (that is, a collection of unique items) containing java.lang.Class objects which fully or partially qualified names can be used within document templates processed by this assembler instance to invoke the corresponding types’ static members, perform type casts, etc.

public static boolean getUseReflectionOptimization()

Gets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true. There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls.

Returns: boolean - A value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.

public static void setUseReflectionOptimization(boolean value)

Sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true. There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls.

Parameters: