net.sf.dynamicreports.design.transformation.GroupTransform Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
Show all versions of dynamicreports-core Show documentation
DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer.
You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.
/**
* DynamicReports - Free Java reporting library for creating reports dynamically
*
* Copyright (C) 2010 - 2016 Ricardo Mariaca
* http://www.dynamicreports.org
*
* This file is part of DynamicReports.
*
* DynamicReports 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.
*
* DynamicReports 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 DynamicReports. If not, see designGroups;
private List> hideGroupColumns;
private DRIGroup firstResetPageNumberGroup;
private int groupPadding;
public GroupTransform(DesignTransformAccessor accessor) {
this.accessor = accessor;
init();
}
private void init() {
DRIReport report = accessor.getReport();
groups = report.getGroups();
designGroups = new LinkedHashMap();
hideGroupColumns = new ArrayList>();
groupPadding = 0;
}
public void transform() throws DRException {
for (DRIGroup group : groups) {
DRDesignGroup designGroup = group(group);
addGroup(group, designGroup);
}
}
private void addGroup(DRIGroup group, DRDesignGroup designGroup) {
if (accessor.getTemplateTransform().isGroupHideColumn(group) && group.getValueField().getValueExpression() instanceof DRIValueColumn) {
hideGroupColumns.add((DRIValueColumn) group.getValueField().getValueExpression());
}
designGroups.put(group, designGroup);
if (firstResetPageNumberGroup == null && designGroup.isResetPageNumber()) {
firstResetPageNumberGroup = group;
}
groupPadding += accessor.getTemplateTransform().getGroupPadding(group);
}
public void transformHeaderAndFooter() throws DRException {
int groupPadding = 0;
int level = 0;
for (DRIGroup group : groups) {
headerAndFooter(group, designGroups.get(group), groupPadding, level++);
groupPadding += accessor.getTemplateTransform().getGroupPadding(group);
}
}
private void headerAndFooter(DRIGroup group, DRDesignGroup designGroup, int groupPadding, int level) throws DRException {
DRDesignList header = new DRDesignList();
TemplateTransform templateTransform = accessor.getTemplateTransform();
DRDesignTableOfContentsHeading designTocHeading = accessor.getTableOfContentsTransform().groupHeading(group, level);
if (designTocHeading != null) {
header.addComponent(designTocHeading.getReferenceField());
}
switch (templateTransform.getGroupHeaderLayout(group)) {
case EMPTY:
break;
case TITLE_AND_VALUE:
if (groupPadding > 0) {
DRDesignFiller filler = new DRDesignFiller();
filler.setWidth(groupPadding);
filler.setHeight(0);
header.addComponent(HorizontalCellComponentAlignment.CENTER, null, filler);
}
header.addComponent(HorizontalCellComponentAlignment.LEFT, null, titleComponent(group));
DRDesignTextField valueComponent = valueComponent(group);
header.addComponent(valueComponent);
if (designTocHeading != null) {
valueComponent.setAnchorNameExpression(designTocHeading.getReferenceField().getAnchorNameExpression());
valueComponent.setBookmarkLevel(designTocHeading.getReferenceField().getBookmarkLevel());
valueComponent.setHyperLink(designTocHeading.getReferenceField().getHyperLink());
}
break;
case VALUE:
if (groupPadding > 0) {
DRDesignFiller filler = new DRDesignFiller();
filler.setWidth(groupPadding);
filler.setHeight(0);
header.addComponent(HorizontalCellComponentAlignment.CENTER, null, filler);
}
valueComponent = valueComponent(group);
header.addComponent(valueComponent);
if (designTocHeading != null) {
valueComponent.setAnchorNameExpression(designTocHeading.getReferenceField().getAnchorNameExpression());
valueComponent.setBookmarkLevel(designTocHeading.getReferenceField().getBookmarkLevel());
valueComponent.setHyperLink(designTocHeading.getReferenceField().getHyperLink());
}
break;
default:
throw new DRDesignReportException("Group header layout " + templateTransform.getGroupHeaderLayout(group).name() + " not supported");
}
if (!header.isEmpty()) {
DRIBand bnd = group.getHeaderBand();
DRDesignBand band = accessor.getBandTransform().band("groupHeaderTitleAndValue", bnd, templateTransform.getGroupHeaderSplitType(bnd), templateTransform.getGroupHeaderStyle(bnd), templateTransform.getGroupHeaderBackgroundComponent(bnd));
band.addComponent(header);
designGroup.addHeaderBand(band);
}
DRIBand band = group.getHeaderBand();
designGroup.addHeaderBand(groupBand("groupHeader", band, templateTransform.getGroupHeaderSplitType(band), templateTransform.getGroupHeaderStyle(band), templateTransform.getGroupHeaderBackgroundComponent(band), groupPadding, designGroup));
band = group.getFooterBand();
designGroup.addFooterBand(groupBand("groupFooter", band, templateTransform.getGroupFooterSplitType(band), templateTransform.getGroupFooterStyle(band), templateTransform.getGroupFooterBackgroundComponent(band), groupPadding, designGroup));
if (templateTransform.isGroupShowColumnHeaderAndFooter(group)) {
designGroup.addHeaderBand(accessor.getBandTransform().getColumnHeaderForGroupBand());
designGroup.addFooterBand(accessor.getBandTransform().getColumnFooterBand());
}
}
private DRDesignBand groupBand(String name, DRIBand band, SplitType splitType, DRIReportStyle defaultStyle, DRIComponent defaultBackgroundComponent, int groupPadding, DRDesignGroup resetGroup) throws DRException {
DRDesignBand designBand = accessor.getBandTransform().band(name, band, splitType, defaultStyle, defaultBackgroundComponent, ResetType.GROUP, resetGroup);
if (groupPadding > 0) {
DRDesignFiller filler = new DRDesignFiller();
filler.setWidth(groupPadding);
filler.setHeight(0);
DRDesignList list = new DRDesignList();
list.addComponent(HorizontalCellComponentAlignment.CENTER, null, filler);
list.addComponent(designBand.getList());
designBand.setList(list);
}
return designBand;
}
//title
@SuppressWarnings("unchecked")
private DRDesignComponent titleComponent(DRIGroup group) throws DRException {
@SuppressWarnings("rawtypes")
DRTextField titleField = new DRTextField();
titleField.setValueExpression(group.getTitleExpression());
titleField.setStyle(group.getTitleStyle());
titleField.setWidth(group.getTitleWidth());
DRDesignTextField designTitleField = accessor.getComponentTransform().textField(titleField, DefaultStyleType.GROUP_TITLE);
designTitleField.setUniqueName("group_" + group.getName() + ".title");
return designTitleField;
}
//value
private DRDesignTextField valueComponent(DRIGroup group) throws DRException {
DRDesignTextField designValueField = accessor.getComponentTransform().textField(group.getValueField(), DefaultStyleType.GROUP);
designValueField.setUniqueName("group_" + group.getName());
return designValueField;
}
//group
@SuppressWarnings({ "unchecked", "rawtypes" })
private DRDesignGroup group(DRIGroup group) throws DRException {
TemplateTransform templateTransform = accessor.getTemplateTransform();
DRDesignGroup designGroup = new DRDesignGroup(group.getName());
designGroup.setStartInNewPage(templateTransform.isGroupStartInNewPage(group));
designGroup.setStartInNewColumn(templateTransform.isGroupStartInNewColumn(group));
designGroup.setReprintHeaderOnEachPage(templateTransform.isGroupReprintHeaderOnEachPage(group));
designGroup.setResetPageNumber(templateTransform.isGroupResetPageNumber(group));
designGroup.setMinHeightToStartNewPage(templateTransform.getGroupMinHeightToStartNewPage(group));
designGroup.setFooterPosition(templateTransform.getGroupFooterPosition(group));
designGroup.setKeepTogether(templateTransform.isGroupKeepTogether(group));
designGroup.setHeaderWithSubtotal(templateTransform.isGroupHeaderWithSubtotal(group));
DRIExpression groupExpression = group.getValueField().getValueExpression();
if (templateTransform.isGroupByDataType(group) && group.getValueField().getDataType() != null) {
accessor.getExpressionTransform().transformExpression(groupExpression);
DRIDataType dataType = group.getValueField().getDataType();
groupExpression = new GroupByDataTypeExpression(groupExpression, dataType);
}
groupExpression = new DRVariable(groupExpression, Calculation.NOTHING);
designGroup.setGroupExpression(accessor.getExpressionTransform().transformExpression(groupExpression));
return designGroup;
}
protected DRDesignGroup getGroup(DRIGroup group) {
return designGroups.get(group);
}
protected DRIGroup getFirstGroup() {
if (!groups.isEmpty()) {
return groups.get(0);
}
return null;
}
protected DRIGroup getBeforeGroup(DRIGroup group) {
if (groups.size() > 1 && groups.indexOf(group) > 0) {
return groups.get(groups.indexOf(group) - 1);
}
return null;
}
protected DRIGroup getLastGroup() {
if (!groups.isEmpty()) {
return groups.get(groups.size() - 1);
}
return null;
}
protected DRIGroup getFirstResetPageNumberGroup() {
return firstResetPageNumberGroup;
}
protected int getGroupPadding() {
return groupPadding;
}
protected List> getHideGroupColumns() {
return hideGroupColumns;
}
public Collection getGroups() {
return designGroups.values();
}
}