Package io.jmix.reports.impl.builder

Class AnnotatedReportBuilderImpl

java.lang.Object

io.jmix.reports.impl.builder.AnnotatedReportBuilderImpl

All Implemented Interfaces:

AnnotatedReportBuilder

@Component("report_AnnotatedReportBuilder")
public class AnnotatedReportBuilderImpl
extends Object
implements AnnotatedReportBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedBuilderUtils	annotatedBuilderUtils
protected final AnnotatedReportGroupHolder	annotatedReportGroupHolder
protected final ClassManager	classManager
protected final Messages	messages
protected final MessageTools	messageTools
protected final Metadata	metadata
protected final ParameterClassResolver	parameterClassResolver
protected final Resources	resources
protected final AnnotatedReportRoleExtractor	roleExtractor
protected final AnnotatedReportScreenExtractor	screenExtractor

Constructor Summary

Constructors

Constructor	Description
AnnotatedReportBuilderImpl(Metadata metadata, Messages messages, MessageTools messageTools, AnnotatedBuilderUtils annotatedBuilderUtils, AnnotatedReportGroupHolder annotatedReportGroupHolder, Resources resources, AnnotatedReportRoleExtractor roleExtractor, ParameterClassResolver parameterClassResolver, AnnotatedReportScreenExtractor screenExtractor, ClassManager classManager)

Method Summary

Modifier and Type	Method	Description
protected void	assignDataSetDelegates(Set<BandDefinition> bands, Object definitionInstance)
protected void	assignGroup(Report report, ReportDef annotation)
protected void	assignInputParameterDelegates(List<ReportInputParameter> inputParameters, Object definitionInstance)
protected void	assignReportDelegates(Report report, Object definitionInstance)
protected void	assignReportParameters(Report report, ReportDef annotation, Class<?> definitionClass)
protected void	assignTemplateDelegates(List<ReportTemplate> templates, Object definitionInstance)
protected void	assignValueFormatDelegates(List<ReportValueFormat> formats, Object definitionInstance)
protected ReportInputParameter	convertToInputParameter(InputParameterDef annotation, Class<?> definitionClass)
protected TemplateTableDescription	convertToTableDescription(TemplateTableDef table, Class<?> definitionClass)
protected ReportTemplate	convertToTemplate(TemplateDef annotation, Class<?> definitionClass)
protected ReportValueFormat	convertToValueFormat(Report report, ValueFormatDef annotation)
Report	createReportFromDefinition(Object definitionInstance)	Parse, validate given annotated report definition.
protected Set<BandDefinition>	extractBands(Report report, Object definitionInstance)
protected List<DataSet>	extractDataSets(Report report, BandDefinition bandDefinition, DataSetDef[] dataSetDefs)
protected void	extractEntityDataSetParameters(DataSetDef annotation, Report report, DataSet dataSet, EntityDataSetDef entityAnnotation)
protected List<ReportInputParameter>	extractInputParameters(Report report, Object definitionInstance)
protected void	extractJsonDataSetParameters(Report report, JsonDataSetParameters jsonAnnotation, DataSet dataSet)
protected List<ReportTemplate>	extractTemplates(Report report, Object definitionInstance)
protected List<ReportValueFormat>	extractValueFormats(Report report, Object definitionInstance)
protected <E, A extends Annotation> E	findElementInListByUniqueName(Collection<E> elements, String name, Function<E,String> elementNameExtractor, A annotation, String errorMessagePrefix)
protected String	getValueName(String band, String field)
protected <T> T	obtainDelegateFromDefinition(Object reportDefinition, Method method, Class<T> delegateClass)
protected void	validateDelegateCommon(Method method)
protected void	validateMandatoryDelegates(Set<BandDefinition> bands)
protected void	validateMandatoryFormatDelegates(List<ReportValueFormat> formats)
protected void	validateMandatoryTemplateDelegates(List<ReportTemplate> templates)
protected <T> void	validateUniqueness(Collection<T> objects, Function<T,String> uniqueAttributeGetter, String errorMessage)

Methods inherited from class java.lang.Object

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

Field Details

metadata

protected final Metadata metadata

messages

protected final Messages messages

messageTools

protected final MessageTools messageTools

annotatedReportGroupHolder

protected final AnnotatedReportGroupHolder annotatedReportGroupHolder

resources

protected final Resources resources

roleExtractor

protected final AnnotatedReportRoleExtractor roleExtractor

parameterClassResolver

protected final ParameterClassResolver parameterClassResolver

screenExtractor

@Nullable
protected final AnnotatedReportScreenExtractor screenExtractor

classManager

protected final ClassManager classManager

annotatedBuilderUtils

protected final AnnotatedBuilderUtils annotatedBuilderUtils

Constructor Details

AnnotatedReportBuilderImpl

public AnnotatedReportBuilderImpl(Metadata metadata,
 Messages messages,
 MessageTools messageTools,
 AnnotatedBuilderUtils annotatedBuilderUtils,
 AnnotatedReportGroupHolder annotatedReportGroupHolder,
 Resources resources,
 AnnotatedReportRoleExtractor roleExtractor,
 ParameterClassResolver parameterClassResolver,
 @Autowired(required=false) @Nullable
 AnnotatedReportScreenExtractor screenExtractor,
 ClassManager classManager)

Method Details

createReportFromDefinition

public Report createReportFromDefinition(Object definitionInstance)

Description copied from interface: AnnotatedReportBuilder

Parse, validate given annotated report definition. Construct and return a model object.

Specified by:

createReportFromDefinition in interface AnnotatedReportBuilder

Parameters:

definitionInstance - instance of class annotated with ReportDef and other annotations

Returns:

constructed Report model object

assignReportParameters

protected void assignReportParameters(Report report,
 ReportDef annotation,
 Class<?> definitionClass)

assignGroup

protected void assignGroup(Report report,
 ReportDef annotation)

assignReportDelegates

protected void assignReportDelegates(Report report,
 Object definitionInstance)

validateDelegateCommon

protected void validateDelegateCommon(Method method)

extractInputParameters

protected List<ReportInputParameter> extractInputParameters(Report report,
 Object definitionInstance)

convertToInputParameter

protected ReportInputParameter convertToInputParameter(InputParameterDef annotation,
 Class<?> definitionClass)

assignInputParameterDelegates

protected void assignInputParameterDelegates(List<ReportInputParameter> inputParameters,
 Object definitionInstance)

extractTemplates

protected List<ReportTemplate> extractTemplates(Report report,
 Object definitionInstance)

validateMandatoryTemplateDelegates

protected void validateMandatoryTemplateDelegates(List<ReportTemplate> templates)

convertToTemplate

protected ReportTemplate convertToTemplate(TemplateDef annotation,
 Class<?> definitionClass)

convertToTableDescription

protected TemplateTableDescription convertToTableDescription(TemplateTableDef table,
 Class<?> definitionClass)

assignTemplateDelegates

protected void assignTemplateDelegates(List<ReportTemplate> templates,
 Object definitionInstance)

extractBands

protected Set<BandDefinition> extractBands(Report report,
 Object definitionInstance)

validateMandatoryDelegates

protected void validateMandatoryDelegates(Set<BandDefinition> bands)

extractDataSets

protected List<DataSet> extractDataSets(Report report,
 BandDefinition bandDefinition,
 DataSetDef[] dataSetDefs)

extractJsonDataSetParameters

protected void extractJsonDataSetParameters(Report report,
 JsonDataSetParameters jsonAnnotation,
 DataSet dataSet)

extractEntityDataSetParameters

protected void extractEntityDataSetParameters(DataSetDef annotation,
 Report report,
 DataSet dataSet,
 EntityDataSetDef entityAnnotation)

assignDataSetDelegates

protected void assignDataSetDelegates(Set<BandDefinition> bands,
 Object definitionInstance)

extractValueFormats

protected List<ReportValueFormat> extractValueFormats(Report report,
 Object definitionInstance)

convertToValueFormat

protected ReportValueFormat convertToValueFormat(Report report,
 ValueFormatDef annotation)

getValueName

protected String getValueName(String band,
 String field)

assignValueFormatDelegates

protected void assignValueFormatDelegates(List<ReportValueFormat> formats,
 Object definitionInstance)

validateMandatoryFormatDelegates

protected void validateMandatoryFormatDelegates(List<ReportValueFormat> formats)

findElementInListByUniqueName

protected <E,
A extends Annotation> E findElementInListByUniqueName(Collection<E> elements,
 String name,
 Function<E,String> elementNameExtractor,
 A annotation,
 String errorMessagePrefix)

obtainDelegateFromDefinition

protected <T> T obtainDelegateFromDefinition(Object reportDefinition,
 Method method,
 Class<T> delegateClass)

validateUniqueness

protected <T> void validateUniqueness(Collection<T> objects,
 Function<T,String> uniqueAttributeGetter,
 String errorMessage)