Package com.storedobject.office

Class IteratorODTReport<T>

java.lang.Object

com.storedobject.office.ODT<T>

com.storedobject.office.AbstractODTReport<T>

com.storedobject.office.IteratorODTReport<T>

Type Parameters:

T - The type of the iterator element that is being processed.

All Implemented Interfaces:

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

public class IteratorODTReport<T>
extends AbstractODTReport<T>

An iterator-based ODT report. An iterator should be provided via ODT.setIterator(java.util.Iterator). The output will be generated based for each element of the iterator.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.office.ODT

ODT.Document<O>, ODT.Element, ODT.Image, ODT.InputTableRow, ODT.Section, ODT.SectionName, ODT.Table, ODT.TableCell, ODT.TableRow, ODT.TextElement

Constructor Summary

Constructors

Constructor	Description
IteratorODTReport(Device device)	Constructs an IteratorODTReport instance that generates a report based on the elements of an iterator.
IteratorODTReport(Device device, Id streamDataId)	Constructs an instance of IteratorODTReport with the specified device and stream data ID.
IteratorODTReport(Device device, Id streamDataId, Object filler)	Constructs an IteratorODTReport instance with the specified device, stream data identifier, and filler object.
IteratorODTReport(Device device, StreamData streamData)	Creates an instance of IteratorODTReport that generates reports based on the specified device and stream data.
IteratorODTReport(Device device, StreamData streamData, Object filler)	Constructs an IteratorODTReport instance with a specific device, stream data, and filler object.

Method Summary

Methods inherited from class com.storedobject.office.AbstractODTReport

execute, getEntity, getReportFormat, setEntity, view

Methods inherited from class com.storedobject.office.ODT

close, getContent, getContentType, getDevice, getException, getFileExtension, getFileName, getSectionNames, getTransactionManager, isRawOutput, log, produce, ready, reportingIteratorValue, setExcludeImages, setFiller, setImageCustomizer, setIterator, setOutputAsHTML, setOutputAsPDF, setRawOutput, setReportingObject, setSectionCustomizer, setTableCustomizer, setTemplate, setTemplate, setTransactionManager

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, extractContent, 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

IteratorODTReport

public IteratorODTReport(Device device)

Constructs an IteratorODTReport instance that generates a report based on the elements of an iterator. This uses the specified device for viewing or executing the report.

Parameters:

device - The device associated with the report, used for viewing or executing the report.

IteratorODTReport

public IteratorODTReport(Device device,
 Id streamDataId)

Constructs an instance of IteratorODTReport with the specified device and stream data ID. This constructor ties the report to a specific device for handling output-related functionalities and associates it with a particular template identified by the given stream data ID.

Parameters:

device - The device associated with the report, typically responsible for viewing or printing the report.

streamDataId - The unique ID of the stream data used as the template for generating the report content.

IteratorODTReport

public IteratorODTReport(Device device,
 Id streamDataId,
 Object filler)

Constructs an IteratorODTReport instance with the specified device, stream data identifier, and filler object. This constructor initializes the report by setting the device, template, and filler, allowing further data iteration and output generation.

Parameters:

device - The device associated with this report, defining the context in which the report will be viewed or printed.

streamDataId - The identifier of the stream data template to be used for the report. This identifier is used to fetch the corresponding template.

filler - The filler object used to populate the data in the report. It can be null if no specific data is required during initialization.

IteratorODTReport

public IteratorODTReport(Device device,
 StreamData streamData)

Creates an instance of IteratorODTReport that generates reports based on the specified device and stream data. The report output is structured iteratively by processing each element of an Iterator that must be set via ODT.setIterator(java.util.Iterator).

Parameters:

device - The device with which the report will be associated. This typically represents the output destination, such as a printer or a viewer.

streamData - The stream data containing the pre-defined content (usually in ODT format) for the report. This serves as a template or source content for report generation.

IteratorODTReport

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

Constructs an IteratorODTReport instance with a specific device, stream data, and filler object. This report generates output based on the elements provided by an iterator and employs the given stream data and filler for content configuration.

Parameters:

device - The device with which this report is associated for viewing or printing.

streamData - The stream data containing the template for the ODT report. It provides the structure and content for the report. Can be null.

filler - An optional object used to provide additional data or configurations required for generating the report.