net.sf.dynamicreports.report.builder.subtotal.AggregationSubtotalBuilder Maven / Gradle / Ivy

/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 *
 * 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 .
 */
package net.sf.dynamicreports.report.builder.subtotal;

import net.sf.dynamicreports.report.base.DRVariable;
import net.sf.dynamicreports.report.builder.FieldBuilder;
import net.sf.dynamicreports.report.builder.column.ColumnBuilder;
import net.sf.dynamicreports.report.builder.column.ValueColumnBuilder;
import net.sf.dynamicreports.report.builder.datatype.DataTypes;
import net.sf.dynamicreports.report.constant.Calculation;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.Evaluation;
import net.sf.dynamicreports.report.constant.SubtotalPosition;
import net.sf.dynamicreports.report.definition.DRIField;
import net.sf.dynamicreports.report.definition.DRIValue;
import net.sf.dynamicreports.report.definition.column.DRIValueColumn;
import net.sf.dynamicreports.report.definition.expression.DRIExpression;
import net.sf.dynamicreports.report.exception.DRReportException;

/**
 * AggregationSubtotalBuilder class.
 *
 * @author Ricardo Mariaca
 * 
 */
public class AggregationSubtotalBuilder extends SubtotalBuilder, T> implements DRIValue {
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

    private DRIExpression expression;
    private Calculation calculation;

    // column

    /**
     * Constructor for AggregationSubtotalBuilder.
     *
     * @param column      a {@link net.sf.dynamicreports.report.builder.column.ValueColumnBuilder} object.
     * @param calculation a {@link net.sf.dynamicreports.report.constant.Calculation} object.
     */
    protected AggregationSubtotalBuilder(ValueColumnBuilder column, Calculation calculation) {
        this(column.getColumn(), column, calculation);
    }

    // field

    /**
     * Constructor for AggregationSubtotalBuilder.
     *
     * @param field        a {@link net.sf.dynamicreports.report.builder.FieldBuilder} object.
     * @param showInColumn a {@link net.sf.dynamicreports.report.builder.column.ColumnBuilder} object.
     * @param calculation  a {@link net.sf.dynamicreports.report.constant.Calculation} object.
     */
    protected AggregationSubtotalBuilder(FieldBuilder field, ColumnBuilder showInColumn, Calculation calculation) {
        this(field.build(), showInColumn, calculation);
    }

    // expression

    /**
     * Constructor for AggregationSubtotalBuilder.
     *
     * @param expression   a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @param showInColumn a {@link net.sf.dynamicreports.report.builder.column.ColumnBuilder} object.
     * @param calculation  a {@link net.sf.dynamicreports.report.constant.Calculation} object.
     */
    protected AggregationSubtotalBuilder(DRIExpression expression, ColumnBuilder showInColumn, Calculation calculation) {
        super(showInColumn);
        this.expression = expression;
        this.calculation = calculation;
        if (calculation.equals(Calculation.COUNT) || calculation.equals(Calculation.DISTINCT_COUNT)) {
            setDataType(DataTypes.longType());
        } else if (calculation.equals(Calculation.AVERAGE) || calculation.equals(Calculation.STANDARD_DEVIATION) || calculation.equals(Calculation.VARIANCE)) {
            setDataType(DataTypes.doubleType());
        } else if (expression instanceof DRIValueColumn) {
            setDataType(((DRIValueColumn) expression).getComponent().getDataType());
            setPattern(((DRIValueColumn) expression).getComponent().getPattern());
        } else if (expression instanceof DRIField) {
            setDataType(((DRIField) expression).getDataType());
        }
    }

    private static Evaluation subtotalPositionToEvaluation(SubtotalPosition position) {
        switch (position) {
            case PAGE_HEADER:
            case PAGE_FOOTER:
                return Evaluation.PAGE;
            case COLUMN_HEADER:
            case COLUMN_FOOTER:
                return Evaluation.COLUMN;
            case GROUP_HEADER:
            case GROUP_FOOTER:
                return Evaluation.GROUP;
            case FIRST_GROUP_HEADER:
            case FIRST_GROUP_FOOTER:
                return Evaluation.FIRST_GROUP;
            case LAST_GROUP_HEADER:
            case LAST_GROUP_FOOTER:
                return Evaluation.LAST_GROUP;
            case TITLE:
            case LAST_PAGE_FOOTER:
            case SUMMARY:
                return Evaluation.REPORT;
            default:
                throw new DRReportException("Subtotal position " + position.name() + " not supported");
        }
    }

    /** {@inheritDoc} */
    @Override
    protected void configure() {
        DRVariable subtotalVariable = new DRVariable(expression, calculation);
        Evaluation resetType = subtotalPositionToEvaluation(getObject().getPosition());
        subtotalVariable.setResetType(resetType);
        subtotalVariable.setResetGroup(getObject().getGroup());
        setValueExpression(subtotalVariable);

        super.configure();
    }

    /** {@inheritDoc} */
    @Override
    public String getName() {
        return getSubtotal().getName();
    }
}