net.sf.jasperreports.engine.JRSortField Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Free Java Reporting Library
There is a newer version: 6.21.2
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, 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 .
 */
package net.sf.jasperreports.engine;

import net.sf.jasperreports.engine.type.SortFieldTypeEnum;
import net.sf.jasperreports.engine.type.SortOrderEnum;


/**
 * Provides support for in-memory field-based data source sorting.
 * 
 * JasperReports supports in-memory field-based data source sorting. This functionality can
 * be used, for instance, when data sorting is required and the data source implementation
 * does not support it (as in the case of the CSV data source).
 * 

 * The sorting is activated by the presence of one or more <sortField> elements in the
 * report template. When at least one sort field is specified for the report, the original report
 * data source (either passed directly or provided by a query executer) is passed to a sorted 
 * {@link net.sf.jasperreports.engine.data.IndexedDataSource} instance that fetches all the records 
 * from it, performs an in-memory
 * sort according to the specified fields, and replaces the original data source in the
 * report-filling process.
 * 

 * The sort field name should coincide with a report field name. Fields used for sorting
 * should have types that implement java.util.Comparable. Sorting will be performed
 * using the natural order for all fields except those of type java.lang.String, for which
 * a collator corresponding to the report fill locale is used.
 * 
 * When several sort fields are specified, the sorting will be performed using the fields as
 * sort keys in the order in which they appear in the report template.
 * @author Teodor Danciu ([email protected])
 * @see net.sf.jasperreports.engine.data.IndexedDataSource
 * @see net.sf.jasperreports.engine.fill.DatasetSortUtil
 * @see net.sf.jasperreports.engine.fill.SortedDataSource
 */
public interface JRSortField extends JRCloneable
{


	/**
	 * Gets the sort field name.
	 */
	public String getName();
		
	/**
	 * Gets the sort order for the field.
	 */
	public SortOrderEnum getOrderValue();
		
	/**
	 * Gets the type of the sort field.
	 */
	public SortFieldTypeEnum getType();

}