Dynamically applies filtering, sorting, and paging (and optional selecting) to IEnumerable, IQueryable, and DbSet objects using either a JSON-friendly spec or a query-string spec.
The full specification for filtering, sorting, paging, and selecting is represented by a simple, JSON-friendly hierarchical structure. The library also supports a more simplified spec for query-string processing (see below).
{
filter:
[
[
{
property: "Name",
operation: "Eq",
stringValue: "AliceBlue"
}
],
[
{
property: "Red",
operation: "Eq",
stringValue: "0"
},
{
property: "Blue",
operation: "Eq",
stringValue: "0"
}
]
],
sort:
[
{
property: "Red",
direction: "Ascending"
},
{
property: "Green",
direction: "Ascending"
}
],
page:
{
pageNumber: 2,
pageSize: 3
},
select: [ "Name", "DateCreated"]
}The filtering specification is a two-dimensional array of objects, which can be interpreted as a filter table. Each row in the filter table (an outer array element) represents an intersection (AND-ed) over one or more expression units. Each expression unit consists of a property name, and operation, and a literal value (as a string). Currently supported operations are: Eq, Lt, Le, Gt, Ge, Contains, StartsWith, and EndsWith. All filter rows are unioned (OR-ed) to provide the complete filter. This is analogous to the filtering table in the design mode of a Microsoft Access query.
In the above example, we select all objects where Name = "AliceBlue" or where both Red and Blue properties were equal to zero.
The sorting specification is a one-dimensional array of objects, where each object provides a property name and sort direction.
In the above example, we sort by Red (ascending) and then by Green (ascending)
The paging specification is a single object consisting of a page number and page size.
In the above example, we return the second page, where each page holds three objects.
The optional selecting specification is a single array consisting of property names to include.
In the above example, we select the Name and DateCreated properties. Note: selection will return an IQueryable whose member type is anonymous, rather than an IQueryable of the source element type.
The library also supports a Contoso-University-Project-inspired spec for query-string processing of filtering, sorting, paging, and optional selecting. Filtering is specified by a searchString query parameter (which uses the Contains operation). Sorting is specified by a sortOrder query parameter. The value of the sortOrder parameter is the name of the field to sort on, with an optional "_desc" suffix. (There is a constructor overload for mapping sortOrder parameter values to field names and sort direction, just in case this kind of flexibility is required.) Paging is accomplished with pageNumber and pageSize query parameters. Selecting is accomplished with either an array of properties (if hardcoding on the server side) or a comma-delimited string (if passed in via URL).
The test project in this solution includes examples of filtering, sorting, and paging (and optional selecting) using the full (JSON body) spec and filtering, sorting, and paging using the simplified (query string) spec.