net.sf.dynamicreports.report.builder.SortBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
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.

The newest version!

/*
 * 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;

import net.sf.dynamicreports.report.base.DRSort;
import net.sf.dynamicreports.report.builder.column.TextColumnBuilder;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.OrderType;
import net.sf.dynamicreports.report.definition.expression.DRIExpression;
import org.apache.commons.lang3.Validate;

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

    /**
     * Constructor for SortBuilder.
     *
     * @param column a {@link net.sf.dynamicreports.report.builder.column.TextColumnBuilder} object.
     */
    protected SortBuilder(TextColumnBuilder column) {
        super(new DRSort());
        Validate.notNull(column, "column must not be null");
        getObject().setExpression(column.build());
    }

    /**
     * Constructor for SortBuilder.
     *
     * @param field a {@link net.sf.dynamicreports.report.builder.FieldBuilder} object.
     */
    protected SortBuilder(FieldBuilder field) {
        super(new DRSort());
        Validate.notNull(field, "field must not be null");
        getObject().setExpression(field.build());
    }

    /**
     * Constructor for SortBuilder.
     *
     * @param variable a {@link net.sf.dynamicreports.report.builder.VariableBuilder} object.
     */
    protected SortBuilder(VariableBuilder variable) {
        super(new DRSort());
        Validate.notNull(variable, "variable must not be null");
        getObject().setExpression(variable.build());
    }

    /**
     * Constructor for SortBuilder.
     *
     * @param expression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
     */
    protected SortBuilder(DRIExpression expression) {
        super(new DRSort());
        getObject().setExpression(expression);
    }

    /**
     * setOrderType.
     *
     * @param orderType a {@link net.sf.dynamicreports.report.constant.OrderType} object.
     * @return a {@link net.sf.dynamicreports.report.builder.SortBuilder} object.
     */
    public SortBuilder setOrderType(OrderType orderType) {
        getObject().setOrderType(orderType);
        return this;
    }
}