net.sf.jasperreports.parts.subreport.SubreportFillPart Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see parameterValues;
private FillDatasetPosition datasetPosition;
private boolean cacheIncluded;
private volatile BaseReportFiller subreportFiller;
public SubreportFillPart(SubreportPartComponent subreportPart, JRFillObjectFactory factory)
{
this.subreportPart = subreportPart;
this.expressionEvaluator = factory.getExpressionEvaluator();
this.returnValues = new FillReturnValues(subreportPart.getReturnValues(), factory, factory.getReportFiller());
this.returnValuesSource = new AbstractVariableReturnValueSourceContext()
{
@Override
public Object getValue(CommonReturnValue returnValue) {
return subreportFiller.getVariableValue(((VariableReturnValue)returnValue).getFromVariable());
}
@Override
public JRFillVariable getToVariable(String name) {
return fillContext.getFiller().getVariable(name);
}
@Override
public JRVariable getFromVariable(String name) {
return subreportFiller.getVariable(name);
}
};
}
@Override
public void evaluate(byte evaluation) throws JRException
{
jasperReportSource = evaluateReportSource(evaluation);
JRFillDataset parentDataset = expressionEvaluator.getFillDataset();
datasetPosition = new FillDatasetPosition(parentDataset.getFillPosition());
datasetPosition.addAttribute("subreportPartUUID", fillContext.getPart().getUUID());
parentDataset.setCacheRecordIndex(datasetPosition, evaluation);
String cacheIncludedProp = JRPropertiesUtil.getOwnProperty(fillContext.getPart(), DataCacheHandler.PROPERTY_INCLUDED);
cacheIncluded = JRPropertiesUtil.asBoolean(cacheIncludedProp, true);// default to true
//FIXMEBOOK do not evaluate REPORT_DATA_SOURCE
JasperReport jasperReport = getReport();
parameterValues = JRFillSubreport.getParameterValues(fillContext.getFiller(), expressionEvaluator,
subreportPart.getParametersMapExpression(), subreportPart.getParameters(),
evaluation, false,
jasperReport.getResourceBundle() != null, jasperReport.getFormatFactoryClass() != null);
setBookmarksParameter();
}
private JasperReportSource evaluateReportSource(byte evaluation) throws JRException
{
reportSource = fillContext.evaluate(subreportPart.getExpression(), evaluation);
return JRFillSubreport.getReportSource(reportSource, subreportPart.getUsingCache(),
fillContext.getFiller());
}
private JasperReport getReport()
{
return jasperReportSource == null ? null : jasperReportSource.getReport();
}
private void setBookmarksParameter()
{
JRPart part = fillContext.getPart();
String bookmarksParameter = part.hasProperties() ? part.getPropertiesMap().getProperty(PROPERTY_BOOKMARKS_DATA_SOURCE_PARAMETER) : null;
if (bookmarksParameter == null)
{
return;
}
if (bookmarksParameter.equals(JRParameter.REPORT_DATA_SOURCE))
{
// if the bookmarks data source is created as main data source for the part report,
// automatically exclude it from data snapshots as jive actions might result in different bookmarks.
// if the data source is not the main report data source people will have to manually inhibit data caching.
cacheIncluded = false;
}
BookmarkHelper bookmarks = fillContext.getFiller().getFirstBookmarkHelper();
BookmarksFlatDataSource bookmarksDataSource = new BookmarksFlatDataSource(bookmarks);
parameterValues.put(bookmarksParameter, bookmarksDataSource);
}
@Override
public void fill(PartPrintOutput output) throws JRException
{
subreportFiller = createSubreportFiller(output);
returnValues.checkReturnValues(returnValuesSource);
JRFillDataset subreportDataset = subreportFiller.getMainDataset();
subreportDataset.setFillPosition(datasetPosition);
subreportDataset.setCacheSkipped(!cacheIncluded);
subreportFiller.fill(parameterValues);
returnValues.copyValues(returnValuesSource);
}
protected BaseReportFiller createSubreportFiller(final PartPrintOutput output) throws JRException
{
SectionTypeEnum sectionType = getReport().getSectionType();
sectionType = sectionType == null ? SectionTypeEnum.BAND : sectionType;
BaseReportFiller filler;
switch (sectionType)
{
case BAND:
filler = createBandSubfiller(output);
break;
case PART:
filler = createPartSubfiller(output);
break;
default:
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_UNKNOWN_REPORT_SECTION_TYPE,
new Object[]{sectionType});
}
return filler;
}
protected JRBaseFiller createBandSubfiller(final PartPrintOutput output) throws JRException
{
BandReportFillerParent bandParent = new PartBandParent(output);
JRBaseFiller bandFiller;
JasperReport jasperReport = getReport();
switch (jasperReport.getPrintOrderValue())
{
case HORIZONTAL:
bandFiller = new JRHorizontalFiller(getJasperReportsContext(), jasperReportSource, bandParent);
break;
case VERTICAL:
bandFiller = new JRVerticalFiller(getJasperReportsContext(), jasperReportSource, bandParent);
break;
default:
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_UNKNOWN_REPORT_PRINT_ORDER,
new Object[]{jasperReport.getPrintOrderValue()});
}
bandFiller.addFillListener(new FillListener()
{
@Override
public void pageGenerated(JasperPrint jasperPrint, int pageIndex)
{
//NOP
}
@Override
public void pageUpdated(JasperPrint jasperPrint, int pageIndex)
{
output.pageUpdated(pageIndex);
}
});
return bandFiller;
}
protected BaseReportFiller createPartSubfiller(PartPrintOutput output) throws JRException
{
PartParent partParent = new PartParent(output);
PartReportFiller partFiller = new PartReportFiller(getJasperReportsContext(), jasperReportSource, partParent);
return partFiller;
}
protected String getPartName()
{
return fillContext.getFillPart().getPartName();
}
protected class PartBandParent implements BandReportFillerParent
{
private final PartPrintOutput output;
protected PartBandParent(PartPrintOutput output)
{
this.output = output;
}
@Override
public String getReportName()
{
return getReport().getName();
}
@Override
public BaseReportFiller getFiller()
{
return fillContext.getFiller();
}
@Override
public JRPropertiesHolder getParentProperties()
{
return null; // we avoid parts inheriting properties from master
}
@Override
public DatasetExpressionEvaluator getCachedEvaluator()
{
//FIXMEBOOK
return null;
}
@Override
public void registerSubfiller(JRBaseFiller filler)
{
//NOP
}
@Override
public void unregisterSubfiller(JRBaseFiller filler)
{
//NOP
}
@Override
public void abortSubfiller(JRBaseFiller filler)
{
//NOP
}
@Override
public boolean isRunToBottom()
{
return true;
}
@Override
public boolean isParentPagination()
{
return false;
}
@Override
public boolean isPageBreakInhibited()
{
return false;
}
@Override
public boolean isSplitTypePreventInhibited(boolean isTopLevelCall)
{
return true;
}
@Override
public void addPage(FillerPageAddedEvent pageAdded) throws JRException
{
if (pageAdded.getPageIndex() == 0)
{
//first page, adding the part info
SimplePrintPart printPart = SimplePrintPart.fromJasperPrint(pageAdded.getJasperPrint(), getPartName());
FillerPrintPart fillingPart = new FillerPrintPart(pageAdded.getFiller());//FIXMEBOOK strange
output.startPart(printPart, fillingPart);
}
output.addPage(pageAdded.getPage(), pageAdded.getDelayedActions());
fillContext.getFiller().recordUsedPageWidth(pageAdded.getFiller().getUsedPageWidth());
if (pageAdded.hasReportEnded())
{
output.addStyles(pageAdded.getJasperPrint().getStylesList());
output.addOrigins(pageAdded.getJasperPrint().getOriginsList());
}
}
@Override
public void updateBookmark(JRPrintElement element)
{
BookmarkHelper bookmarkHelper = output.getBookmarkHelper();
if (bookmarkHelper != null)
{
bookmarkHelper.updateBookmark(element);
}
}
@Override
public String getReportLocation()
{
return jasperReportSource == null ? null : jasperReportSource.getReportLocation();
}
@Override
public void registerReportStyles(List styles)
{
//NOP
}
}
protected static class FillerPrintPart implements FillingPrintPart
{
private final JRBaseFiller filler;
protected FillerPrintPart(JRBaseFiller filler)
{
this.filler = filler;
}
@Override
public boolean isPageFinal(JRPrintPage page)
{
return filler.isPageFinal(page);
}
}
protected class PartParent implements PartFillerParent
{
private PartPrintOutput output;
public PartParent(PartPrintOutput output)
{
this.output = output;
}
@Override
public PartReportFiller getFiller()
{
return fillContext.getFiller();
}
@Override
public JRPropertiesHolder getParentProperties()
{
return null; // we avoid parts inheriting properties from master
}
@Override
public DatasetExpressionEvaluator getCachedEvaluator()
{
//FIXMEBOOK
return null;
}
@Override
public void updateBookmark(JRPrintElement element)
{
BookmarkHelper bookmarkHelper = output.getBookmarkHelper();
if (bookmarkHelper != null)
{
bookmarkHelper.updateBookmark(element);
}
}
@Override
public boolean isParentPagination()
{
return false;
}
}
}