README.md

Collate.NET

Filtering, sorting and paging extensions for .NET IQueryable collections.

Enables convenient server-side dynamic queries via Entity Framework, especially useful when working with dynamic grid controls, like Kendo UI Grid and DevExpress, where you don't want to have to implement individual filtering and sorting for each field in the data which might be sorted or filtered on.

Usage

Let's say you have an MVC controller which accepts requests from a grid control:

using Collate.Implementation;

public UserController : Controller
{
	public ActionResult GetItems(int pageNumber, int pageSize, string sortField, string sortDirection, string filterField, string filterValue)
	{
		var request = new PageAndFilterAndSortRequest
		{
			PageNumber = pageNumber,
			PageSize = pageSize,
			Sorts = new ISort[]
			{
				new Sort
				{
					Field = sortField,
					Direction = (sortDirection == "asc")
						? SortDirection.Ascending
						: SortDirection.Descending
				}
			},
			Filters = new IFilter[]
			{
				new Filter
				{
					Field = filterField,
					Operator = FilterOperator.Contains,
					Value = filterValue
				}
			}
		};

		IList<User> data;

		using (var dbContext = new MyDataContext())
		{
			data = dbContext.Users
				.Filter(request)
				.Sort(request)
				.Page(request)
				.ToList();
		}

		return Json(data, JsonRequestBehavior.AllowGet);
	}
}

This way, all the control over what field(s) to filter and sort by are in the hands of the client, as well as controlling the page and page size of the data to be viewed, and yet all the filtering is done efficiently since Entity Framework will translate the IQueryable expression into a SQL query, and all the filtering, sorting and paging will be done in-database, and the response will be just the data that is needed to show the expected data in the grid.

This is also useful for N-Tier applications where you don't want to go the nuclear option and enable odata all the way up and down the pipeline. By impelmenting a few simple interfaces you can enable performant filtering and sorting in data-heavy applications without needing to re-architect your entire application.

Please refer to the Tests project within the solution for more usage examples.