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
<L extends StoredObject> ObjectIterator<L>	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 a given variable name within the context of a specific element and returns the corresponding value.
Object	evaluate(Object object, String attribute)	Evaluates the specified attribute of the 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.
String	getLinkCondition(Link<?> link)	Retrieves the condition associated with the specified link.
<L extends StoredObject> Predicate<L>	getLinkFilter(Link<L> link)	Generates a filter predicate for the specified link.
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	populateData(ODT.Table table)	Populates the data of the specified table object by processing its name and attributes.
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 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.

Notes:

1. In general, the attribute name should be a valid getter method name without the 'get' prefix. However, it is not mandatory if you handle the evaluation yourself in a derived class

2. The variable name can contain dot-operators to specify a method list StoredObjectUtility.MethodList.

3. This method is invoked internally by the evaluate(ODT.Element, String) method with the object parameter's value as one of the following. (a) The current reporting object for variables defined at top-level (means, not within any ODT.TableCell) or if the name of the variable starts with "O:" (stands for the reporting object). (b) For variables inside a ODT.TableCell, it will pass the data associated with that cell (ODT.TableCell.getData()) if it is not null. Otherwise, the reporting object is passed.

Parameters:

object - The object whose attribute is to be evaluated. Must not be null. See note #3.

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 a given variable name within the context of a specific element and returns the corresponding value. The evaluation process can involve checking system entities, users, reporting objects, table cells, or default fallback cases based on the provided variable name.

It internally invokes evaluate(Object, String) to determine the variable's value. Please see note# 3 of evaluate(Object, String) for more details.

Parameters:

element - The ODT.Element instance that provides contextual information for evaluation. This can include associated table cells or the overall reporting context.

variableName - The name of the variable to evaluate. It may have specific prefixes (e.g., "SystemEntity.", "SystemUser.", "O:") that affect the evaluation process.

Returns:

The result of the evaluation, or a default string indicating the variable name is unresolved (e.g., "variableName = ?"). The return type depends on the context and the data associated with the variable name.

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.

By default, this method takes appropriate action if a link object is specified (in that case, the name should be prefixed with "L:" followed by the link's data class) or if the table name starts with "A:" followed by an attribute name of the reporting object. If an attribute name is specified, it can also contain dot-operators.

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

Parameters:

table - The table being customized.

populateData

public void populateData(ODT.Table table)

Populates the data of the specified table object by processing its name and attributes. The method validates the table state and processes the table name to derive the necessary attributes or links, which are then used to populate the table.

Note: The name of the table should start with "A:", "L:" or "A:L:" to be processed further.

     The method first checks if the table is removed or already built and returns if true.
     It then extracts the table name and checks if it starts with "L:", "A:" or "A:L:".
     If it starts with "L:", it calls createLinkData to populate the table with link data.
     If it starts with "A:", it calls the evaluate(Object, String) method to populate the table with attribute data.
     If it starts with "A:L:", it calls createLinkData(ODT.Table)  to populate the table with the first object from the link data.
     If none of the above conditions are met, the method returns without populating the table.
 

Parameters:

table - the table object to populate. The table object must not be removed or already built. The table's name should start with "A:" to be processed further. If conditions are satisfied, attributes or links are derived and used to populate the table.

getLinkCondition

public String getLinkCondition(Link<?> link)

Retrieves the condition associated with the specified link.

Note: This is invoked when a table is processed for getting data.

Parameters:

link - the link for which the condition is to be retrieved

Returns:

the condition of the given link as a string, or null if no condition is associated

getLinkFilter

public <L extends StoredObject> Predicate<L> getLinkFilter(Link<L> link)

Generates a filter predicate for the specified link.

Note: This is invoked when a table is processed for getting data.

Parameters:

link - the link for which the filter predicate is generated

Returns:

a predicate that determines whether a given object satisfies the link filter

createLinkData

public <L extends StoredObject> ObjectIterator<L> 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.