Package io.jmix.reports.yarg.structure.impl

Class ReportTemplateImpl

java.lang.Object

io.jmix.reports.yarg.structure.impl.ReportTemplateImpl

All Implemented Interfaces:

ReportTemplate, Serializable

public class ReportTemplateImpl
extends Object
implements ReportTemplate

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	code
protected boolean	custom
protected CustomReport	customReport
protected byte[]	documentContent
protected String	documentName
protected String	documentPath
protected boolean	groovy
protected String	outputNamePattern
protected ReportOutputType	reportOutputType

Fields inherited from interface io.jmix.reports.yarg.structure.ReportTemplate

DEFAULT_TEMPLATE_CODE

Constructor Summary

Constructors

Constructor	Description
ReportTemplateImpl(String code, String documentName, String documentPath, ReportOutputType reportOutputType)
ReportTemplateImpl(String code, String documentName, String documentPath, ReportOutputType reportOutputType, boolean groovy)
ReportTemplateImpl(String code, String documentName, String documentPath, InputStream documentContent, ReportOutputType reportOutputType)

Method Summary

Modifier and Type	Method	Description
String	getCode()
CustomReport	getCustomReport()
InputStream	getDocumentContent()
String	getDocumentName()
String	getDocumentPath()
String	getOutputNamePattern()
ReportOutputType	getOutputType()
boolean	isCustom()
boolean	isGroovy()

Methods inherited from class java.lang.Object

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

Field Details

code

protected String code

documentName

protected String documentName

documentPath

protected String documentPath

documentContent

protected byte[] documentContent

reportOutputType

protected ReportOutputType reportOutputType

outputNamePattern

protected String outputNamePattern

groovy

protected boolean groovy

customReport

protected CustomReport customReport

custom

protected boolean custom

Constructor Details

ReportTemplateImpl

public ReportTemplateImpl(String code,
 String documentName,
 String documentPath,
 InputStream documentContent,
 ReportOutputType reportOutputType)
                   throws IOException

Throws:

IOException

ReportTemplateImpl

public ReportTemplateImpl(String code,
 String documentName,
 String documentPath,
 ReportOutputType reportOutputType)
                   throws IOException

Throws:

IOException

ReportTemplateImpl

public ReportTemplateImpl(String code,
 String documentName,
 String documentPath,
 ReportOutputType reportOutputType,
 boolean groovy)
                   throws IOException

Throws:

IOException

Method Details

getCode

public String getCode()

Specified by:

getCode in interface ReportTemplate

getDocumentName

public String getDocumentName()

Specified by:

getDocumentName in interface ReportTemplate

getDocumentContent

public InputStream getDocumentContent()

Specified by:

getDocumentContent in interface ReportTemplate

Returns:

stream containing resulting document

getOutputType

public ReportOutputType getOutputType()

Specified by:

getOutputType in interface ReportTemplate

Returns:

output type of for this template

getDocumentPath

public String getDocumentPath()

Specified by:

getDocumentPath in interface ReportTemplate

getOutputNamePattern

public String getOutputNamePattern()

Specified by:

getOutputNamePattern in interface ReportTemplate

Returns:

name pattern for generating document. Example: ${Band1.FILE_NAME} or myDocument.doc

isGroovy

public boolean isGroovy()

Specified by:

isGroovy in interface ReportTemplate

Returns:

if it is groovy html template.

isCustom

public boolean isCustom()

Specified by:

isCustom in interface ReportTemplate

Returns:

if report is defined by custom class. In this case band data will be passed in io.jmix.reports.yarg.structure.ReportTemplate#getCustomReport() object and it will generate binary.

getCustomReport

public CustomReport getCustomReport()

Specified by:

getCustomReport in interface ReportTemplate

Returns:

implementation of custom report logic.