Package io.jmix.reports.yarg.formatters.factory

Class FormatterFactoryInput

java.lang.Object

io.jmix.reports.yarg.formatters.factory.FormatterFactoryInput

public class FormatterFactoryInput
extends Object

The object is single input parameter for formatter constructor If you need you formatter be created by factory - it should accept this object as constructor parameter

Field Summary

Fields

Modifier and Type	Field	Description
protected final OutputStream	outputStream
protected ReportOutputType	outputType
protected final ReportTemplate	reportTemplate
protected final BandData	rootBand
protected boolean	streaming
protected final String	templateExtension

Constructor Summary

Constructors

Constructor	Description
FormatterFactoryInput(String templateExtension, BandData rootBand, ReportTemplate reportTemplate, ReportOutputType outputType, OutputStream outputStream)
FormatterFactoryInput(String templateExtension, BandData rootBand, ReportTemplate reportTemplate, ReportOutputType outputType, OutputStream outputStream, boolean streaming)
FormatterFactoryInput(String templateExtension, BandData rootBand, ReportTemplate reportTemplate, OutputStream outputStream)

Method Summary

Modifier and Type	Method	Description
OutputStream	getOutputStream()
ReportOutputType	getOutputType()
ReportTemplate	getReportTemplate()
BandData	getRootBand()
String	getTemplateExtension()
boolean	isStreaming()

Methods inherited from class java.lang.Object

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

Field Details

templateExtension

protected final String templateExtension

rootBand

protected final BandData rootBand

reportTemplate

protected final ReportTemplate reportTemplate

outputStream

protected final OutputStream outputStream

outputType

protected ReportOutputType outputType

streaming

protected boolean streaming

Constructor Details

FormatterFactoryInput

public FormatterFactoryInput(String templateExtension,
 BandData rootBand,
 ReportTemplate reportTemplate,
 OutputStream outputStream)

FormatterFactoryInput

public FormatterFactoryInput(String templateExtension,
 BandData rootBand,
 ReportTemplate reportTemplate,
 ReportOutputType outputType,
 OutputStream outputStream)

FormatterFactoryInput

public FormatterFactoryInput(String templateExtension,
 BandData rootBand,
 ReportTemplate reportTemplate,
 ReportOutputType outputType,
 OutputStream outputStream,
 boolean streaming)

Method Details

getTemplateExtension

public String getTemplateExtension()

getRootBand

public BandData getRootBand()

getReportTemplate

public ReportTemplate getReportTemplate()

getOutputStream

public OutputStream getOutputStream()

getOutputType

public ReportOutputType getOutputType()

isStreaming

public boolean isStreaming()

Returns:

true if the report declares a streaming band, requesting the streaming XLSX engine