Package io.jmix.reports.yarg.reporting

Class DataExtractorImpl

java.lang.Object

io.jmix.reports.yarg.reporting.DataExtractorImpl

All Implemented Interfaces:

DataExtractor

Direct Known Subclasses:

JmixDataExtractor

@NullMarked
public class DataExtractorImpl
extends Object
implements DataExtractor

Field Summary

Fields

Modifier and Type	Field	Description
protected ExtractionContextFactory	contextFactory
protected ExtractionControllerFactory	controllerFactory
protected ReportLoaderFactory	loaderFactory
protected boolean	putEmptyRowIfNoDataSelected

Constructor Summary

Constructors

Constructor	Description
DataExtractorImpl(ReportLoaderFactory loaderFactory)

Method Summary

Modifier and Type	Method	Description
protected List<BandData>	createBands(ReportBand definition, BandData parentBandData, Map<String,Object> params)
protected ExtractionContextFactory	createContextFactory()
protected ExtractionControllerFactory	createControllerFactory()
void	extractData(Report report, Map<String,Object> params, BandData rootBand)	Extracts all band data of the report into rootBand.
void	extractData(Report report, Map<String,Object> params, BandData rootBand, Set<String> excludedBandNames)	Same as DataExtractor.extractData(Report, Map, BandData), but bands whose names are in excludedBandNames are not extracted (their data is supplied by other means, e.g.
ExtractionControllerFactory	getExtractionControllerFactory()
boolean	getPutEmptyRowIfNoDataSelected()
void	setExtractionControllerFactory(ExtractionControllerFactory controllerFactory)
void	setPutEmptyRowIfNoDataSelected(boolean putEmptyRowIfNoDataSelected)

Methods inherited from class java.lang.Object

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

Field Details

loaderFactory

protected ReportLoaderFactory loaderFactory

contextFactory

protected ExtractionContextFactory contextFactory

controllerFactory

protected ExtractionControllerFactory controllerFactory

putEmptyRowIfNoDataSelected

protected boolean putEmptyRowIfNoDataSelected

Constructor Details

DataExtractorImpl

public DataExtractorImpl(ReportLoaderFactory loaderFactory)

Method Details

createContextFactory

protected ExtractionContextFactory createContextFactory()

createControllerFactory

protected ExtractionControllerFactory createControllerFactory()

extractData

public void extractData(Report report,
 Map<String,Object> params,
 BandData rootBand)

Extracts all band data of the report into rootBand.

Note for subclasses: this method delegates to extractData(Report, Map, BandData, Set), which is the canonical override point. An override of only this 3-arg method is NOT invoked on the streaming report path (the engine calls the 4-arg variant directly) — override the 4-arg method to customize both paths.

Specified by:

extractData in interface DataExtractor

extractData

public void extractData(Report report,
 Map<String,Object> params,
 BandData rootBand,
 Set<String> excludedBandNames)

Description copied from interface: DataExtractor

Same as DataExtractor.extractData(Report, Map, BandData), but bands whose names are in excludedBandNames are not extracted (their data is supplied by other means, e.g. a streaming cursor). Their names are still registered as first-level definitions.

The default implementation supports only an empty exclusion set and throws otherwise: silently extracting an excluded band would load the streaming band's whole dataset into memory and run its query twice. Implementations that should work with streaming reports must override this method (see DataExtractorImpl).

Specified by:

extractData in interface DataExtractor

setPutEmptyRowIfNoDataSelected

public void setPutEmptyRowIfNoDataSelected(boolean putEmptyRowIfNoDataSelected)

getPutEmptyRowIfNoDataSelected

public boolean getPutEmptyRowIfNoDataSelected()

Specified by:

getPutEmptyRowIfNoDataSelected in interface DataExtractor

getExtractionControllerFactory

public ExtractionControllerFactory getExtractionControllerFactory()

setExtractionControllerFactory

public void setExtractionControllerFactory(ExtractionControllerFactory controllerFactory)

createBands

protected List<BandData> createBands(ReportBand definition,
 BandData parentBandData,
 Map<String,Object> params)