saherelm/xDataService
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add some Extensions Methods for XQuery Pages Counting ...

Browse Source
This commit is contained in:
saherelm
2025-11-04 18:10:53 +03:30
parent 4a64a13630
commit 0415364fea
1 changed files with 244 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Extensions/IQueryableExtensions.cs
+244 -136
View File
@@ -6,12 +6,16 @@ using System.Reflection;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using xCommons.Extensions;
using xDataService.Configuration;
using xDataService.Constants;
using xExceptions.Constants;
using xModels.Base;
using xModels.Dtos;
namespace xDataService.Extensions {
public static class IQueryableExtensions {
namespace xDataService.Extensions
{
public static class IQueryableExtensions
{
/// <summary>
/// Apply Search Filter on a Query
/// </summary>
@@ -19,14 +23,15 @@ namespace xDataService.Extensions {
/// <param name="filter"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IQueryable<T> ApplyFilter<T, TKey> (
public static IQueryable<T> ApplyFilter<T, TKey>(
this IQueryable<T> source,
string filter
)
where T : XBaseEntity<TKey> {
where T : XBaseEntity<TKey>
{
//
// Apply Filter ...
return source.Where (r => r.PropValuesContains (filter));
return source.Where(r => r.PropValuesContains(filter));
}
/// <summary>
@@ -36,38 +41,41 @@ namespace xDataService.Extensions {
/// <param name="filter"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static async Task<IQueryable<T>> ApplyFilterAsync<T, TKey> (
public static async Task<IQueryable<T>> ApplyFilterAsync<T, TKey>(
this IQueryable<T> source,
string filter
)
where T : XBaseEntity<TKey> {
where T : XBaseEntity<TKey>
{
//
// Where Clause ...
Expression<Func<T, bool>> whereClause = r => r
.PropValuesContains (filter);
.PropValuesContains(filter);
//
// Generate Where Function ...
var whereFunc = whereClause.Compile ();
var whereFunc = whereClause.Compile();
//
// Get Enumerable ...
var enumerator = source
.AsAsyncEnumerable ();
.AsAsyncEnumerable();
//
var result = new List<T> ();
var result = new List<T>();
await
foreach (var entity in enumerator) {
foreach (var entity in enumerator)
{
//
var isApproved = whereFunc (entity);
if (isApproved) {
result.Add (entity);
var isApproved = whereFunc(entity);
if (isApproved)
{
result.Add(entity);
}
}
//
return result.AsQueryable ();
return result.AsQueryable();
}
/// <summary>
@@ -77,40 +85,43 @@ namespace xDataService.Extensions {
/// <param name="filter"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static async Task<IEnumerable<T>> ApplyFilterAsync<T, TKey> (
public static async Task<IEnumerable<T>> ApplyFilterAsync<T, TKey>(
this IEnumerable<T> source,
string filter
)
where T : XBaseEntity<TKey> {
where T : XBaseEntity<TKey>
{
//
// Where Clause ...
Expression<Func<T, bool>> whereClause = r => r
.PropValuesContains (filter);
.PropValuesContains(filter);
//
// Generate Where Function ...
var whereFunc = whereClause.Compile ();
var whereFunc = whereClause.Compile();
//
// Get Enumerable ...
var enumerator = source
.AsQueryable ()
.AsAsyncEnumerable ();
.AsQueryable()
.AsAsyncEnumerable();
//
var result = new List<T> ();
var result = new List<T>();
await
foreach (var entity in enumerator) {
foreach (var entity in enumerator)
{
//
var isApproved = whereFunc (entity);
if (isApproved) {
result.Add (entity);
var isApproved = whereFunc(entity);
if (isApproved)
{
result.Add(entity);
}
}
//
return result
.AsEnumerable ();
.AsEnumerable();
}
/// <summary>
@@ -120,14 +131,15 @@ namespace xDataService.Extensions {
/// <param name="filter"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IEnumerable<T> ApplyFilter<T> (
public static IEnumerable<T> ApplyFilter<T>(
this IEnumerable<T> source,
string filter
)
where T : class {
where T : class
{
//
// Apply Filter ...
return source.Where (r => r.PropValuesContains (filter));
return source.Where(r => r.PropValuesContains(filter));
}
/// <summary>
@@ -137,43 +149,46 @@ namespace xDataService.Extensions {
/// <param name="propertyName"></param>
/// <typeparam name="TSource"></typeparam>
/// <returns></returns>
public static IOrderedQueryable<TSource> OrderBy<TSource> (
public static IOrderedQueryable<TSource> OrderBy<TSource>(
this IQueryable<TSource> query,
string propertyName
) {
)
{
//
var entityType = typeof (TSource);
var entityType = typeof(TSource);
//
// Create x => x.PropName
var propertyInfo = entityType.GetProperty (propertyName);
if (propertyInfo.IsNull ()) {
XException.InvalidArgs.Throw ();
var propertyInfo = entityType.GetProperty(propertyName);
if (propertyInfo.IsNull())
{
XException.InvalidArgs.Throw();
}
//
ParameterExpression arg = Expression.Parameter (entityType, "x");
MemberExpression property = Expression.Property (arg, propertyName);
var selector = Expression.Lambda (property, new ParameterExpression[] { arg });
ParameterExpression arg = Expression.Parameter(entityType, "x");
MemberExpression property = Expression.Property(arg, propertyName);
var selector = Expression.Lambda(property, new ParameterExpression[] { arg });
//
// Get System.Linq.Queryable.OrderBy() method.
var enumarableType = typeof (System.Linq.Queryable);
var method = enumarableType.GetMethods ()
.Where (m => m.Name == "OrderBy" && m.IsGenericMethodDefinition)
.Where (m => {
var enumarableType = typeof(System.Linq.Queryable);
var method = enumarableType.GetMethods()
.Where(m => m.Name == "OrderBy" && m.IsGenericMethodDefinition)
.Where(m =>
{
//
var parameters = m.GetParameters ().ToList ();
var parameters = m.GetParameters().ToList();
//
// Put more restriction here to ensure selecting the right overload
return parameters.Count == 2; // overload that has 2 parameters
}).Single ();
}).Single();
//
// The linq's OrderBy<TSource, TKey> has two generic types, which provided here ...
MethodInfo genericMethod = method
.MakeGenericMethod (entityType, propertyInfo.PropertyType);
.MakeGenericMethod(entityType, propertyInfo.PropertyType);
/*
Call query.OrderBy(selector), with query and selector: x=> x.PropName
@@ -181,8 +196,8 @@ namespace xDataService.Extensions {
By doing so EF can extract "order by" columns and generate SQL for it.
*/
var newQuery = (IOrderedQueryable<TSource>) genericMethod
.Invoke (genericMethod, new object[] { query, selector });
var newQuery = (IOrderedQueryable<TSource>)genericMethod
.Invoke(genericMethod, new object[] { query, selector });
//
return newQuery;
@@ -195,19 +210,21 @@ namespace xDataService.Extensions {
/// <param name="propertyName"></param>
/// <typeparam name="TSource"></typeparam>
/// <returns></returns>
public static IOrderedEnumerable<TSource> OrderBy<TSource> (
public static IOrderedEnumerable<TSource> OrderBy<TSource>(
this IEnumerable<TSource> query,
string propertyName
) {
)
{
//
var entityType = typeof (TSource);
var propertyInfo = entityType.GetProperty (propertyName);
if (propertyInfo.IsNull ()) {
XException.InvalidArgs.Throw ();
var entityType = typeof(TSource);
var propertyInfo = entityType.GetProperty(propertyName);
if (propertyInfo.IsNull())
{
XException.InvalidArgs.Throw();
}
//
return query.OrderBy (x => propertyInfo.GetValue (x, null));
return query.OrderBy(x => propertyInfo.GetValue(x, null));
}
/// <summary>
@@ -217,43 +234,46 @@ namespace xDataService.Extensions {
/// <param name="propertyName"></param>
/// <typeparam name="TSource"></typeparam>
/// <returns></returns>
public static IOrderedQueryable<TSource> OrderByDescending<TSource> (
public static IOrderedQueryable<TSource> OrderByDescending<TSource>(
this IQueryable<TSource> query,
string propertyName
) {
)
{
//
var entityType = typeof (TSource);
var entityType = typeof(TSource);
//
// Create x => x.PropName
var propertyInfo = entityType.GetProperty (propertyName);
if (propertyInfo.IsNull ()) {
XException.InvalidArgs.Throw ();
var propertyInfo = entityType.GetProperty(propertyName);
if (propertyInfo.IsNull())
{
XException.InvalidArgs.Throw();
}
//
ParameterExpression arg = Expression.Parameter (entityType, "x");
MemberExpression property = Expression.Property (arg, propertyName);
var selector = Expression.Lambda (property, new ParameterExpression[] { arg });
ParameterExpression arg = Expression.Parameter(entityType, "x");
MemberExpression property = Expression.Property(arg, propertyName);
var selector = Expression.Lambda(property, new ParameterExpression[] { arg });
//
// Get System.Linq.Queryable.OrderBy() method.
var enumarableType = typeof (System.Linq.Queryable);
var method = enumarableType.GetMethods ()
.Where (m => m.Name == "OrderByDescending" && m.IsGenericMethodDefinition)
.Where (m => {
var enumarableType = typeof(System.Linq.Queryable);
var method = enumarableType.GetMethods()
.Where(m => m.Name == "OrderByDescending" && m.IsGenericMethodDefinition)
.Where(m =>
{
//
var parameters = m.GetParameters ().ToList ();
var parameters = m.GetParameters().ToList();
//
// Put more restriction here to ensure selecting the right overload
return parameters.Count == 2; // overload that has 2 parameters
}).Single ();
}).Single();
//
// The linq's OrderBy<TSource, TKey> has two generic types, which provided here ...
MethodInfo genericMethod = method
.MakeGenericMethod (entityType, propertyInfo.PropertyType);
.MakeGenericMethod(entityType, propertyInfo.PropertyType);
/*
Call query.OrderBy(selector), with query and selector: x=> x.PropName
@@ -261,8 +281,8 @@ namespace xDataService.Extensions {
By doing so EF can extract "order by" columns and generate SQL for it.
*/
var newQuery = (IOrderedQueryable<TSource>) genericMethod
.Invoke (genericMethod, new object[] { query, selector });
var newQuery = (IOrderedQueryable<TSource>)genericMethod
.Invoke(genericMethod, new object[] { query, selector });
//
return newQuery;
@@ -275,19 +295,21 @@ namespace xDataService.Extensions {
/// <param name="propertyName"></param>
/// <typeparam name="TSource"></typeparam>
/// <returns></returns>
public static IOrderedEnumerable<TSource> OrderByDescending<TSource> (
public static IOrderedEnumerable<TSource> OrderByDescending<TSource>(
this IEnumerable<TSource> query,
string propertyName
) {
)
{
//
var entityType = typeof (TSource);
var propertyInfo = entityType.GetProperty (propertyName);
if (propertyInfo.IsNull ()) {
XException.InvalidArgs.Throw ();
var entityType = typeof(TSource);
var propertyInfo = entityType.GetProperty(propertyName);
if (propertyInfo.IsNull())
{
XException.InvalidArgs.Throw();
}
//
return query.OrderByDescending (x => propertyInfo.GetValue (x, null));
return query.OrderByDescending(x => propertyInfo.GetValue(x, null));
}
/// <summary>
@@ -299,21 +321,24 @@ namespace xDataService.Extensions {
/// <param name="columnsMap"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IQueryable<T> ApplySorting<T, TKey> (
public static IQueryable<T> ApplySorting<T, TKey>(
this IQueryable<T> source,
string sortBy,
bool isAscending,
IDictionary<string, Expression<Func<T, object>>> columnsMap = null
)
where T : XBaseEntity<TKey> {
where T : XBaseEntity<TKey>
{
//
if (columnsMap == null) {
if (columnsMap == null)
{
//
columnsMap = source.FirstOrDefault ()
.GetDefaultColumnsMap ();
columnsMap = source.FirstOrDefault()
.GetDefaultColumnsMap();
//
if (columnsMap == null) {
if (columnsMap == null)
{
return source;
}
}
@@ -321,18 +346,22 @@ namespace xDataService.Extensions {
//
// Validate SortBy ...
var sortByItem = columnsMap.Keys
.FirstOrDefault (p =>
p.ToNormalString () == sortBy.ToNormalString ());
if (sortByItem.IsNullOrEmpty ()) {
.FirstOrDefault(p =>
p.ToNormalString() == sortBy.ToNormalString());
if (sortByItem.IsNullOrEmpty())
{
return source;
}
//
// Apply Sorting ...
if (isAscending) {
return source.OrderBy (sortByItem);
} else {
return source.OrderByDescending (sortByItem);
if (isAscending)
{
return source.OrderBy(sortByItem);
}
else
{
return source.OrderByDescending(sortByItem);
}
}
@@ -345,21 +374,24 @@ namespace xDataService.Extensions {
/// <param name="columnsMap"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IEnumerable<T> ApplySorting<T, TKey> (
public static IEnumerable<T> ApplySorting<T, TKey>(
this IEnumerable<T> source,
string sortBy,
bool isAscending,
IDictionary<string, Expression<Func<T, object>>> columnsMap = null
)
where T : XBaseEntity<TKey> {
where T : XBaseEntity<TKey>
{
//
if (columnsMap == null) {
if (columnsMap == null)
{
//
columnsMap = source.FirstOrDefault ()
.GetDefaultColumnsMap ();
columnsMap = source.FirstOrDefault()
.GetDefaultColumnsMap();
//
if (columnsMap == null) {
if (columnsMap == null)
{
return source;
}
}
@@ -367,18 +399,22 @@ namespace xDataService.Extensions {
//
// Validate SortBy ...
var sortByItem = columnsMap.Keys
.FirstOrDefault (p =>
p.ToNormalString () == sortBy.ToNormalString ());
if (sortByItem.IsNullOrEmpty ()) {
.FirstOrDefault(p =>
p.ToNormalString() == sortBy.ToNormalString());
if (sortByItem.IsNullOrEmpty())
{
return source;
}
//
// Apply Sorting ...
if (isAscending) {
return source.OrderBy (sortByItem);
} else {
return source.OrderByDescending (sortByItem);
if (isAscending)
{
return source.OrderBy(sortByItem);
}
else
{
return source.OrderByDescending(sortByItem);
}
}
@@ -391,21 +427,24 @@ namespace xDataService.Extensions {
/// <param name="columnsMap"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IEnumerable<T> ApplySorting<T> (
public static IEnumerable<T> ApplySorting<T>(
this IEnumerable<T> source,
string sortBy,
bool isAscending,
IDictionary<string, Expression<Func<T, object>>> columnsMap = null
)
where T : class {
where T : class
{
//
if (columnsMap == null) {
if (columnsMap == null)
{
//
columnsMap = source.FirstOrDefault ()
.GetDefaultColumnsMap ();
columnsMap = source.FirstOrDefault()
.GetDefaultColumnsMap();
//
if (columnsMap == null) {
if (columnsMap == null)
{
return source;
}
}
@@ -413,18 +452,22 @@ namespace xDataService.Extensions {
//
// Validate SortBy ...
var sortByItem = columnsMap.Keys
.FirstOrDefault (p =>
p.ToNormalString () == sortBy.ToNormalString ());
if (sortByItem.IsNullOrEmpty ()) {
.FirstOrDefault(p =>
p.ToNormalString() == sortBy.ToNormalString());
if (sortByItem.IsNullOrEmpty())
{
return source;
}
//
// Apply Sorting ...
if (isAscending) {
return source.OrderBy (sortByItem);
} else {
return source.OrderByDescending (sortByItem);
if (isAscending)
{
return source.OrderBy(sortByItem);
}
else
{
return source.OrderByDescending(sortByItem);
}
}
@@ -436,32 +479,35 @@ namespace xDataService.Extensions {
/// <param name="pageSize"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IQueryable<T> ApplyPaging<T> (
public static IQueryable<T> ApplyPaging<T>(
this IQueryable<T> source,
int? page,
int? pageSize
) {
)
{
//
if (!page.HasValue ||
page <= 0) {
page <= 0)
{
page = 1;
}
//
if (!pageSize.HasValue ||
pageSize <= 0 ||
pageSize > XDataServiceConstants.MAX_AVAILABLE_PAGE_SIZE) {
pageSize > XDataServiceConstants.MAX_AVAILABLE_PAGE_SIZE)
{
pageSize = XDataServiceConstants.DEFAULT_PAGE_SIZE;
}
//
var pageVal = page.GetValueOrDefault ();
var pageSizeVal = pageSize.GetValueOrDefault ();
var pageVal = page.GetValueOrDefault();
var pageSizeVal = pageSize.GetValueOrDefault();
//
return source
.Skip ((pageVal - 1) * pageSizeVal)
.Take (pageSizeVal);
.Skip((pageVal - 1) * pageSizeVal)
.Take(pageSizeVal);
}
/// <summary>
@@ -472,32 +518,94 @@ namespace xDataService.Extensions {
/// <param name="pageSize"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static IEnumerable<T> ApplyPaging<T> (
public static IEnumerable<T> ApplyPaging<T>(
this IEnumerable<T> source,
int? page,
int? pageSize
) {
)
{
//
if (!page.HasValue ||
page <= 0) {
page <= 0)
{
page = 1;
}
//
if (!pageSize.HasValue ||
pageSize <= 0 ||
pageSize > XDataServiceConstants.MAX_AVAILABLE_PAGE_SIZE) {
pageSize > XDataServiceConstants.MAX_AVAILABLE_PAGE_SIZE)
{
pageSize = XDataServiceConstants.DEFAULT_PAGE_SIZE;
}
//
var pageVal = page.GetValueOrDefault ();
var pageSizeVal = pageSize.GetValueOrDefault ();
var pageVal = page.GetValueOrDefault();
var pageSizeVal = pageSize.GetValueOrDefault();
//
return source
.Skip ((pageVal - 1) * pageSizeVal)
.Take (pageSizeVal);
.Skip((pageVal - 1) * pageSizeVal)
.Take(pageSizeVal);
}
/// <summary>
/// Count Query Pages based on Specified Total Number ...
/// </summary>
/// <param name="source"></param>
/// <param name="totalItems"></param>
/// <returns></returns>
public static int CountPages(this XQuery source, int totalItems)
{
//
int result = 0;
//
// Validate and Calculate ...
if (!source.IsNull() && source.PageSize > 0 && totalItems > 0)
{
//
result = totalItems / source.PageSize;
if (totalItems % source.PageSize > 0)
{
result++;
}
}
//
return result;
}
/// <summary>
/// Normalize an XQuery based on Data Service Configurations ...
/// </summary>
/// <param name="source"></param>
/// <param name="configuration"></param>
/// <returns></returns>
public static XQuery NormalizeQuery(
this XQuery source,
XDataServiceConfiguration configuration //
)
{
//
if (source.IsNull())
{
source = new XQuery();
}
//
// Page Size Normalization ...
if (source.PageSize < configuration.PagingConfiguration.MinAvailablePageSize)
{
source.PageSize = configuration.PagingConfiguration.MinAvailablePageSize;
}
if (source.PageSize > configuration.PagingConfiguration.MaxAvailablePageSize)
{
source.PageSize = configuration.PagingConfiguration.MaxAvailablePageSize;
}
//
return source;
}
}
}