Package com.storedobject.office

Class Filler<T>

java.lang.Object

com.storedobject.office.Filler<T>

All Implemented Interfaces:

Executable, Runnable

Direct Known Subclasses:

ObjectFiller, Test.F

public class Filler<T>
extends Object
implements Executable

A base class for implementing a filler for variable substitution in ODT templates. Provides methods for evaluating variables and customizing ODT elements.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Filler()

Method Summary

Modifier and Type	Method	Description
List<Object>	createLinkData(ODT.Table table)	Create the data for a link table.
void	customizeImage(ODT.Image image)	Allows customization of an image before it is generated.
void	customizeSection(ODT.Section section)	Allows customization of a section before it is generated.
void	customizeTable(ODT.Table table)	Allows customization of a table before it is generated.
Object	evaluate(ODT.Element element, String variableName)	Evaluates the given variable to determine a corresponding value.
Object	evaluate(Object object, String attribute)	Evaluates the specified attribute of the given object and returns the result.
void	execute()	The functional interface method specified by this interface.
void	execute(ODT<?> odt)	Set and execute the ODT instance associated with this filler.
final ODT<?>	getODT()	Gets the ODT instance currently associated with this filler.
T	getReportingObject()	Retrieves the reporting object associated with this instance.
final TransactionManager	getTransactionManager()	Get the transaction manager associated with the ODT.
void	populateLinkTable(ODT.Table table)	Populate the data for a link table.
void	setImageCustomizer(BiConsumer<Filler<?>,ODT.Image> imageCustomizer)	Sets a customizer for images that enables tailored modifications or adjustments during their generation.
void	setReportingObject(T reportingObject)	Sets the reporting object for this instance.
void	setSectionCustomizer(BiConsumer<Filler<?>,ODT.Section> sectionCustomizer)	Sets a customizer for sections that enables tailored modifications or adjustments during their generation.
void	setTableCustomizer(BiConsumer<Filler<?>,ODT.Table> tableCustomizer)	Sets a customizer for tables that enables tailored modifications or adjustments during their generation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.common.Executable

act, run

Constructor Details

Filler

public Filler()

Method Details

execute

public void execute()

Description copied from interface: Executable

The functional interface method specified by this interface.

Specified by:

execute in interface Executable

execute

public void execute(ODT<?> odt)

Set and execute the ODT instance associated with this filler.

Parameters:

odt - The ODT instance to set and execute.

getReportingObject

public T getReportingObject()

Retrieves the reporting object associated with this instance. The reporting object can be of any generic type T.

Returns:

The reporting object of type T.

setReportingObject

public void setReportingObject(T reportingObject)

Sets the reporting object for this instance.

Parameters:

reportingObject - The reporting object to set. It can be of any type T.

getTransactionManager

public final TransactionManager getTransactionManager()

Get the transaction manager associated with the ODT.

Returns:

Transaction manager associated with the ODT.

getODT

public final ODT<?> getODT()

Gets the ODT instance currently associated with this filler.

Returns:

The active ODT instance, or null if this filler is not attached to one.

evaluate

public Object evaluate(Object object,
 String attribute)

Evaluates the specified attribute of the given object and returns the result. The method dynamically invokes the getter method for the specified attribute on the provided object and retrieves its value. If an error occurs during evaluation, null is returned.

Parameters:

object - The object whose attribute is to be evaluated. Must not be null.

attribute - The name of the attribute to be evaluated. Must not be null.

Returns:

The value of the evaluated attribute, or null if an error occurs during evaluation.

evaluate

public Object evaluate(ODT.Element element,
 String variableName)

Evaluates the given variable to determine a corresponding value. The method handles special cases for ODT.Image elements and elements not associated with a table cell. If a reporting object is available, the evaluation delegates to that object for further processing if the variable is not inside a table cell.

Parameters:

element - The ODT.Element instance where this variable is located.

variableName - The name of the variable to evaluate.

Returns:

The evaluated result as an Object, or a placeholder string in the format "variableName = ?" if the value cannot be determined. Returns null for instances of ODT.Image.

customizeSection

public void customizeSection(ODT.Section section)

Allows customization of a section before it is generated.

Override this method to adjust the section content, remove it, or apply any other document-specific logic.

Note: If a customizer is set, it will be invoked to perform section-specific adjustments.

Parameters:

section - The section being customized.

setSectionCustomizer

public void setSectionCustomizer(BiConsumer<Filler<?>,ODT.Section> sectionCustomizer)

Sets a customizer for sections that enables tailored modifications or adjustments during their generation. The customizer is represented as a BiConsumer that accepts a Filler instance and an ODT.Section.

Parameters:

sectionCustomizer - A BiConsumer that defines the customization logic for sections. The first parameter is the Filler instance associated with the operation, and the second parameter is the ODT.Section to be customized.

setTableCustomizer

public void setTableCustomizer(BiConsumer<Filler<?>,ODT.Table> tableCustomizer)

Sets a customizer for tables that enables tailored modifications or adjustments during their generation. The customizer is represented as a BiConsumer that accepts a Filler instance and an ODT.Table.

Parameters:

tableCustomizer - A BiConsumer that defines the customization logic for tables. The first parameter is the Filler instance associated with the operation, and the second parameter is the ODT.Table to be customized.

customizeImage

public void customizeImage(ODT.Image image)

Allows customization of an image before it is generated.

Override this method to modify image handling or remove the image entirely.

Note: If a customizer is set, it will be invoked to perform image-specific adjustments.

Parameters:

image - The image being customized.

customizeTable

public void customizeTable(ODT.Table table)

Allows customization of a table before it is generated.

Override this method to control table output, row counts, blank rows, or remove the table entirely.

Note: If a customizer is set, it will be invoked to perform table-specific adjustments.

Parameters:

table - The table being customized.

populateLinkTable

public void populateLinkTable(ODT.Table table)

Populate the data for a link table.

Note: The table name should start with "L:" followed by the link object's class name to be considered a link table.

Parameters:

table - The table to populate.

createLinkData

public List<Object> createLinkData(ODT.Table table)

Create the data for a link table.

Note: The table name should start with "L:" followed by the link object's class name to be considered a link table.

Parameters:

table - The table to populate.

Returns:

List of linked objects or null if unable to create the link or table is invalid.

setImageCustomizer

public void setImageCustomizer(BiConsumer<Filler<?>,ODT.Image> imageCustomizer)

Sets a customizer for images that enables tailored modifications or adjustments during their generation. The customizer is represented as a BiConsumer that accepts a Filler instance and an ODT.Image.

Parameters:

imageCustomizer - A BiConsumer that defines the customization logic for images. The first parameter is the Filler instance associated with the operation, and the second parameter is the ODT.Image to be customized.