Package io.jmix.reports.yarg.formatters.impl

Class AbstractFormatter

java.lang.Object

io.jmix.reports.yarg.formatters.impl.AbstractFormatter

All Implemented Interfaces:

ReportFormatter

Direct Known Subclasses:

ChartFormatter, CsvFormatter, DocFormatter, DocxFormatter, HtmlFormatter, JasperFormatter, JmixTableFormatter, PivotTableFormatter, XLSFormatter, XlsxFormatter

public abstract class AbstractFormatter
extends Object
implements ReportFormatter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractFormatter.BandPathAndParameterName
protected static class	AbstractFormatter.InlinerAndMatcher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIAS_GROUP
static final Pattern	ALIAS_WITH_BAND_NAME_PATTERN
static final String	ALIAS_WITH_BAND_NAME_REGEXP
static final Pattern	BAND_NAME_DECLARATION_PATTERN
static final String	BAND_NAME_DECLARATION_REGEXP
protected List<ContentInliner>	contentInliners	Chain of responsibility for content inliners
protected DefaultFormatProvider	defaultFormatProvider
protected GroovyScriptParametersProvider	groovyScriptParametersProvider
protected OutputStream	outputStream
protected ReportOutputType	outputType
protected ReportTemplate	reportTemplate
protected BandData	rootBand
protected Scripting	scripting
static final String	SIMPLE_ALIAS_REGEXP
static final String	STRING_FUNCTION_GROUP
protected Set<ReportOutputType>	supportedOutputTypes
static final Pattern	UNIVERSAL_ALIAS_PATTERN
static final String	UNIVERSAL_ALIAS_REGEXP
static final String	VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFormatter(FormatterFactoryInput formatterFactoryInput)

Method Summary

Modifier and Type	Method	Description
protected String	applyStringFunction(String valueString, String stringFunction)
void	checkThreadInterrupted()
protected boolean	containsJustOneAlias(String value)
byte[]	createDocument()	Creates document and put it into byte array
protected String	defaultFormat(Object value)
protected BandData	findBandByPath(String path)
protected String	formatValue(Object value, String parameterName, String fullParameterName)
protected String	formatValue(Object value, String parameterName, String fullParameterName, String stringFunction)
protected List<String>	getAllAliases(String value)
protected AbstractFormatter.InlinerAndMatcher	getContentInlinerForFormat(String formatString)
List<ContentInliner>	getContentInliners()
protected String	getFormatString(String parameterName, String fullParameterName)
protected String	getFullParameterName(BandData bandData, String parameterName)
protected String	inlineParameterValue(String template, String parameterName, String value)
protected String	insertBandDataToString(BandData bandData, String resultStr)
protected Boolean	isGroovyScript(String parameterName, String fullParameterName)
protected AbstractFormatter.BandPathAndParameterName	separateBandNameAndParameterName(String alias)
void	setContentInliners(List<ContentInliner> contentInliners)
void	setDefaultFormatProvider(DefaultFormatProvider defaultFormatProvider)
void	setScripting(Scripting scripting)
protected String	unwrapParameterName(String nameWithAlias)
protected ReportFormattingException	wrapWithReportingException(String message)
protected ReportingException	wrapWithReportingException(String message, Exception e)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.reports.yarg.formatters.ReportFormatter

renderDocument

Field Details

SIMPLE_ALIAS_REGEXP

public static final String SIMPLE_ALIAS_REGEXP

See Also:

• Constant Field Values

ALIAS_GROUP

public static final String ALIAS_GROUP

See Also:

• Constant Field Values

STRING_FUNCTION_GROUP

public static final String STRING_FUNCTION_GROUP

See Also:

• Constant Field Values

UNIVERSAL_ALIAS_REGEXP

public static final String UNIVERSAL_ALIAS_REGEXP

See Also:

• Constant Field Values

ALIAS_WITH_BAND_NAME_REGEXP

public static final String ALIAS_WITH_BAND_NAME_REGEXP

See Also:

• Constant Field Values

BAND_NAME_DECLARATION_REGEXP

public static final String BAND_NAME_DECLARATION_REGEXP

See Also:

• Constant Field Values

UNIVERSAL_ALIAS_PATTERN

public static final Pattern UNIVERSAL_ALIAS_PATTERN

ALIAS_WITH_BAND_NAME_PATTERN

public static final Pattern ALIAS_WITH_BAND_NAME_PATTERN

BAND_NAME_DECLARATION_PATTERN

public static final Pattern BAND_NAME_DECLARATION_PATTERN

VALUE

public static final String VALUE

See Also:

• Constant Field Values

rootBand

protected BandData rootBand

reportTemplate

protected ReportTemplate reportTemplate

outputType

protected ReportOutputType outputType

outputStream

protected OutputStream outputStream

supportedOutputTypes

protected Set<ReportOutputType> supportedOutputTypes

defaultFormatProvider

protected DefaultFormatProvider defaultFormatProvider

groovyScriptParametersProvider

@Autowired
protected GroovyScriptParametersProvider groovyScriptParametersProvider

scripting

@Autowired
protected Scripting scripting

contentInliners

protected List<ContentInliner> contentInliners

Chain of responsibility for content inliners

Constructor Details

AbstractFormatter

protected AbstractFormatter(FormatterFactoryInput formatterFactoryInput)

Method Details

setScripting

public void setScripting(Scripting scripting)

createDocument

public byte[] createDocument()

Description copied from interface: ReportFormatter

Creates document and put it into byte array

Specified by:

createDocument in interface ReportFormatter

getContentInliners

public List<ContentInliner> getContentInliners()

setContentInliners

public void setContentInliners(List<ContentInliner> contentInliners)

setDefaultFormatProvider

public void setDefaultFormatProvider(DefaultFormatProvider defaultFormatProvider)

unwrapParameterName

protected String unwrapParameterName(String nameWithAlias)

formatValue

protected String formatValue(Object value,
 String parameterName,
 String fullParameterName)

formatValue

protected String formatValue(Object value,
 String parameterName,
 String fullParameterName,
 String stringFunction)

getFormatString

protected String getFormatString(String parameterName,
 String fullParameterName)

isGroovyScript

protected Boolean isGroovyScript(String parameterName,
 String fullParameterName)

applyStringFunction

protected String applyStringFunction(String valueString,
 String stringFunction)

defaultFormat

protected String defaultFormat(Object value)

insertBandDataToString

protected String insertBandDataToString(BandData bandData,
 String resultStr)

getFullParameterName

protected String getFullParameterName(BandData bandData,
 String parameterName)

inlineParameterValue

protected String inlineParameterValue(String template,
 String parameterName,
 String value)

containsJustOneAlias

protected boolean containsJustOneAlias(String value)

getAllAliases

protected List<String> getAllAliases(String value)

findBandByPath

protected BandData findBandByPath(String path)

separateBandNameAndParameterName

protected AbstractFormatter.BandPathAndParameterName separateBandNameAndParameterName(String alias)

wrapWithReportingException

protected ReportingException wrapWithReportingException(String message,
 Exception e)

wrapWithReportingException

protected ReportFormattingException wrapWithReportingException(String message)

getContentInlinerForFormat

protected AbstractFormatter.InlinerAndMatcher getContentInlinerForFormat(String formatString)

checkThreadInterrupted

public void checkThreadInterrupted()