net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder 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.chart;

import net.sf.dynamicreports.report.base.chart.dataset.DRXyzChartSerie;
import net.sf.dynamicreports.report.builder.FieldBuilder;
import net.sf.dynamicreports.report.builder.VariableBuilder;
import net.sf.dynamicreports.report.builder.column.ValueColumnBuilder;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.definition.expression.DRIExpression;
import org.apache.commons.lang3.Validate;

/**
 * XyzChartSerieBuilder class.
 *
 * @author Ricardo Mariaca
 * 
 */
public class XyzChartSerieBuilder extends AbstractChartSerieBuilder {
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

    /**
     * Constructor for XyzChartSerieBuilder.
     */
    protected XyzChartSerieBuilder() {
        super(new DRXyzChartSerie());
    }

    // x

    /**
     * setXValue.
     *
     * @param column a {@link net.sf.dynamicreports.report.builder.column.ValueColumnBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setXValue(ValueColumnBuilder column) {
        Validate.notNull(column, "column must not be null");
        getObject().setXValueExpression(column.getColumn());
        return this;
    }

    /**
     * setXValue.
     *
     * @param field a {@link net.sf.dynamicreports.report.builder.FieldBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setXValue(FieldBuilder field) {
        Validate.notNull(field, "field must not be null");
        getObject().setXValueExpression(field.build());
        return this;
    }

    /**
     * setXValue.
     *
     * @param valueExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setXValue(DRIExpression valueExpression) {
        getObject().setXValueExpression(valueExpression);
        return this;
    }

    /**
     * setXValue.
     *
     * @param variable a {@link net.sf.dynamicreports.report.builder.VariableBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setXValue(VariableBuilder variable) {
        Validate.notNull(variable, "variable must not be null");
        getObject().setXValueExpression(variable.build());
        return this;
    }

    // y

    /**
     * setYValue.
     *
     * @param column a {@link net.sf.dynamicreports.report.builder.column.ValueColumnBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setYValue(ValueColumnBuilder column) {
        Validate.notNull(column, "column must not be null");
        getObject().setYValueExpression(column.getColumn());
        return this;
    }

    /**
     * setYValue.
     *
     * @param field a {@link net.sf.dynamicreports.report.builder.FieldBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setYValue(FieldBuilder field) {
        Validate.notNull(field, "field must not be null");
        getObject().setYValueExpression(field.build());
        return this;
    }

    /**
     * setYValue.
     *
     * @param valueExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setYValue(DRIExpression valueExpression) {
        getObject().setYValueExpression(valueExpression);
        return this;
    }

    /**
     * setYValue.
     *
     * @param variable a {@link net.sf.dynamicreports.report.builder.VariableBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setYValue(VariableBuilder variable) {
        Validate.notNull(variable, "variable must not be null");
        getObject().setYValueExpression(variable.build());
        return this;
    }

    // z

    /**
     * setZValue.
     *
     * @param column a {@link net.sf.dynamicreports.report.builder.column.ValueColumnBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setZValue(ValueColumnBuilder column) {
        Validate.notNull(column, "column must not be null");
        getObject().setZValueExpression(column.getColumn());
        return this;
    }

    /**
     * setZValue.
     *
     * @param field a {@link net.sf.dynamicreports.report.builder.FieldBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setZValue(FieldBuilder field) {
        Validate.notNull(field, "field must not be null");
        getObject().setZValueExpression(field.build());
        return this;
    }

    /**
     * setZValue.
     *
     * @param valueExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setZValue(DRIExpression valueExpression) {
        getObject().setZValueExpression(valueExpression);
        return this;
    }

    /**
     * setZValue.
     *
     * @param variable a {@link net.sf.dynamicreports.report.builder.VariableBuilder} object.
     * @return a {@link net.sf.dynamicreports.report.builder.chart.XyzChartSerieBuilder} object.
     */
    public XyzChartSerieBuilder setZValue(VariableBuilder variable) {
        Validate.notNull(variable, "variable must not be null");
        getObject().setZValueExpression(variable.build());
        return this;
    }

    /**
     * getChartSerie.
     *
     * @return a {@link net.sf.dynamicreports.report.base.chart.dataset.DRXyzChartSerie} object.
     */
    public DRXyzChartSerie getChartSerie() {
        return build();
    }
}