Package com.storedobject.office

Class ODT<T>

java.lang.Object

com.storedobject.office.ODT<T>

Type Parameters:

T - The type of the iterator element that is being processed. If no iterator is set, this is not applicable.

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

AbstractODTReport

public class ODT<T>
extends Object
implements ContentProducer, Closeable

The ODT class is a representation of an Open Document Template (ODT) document processor. It provides various constructors and methods to handle template-based document generation using ODT format. The class extends core functionality from content-producing and closeable interfaces to streamline the process of managing document content.

If an iterator is set, the output will be generated for each element of the iterator.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ODT.Document<O>	Represents a document.
static class	ODT.Element	Represents an abstract base class for document elements.
static final class	ODT.Image	Represents an image element within a document.
static final class	ODT.InputTableRow	Represents a table row of a table that can be copied directly or added with array variables to the output.
static final class	ODT.Section	Represents a section within a document structure in the context of document processing.
static final class	ODT.SectionName	Represents a hierarchical structure of sections, where each section has a name, a reference to its parent section, and a list of child sections.
static final class	ODT.Table	Represents a table in the context of open document template (ODT) processing.
static final class	ODT.TableCell	Represents a cell within a table.
static final class	ODT.TableRow	Represents a single row within a table structure in the context of document processing.
static class	ODT.TextElement	Represents a text element that can contain one or more sections and tables.

Constructor Summary

Constructors

Constructor	Description
ODT()	Default constructor for the ODT class.
ODT(Device device, StreamData streamData, Object filler)	Constructor for the ODT class.
ODT(Id templateId)	Constructor for the ODT class.
ODT(Id templateId, Object filler)	Constructor for creating an ODT instance with a specific template and filler object.
ODT(StreamData streamData)	Constructor for creating an ODT object with the given content and optional filler.
ODT(StreamData streamData, Object filler)	Constructor for the ODT class.

Method Summary

Modifier and Type	Method	Description
void	close()
final InputStream	getContent()	Retrieves the content of this ODT instance as an InputStream.
final String	getContentType()	Retrieves the content type of the current instance, determining if it is a PDF or ODT based on the outmode set.
final Device	getDevice()	Retrieves the current device associated with the ODT instance.
Throwable	getException()	Retrieves the exception stored in this instance.
final String	getFileExtension()	Retrieves the file extension based on the current output mode.
String	getFileName()	Retrieves the name of the file associated with the current ODT instance.
List<ODT.SectionName>	getSectionNames()	Get the list of section names in the document.
final TransactionManager	getTransactionManager()	Retrieves the TransactionManager instance associated with the current context.
final boolean	isRawOutput()	Determines if the current output mode is set to raw output (that is pure ODT format, not PDF/HTML).
void	log(Object anything)	Logs the provided object.
void	produce()	Produces the necessary output based on the current state and properties of the object.
void	ready()	Waits for the associated countdown latch to reach the zero state, blocking the current thread until the latch is counted down or the thread is interrupted.
void	reportingIteratorValue(T value)	Deprecated. Use Filler.getReportingObject() to retrieve the current iteration value.
void	setExcludeImages(boolean excludeImages)	Sets the flag to exclude images from processing.
void	setFiller(Object filler)	Sets the filler object to the specified value.
final void	setImageCustomizer(BiConsumer<Filler<?>,ODT.Image> imageCustomizer)	Sets a customizer for images that enables tailored modifications or adjustments during their generation.
final void	setIterator(Iterator<T> iterator)	Sets the iterator to the specified value.
final void	setOutputAsHTML()	Configures the output to be in HTML format.
final void	setOutputAsPDF()	Configures the output format of the system as PDF.
final void	setRawOutput(boolean rawOutput)	Sets the raw output mode for the ODT instance.
final void	setReportingObject(T object)	Sets the reporting object for this instance.
final void	setSectionCustomizer(BiConsumer<Filler<?>,ODT.Section> sectionCustomizer)	Sets a customizer for sections that enables tailored modifications or adjustments during their generation.
final void	setTableCustomizer(BiConsumer<Filler<?>,ODT.Table> tableCustomizer)	Sets a customizer for tables that enables tailored modifications or adjustments during their generation.
void	setTemplate(Id templateId)	Sets the template for the ODT object based on the provided template identifier.
void	setTemplate(StreamData template)	Sets the template for the ODT object using the provided StreamData.
final void	setTransactionManager(TransactionManager transactionManager)	Sets the transaction manager to be used by this instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.ContentProducer

abort, execute, extractContent, getEntity, getError, getStreamData, getStreamDataProvider, getSystemEntity, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Constructor Details

ODT

public ODT()

Default constructor for the ODT class. This constructor initializes an empty ODT instance with no specific stream data or filler. It delegates to the constructor that accepts a `StreamData` and a filler by passing `null` for both parameters.

ODT

public ODT(Id templateId)

Constructor for the ODT class. Initializes the ODT object with a template identifier and an optional filler object.

Parameters:

templateId - The identifier of the stream data containing an ODT file template.

ODT

public ODT(Id templateId,
 Object filler)

Constructor for creating an ODT instance with a specific template and filler object.

Parameters:

templateId - Id of the template (StreamData) to be used for this ODT instance.

filler - Object that provides dynamic data to fill into the template.

ODT

public ODT(StreamData streamData)

Constructor for creating an ODT object with the given content and optional filler.

Parameters:

streamData - Stream data containing the content to initialize the ODT object.

ODT

public ODT(StreamData streamData,
 Object filler)

Constructor for the ODT class. Initializes the template using the provided StreamData and configures the internal state.

Parameters:

streamData - Stream data containing the template for the ODT file.

filler - Object used to provide additional data or configuration for the ODT file creation.

ODT

public ODT(Device device,
 StreamData streamData,
 Object filler)

Constructor for the ODT class. Initializes the template using the provided StreamData and configures the internal state.

Parameters:

streamData - Stream data containing the template for the ODT file.

filler - Object used to provide additional data or configuration for the ODT file creation.

Method Details

getDevice

public final Device getDevice()

Retrieves the current device associated with the ODT instance.

Returns:

The Device object representing the current device, or null if no device is set.

setTemplate

public void setTemplate(StreamData template)

Sets the template for the ODT object using the provided StreamData.

Parameters:

template - The StreamData object representing the template to be used.

setTemplate

public void setTemplate(Id templateId)

Sets the template for the ODT object based on the provided template identifier. If the provided identifier is null, the template is cleared. Otherwise, the template is retrieved from the stored object system using the given identifier.

Parameters:

templateId - The identifier of the template (StreamData) to be set. It represents the unique ID of the template in the stored object system.

setRawOutput

public final void setRawOutput(boolean rawOutput)

Sets the raw output mode for the ODT instance. By default, the output format is PDF. In raw mode, the output format is ODT itself.

Parameters:

rawOutput - A boolean flag indicating whether raw output mode should be enabled (true) or disabled (false).

isRawOutput

public final boolean isRawOutput()

Determines if the current output mode is set to raw output (that is pure ODT format, not PDF/HTML).

Returns:

true if the output mode is raw, otherwise false.

setOutputAsHTML

public final void setOutputAsHTML()

Configures the output to be in HTML format. This method sets the internal flag to mark that the output should be generated or treated as HTML.

setOutputAsPDF

public final void setOutputAsPDF()

Configures the output format of the system as PDF. This method ensures that the output is not generated as HTML and disables raw output formatting.

setExcludeImages

public void setExcludeImages(boolean excludeImages)

Sets the flag to exclude images from processing.

Parameters:

excludeImages - a boolean value where true indicates that images should be excluded, and false indicates that images should be included.

getContent

public final InputStream getContent()
                             throws IOException

Retrieves the content of this ODT instance as an InputStream. This method returns the content that was generated or loaded for this ODT object. If no content has been generated and an error occurred, an IOException is thrown.

Specified by:

getContent in interface ContentProducer

Returns:

An InputStream containing the content of this ODT instance.

Throws:

IOException - If no content is available due to an error.

getContentType

public final String getContentType()

Retrieves the content type of the current instance, determining if it is a PDF or ODT based on the outmode set.

Specified by:

getContentType in interface ContentType

Returns:

A string representing the MIME type of the content. This will be "application/pdf" if PDF properties are set and "application/vnd.oasis.opendocument.text" otherwise.

getFileExtension

public final String getFileExtension()

Retrieves the file extension based on the current output mode.

Specified by:

getFileExtension in interface ContentProducer

Returns:

The file extension as a string, either "odt" or "pdf".

getFileName

public String getFileName()

Retrieves the name of the file associated with the current ODT instance.

Specified by:

getFileName in interface ContentProducer

Returns:

The name of the file as a String, or null if the file name is not available.

setTransactionManager

public final void setTransactionManager(TransactionManager transactionManager)

Sets the transaction manager to be used by this instance.

Specified by:

setTransactionManager in interface RequiresTransactionManager

Parameters:

transactionManager - The TransactionManager instance to be set. It manages transactions and ensures proper transaction handling within the context of this class.

getTransactionManager

public final TransactionManager getTransactionManager()

Retrieves the TransactionManager instance associated with the current context. If the TransactionManager is not already initialized, it attempts to initialize it by getting the device, accessing its server, and retrieving its TransactionManager.

Specified by:

getTransactionManager in interface ContentProducer

Specified by:

getTransactionManager in interface RequiresTransactionManager

Returns:

The TransactionManager associated with the current context, or null if it cannot be initialized.

getException

public Throwable getException()

Retrieves the exception stored in this instance.

Returns:

the Throwable object representing the stored exception

setIterator

public final void setIterator(Iterator<T> iterator)

Sets the iterator to the specified value. If an iterator is set, the output will be generated for each element in the iterator. When each element is processed, the method reportingIteratorValue(Object) will be called.

Parameters:

iterator - the iterator to be assigned. Must implement Iterator<T>.

setReportingObject

public final void setReportingObject(T object)

Sets the reporting object for this instance.

Parameters:

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

setSectionCustomizer

public final 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 final 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.

setImageCustomizer

public final 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.

reportingIteratorValue

public void reportingIteratorValue(T value)

Deprecated.

Use Filler.getReportingObject() to retrieve the current iteration value.

Reports the current value of the iterator during processing. This will be called for each element of the iterator just before processing the element.

Parameters:

value - The current value retrieved from the iterator to be processed.

produce

public void produce()

Produces the necessary output based on the current state and properties of the object. This method ensures thread-safe execution, manages state, and triggers the appropriate processing depending on the presence of specific properties.

 Key behavior:
 - Initializes a filler object if not already initialized.
 - Early exit occurs if an error condition is detected.
 - Ensures thread-safe execution by acquiring a lock and managing the execution state.
 - Creates an InputOutputStream to handle data processing.
 - Sets a data listener to notify when the process is ready.
 - Processes raw or PDF data in a separate virtual thread based on the presence of
   specific properties.
 

Thread management and state synchronization are essential to this method's proper execution.

Specified by:

produce in interface ContentProducer

ready

public void ready()

Waits for the associated countdown latch to reach the zero state, blocking the current thread until the latch is counted down or the thread is interrupted. This method overrides the default implementation of the `ready` method.

If the thread is interrupted while waiting, the interruption is silently ignored and execution continues.

Specified by:

ready in interface ContentProducer

log

public void log(Object anything)

Logs the provided object. If a device is available, the logging will be delegated to the device. Otherwise, if the object is an instance of Throwable, it will be logged via the ApplicationServer.

Parameters:

anything - The object to be logged. It can be any object, including instances of Throwable.

setFiller

public void setFiller(Object filler)

Sets the filler object to the specified value.

Parameters:

filler - the object to set as the filler. It could be an instance of Filler.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getSectionNames

public List<ODT.SectionName> getSectionNames()

Get the list of section names in the document.

Returns:

List of section names.