/// <summary>
/// Apply the individual query to the given IQueryable in the right order.
/// </summary>
/// <param name="query">The original <see cref="IQueryable"/>.</param>
/// <param name="querySettings">The settings to use in query composition.</param>
/// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
public virtual IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings)
{
if (query == null)
{
throw Error.ArgumentNull(nameof(query));
}
if (querySettings == null)
{
throw Error.ArgumentNull(nameof(querySettings));
}
IQueryable result = query;
IODataFeature odataFeature = Request.ODataFeature();
// Update the query setting
querySettings = Context.UpdateQuerySettings(querySettings, query);
// First apply $apply
// Section 3.15 of the spec http://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs01/odata-data-aggregation-ext-v4.0-cs01.html#_Toc378326311
if (IsAvailableODataQueryOption(Apply, AllowedQueryOptions.Apply))
{
result = Apply.ApplyTo(result, querySettings);
odataFeature.ApplyClause = Apply.ApplyClause;
this.Context.ElementClrType = Apply.ResultClrType;
}
// TODO: need pass the result from $compute to the remaining query options
// Construct the actual query and apply them in the following order: filter, orderby, skip, top
if (IsAvailableODataQueryOption(Filter, AllowedQueryOptions.Filter))
{
if (IsAvailableODataQueryOption(Compute, AllowedQueryOptions.Compute))
{
Filter.Compute = Compute;
}
result = Filter.ApplyTo(result, querySettings);
}
// If both $search and $filter are specified in the same request, only those items satisfying both criteria are returned
// apply $search
if (IsAvailableODataQueryOption(Search, AllowedQueryOptions.Search))
{
result = Search.ApplyTo(result, querySettings);
}
if (IsAvailableODataQueryOption(Count, AllowedQueryOptions.Count))
{
if (odataFeature.TotalCountFunc == null)
{
Func <long> countFunc = Count.GetEntityCountFunc(result);
if (countFunc != null)
{
odataFeature.TotalCountFunc = countFunc;
}
}
if (Request.IsCountRequest())
{
return(result);
}
}
OrderByQueryOption orderBy = OrderBy;
// $skip or $top require a stable sort for predictable results.
// Result limits require a stable sort to be able to generate a next page link.
// If either is present in the query and we have permission,
// generate an $orderby that will produce a stable sort.
if (querySettings.EnsureStableOrdering &&
(IsAvailableODataQueryOption(Skip, AllowedQueryOptions.Skip) ||
IsAvailableODataQueryOption(Top, AllowedQueryOptions.Top) ||
querySettings.PageSize.HasValue))
{
// If there is no OrderBy present, we manufacture a default.
// If an OrderBy is already present, we add any missing
// properties necessary to make a stable sort.
// Instead of failing early here if we cannot generate the OrderBy,
// let the IQueryable backend fail (if it has to).
orderBy = GenerateStableOrder();
}
if (IsAvailableODataQueryOption(orderBy, AllowedQueryOptions.OrderBy))
{
if (IsAvailableODataQueryOption(Compute, AllowedQueryOptions.Compute))
{
orderBy.Compute = Compute;
}
result = orderBy.ApplyTo(result, querySettings);
}
if (IsAvailableODataQueryOption(SkipToken, AllowedQueryOptions.SkipToken))
{
result = SkipToken.ApplyTo(result, querySettings, this);
}
AddAutoSelectExpandProperties();
if (SelectExpand != null)
{
var tempResult = ApplySelectExpand(result, querySettings);
if (tempResult != default(IQueryable))
{
result = tempResult;
}
}
if (IsAvailableODataQueryOption(Skip, AllowedQueryOptions.Skip))
{
result = Skip.ApplyTo(result, querySettings);
}
if (IsAvailableODataQueryOption(Top, AllowedQueryOptions.Top))
{
result = Top.ApplyTo(result, querySettings);
}
result = ApplyPaging(result, querySettings);
return(result);
}
/// <summary>
/// Apply the individual query to the given IQueryable in the right order.
/// </summary>
/// <param name="query">The original <see cref="IQueryable"/>.</param>
/// <param name="querySettings">The settings to use in query composition.</param>
/// <param name="ignoreQueryOptions">The query parameters that are already applied in queries.</param>
/// <returns>The new <see cref="IQueryable"/> after the query has been applied to.</returns>
public virtual IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings, AllowedQueryOptions ignoreQueryOptions)
{
_ignoreQueryOptions = ignoreQueryOptions;
if (query == null)
{
throw Error.ArgumentNull("query");
}
// Construct the actual query and apply them in the following order: filter
if (IsAvailableODataQueryOption(Filter, AllowedQueryOptions.Filter))
{
query = Filter.ApplyTo(query, querySettings, _assembliesResolver);
}
if (IsAvailableODataQueryOption(Count, AllowedQueryOptions.Count))
{
if (Request.ODataProperties().TotalCountFunc == null)
{
Func <long> countFunc = Count.GetEntityCountFunc(query);
if (countFunc != null)
{
Request.ODataProperties().TotalCountFunc = countFunc;
}
}
if (ODataCountMediaTypeMapping.IsCountRequest(Request))
{
return(query);
}
}
OrderByQueryOption orderBy = OrderBy;
// $skip or $top require a stable sort for predictable results.
// Result limits require a stable sort to be able to generate a next page link.
// If either is present in the query and we have permission,
// generate an $orderby that will produce a stable sort.
if (querySettings.EnsureStableOrdering &&
(IsAvailableODataQueryOption(Skip, AllowedQueryOptions.Skip) ||
IsAvailableODataQueryOption(Top, AllowedQueryOptions.Top) ||
querySettings.PageSize.HasValue))
{
// If there is no OrderBy present, we manufacture a default.
// If an OrderBy is already present, we add any missing
// properties necessary to make a stable sort.
// Instead of failing early here if we cannot generate the OrderBy,
// let the IQueryable backend fail (if it has to).
orderBy = orderBy == null
? GenerateDefaultOrderBy(Context)
: EnsureStableSortOrderBy(orderBy, Context);
}
if (IsAvailableODataQueryOption(orderBy, AllowedQueryOptions.OrderBy))
{
query = orderBy.ApplyTo(query, querySettings);
}
if (IsAvailableODataQueryOption(Skip, AllowedQueryOptions.Skip))
{
query = Skip.ApplyTo(query, querySettings);
}
if (IsAvailableODataQueryOption(Top, AllowedQueryOptions.Top))
{
query = Top.ApplyTo(query, querySettings);
}
AddAutoExpandProperties(querySettings);
if (SelectExpand != null)
{
var tempResult = ApplySelectExpand(query, querySettings);
if (tempResult != default(IQueryable))
{
query = tempResult;
}
}
if (querySettings.PageSize.HasValue)
{
bool resultsLimited = true;
query = LimitResults(query, querySettings.PageSize.Value, out resultsLimited);
var uriString = Request.GetDisplayUrl();
if (!string.IsNullOrWhiteSpace(uriString))
{
var uri = new Uri(uriString);
if (resultsLimited && uri != null && uri.IsAbsoluteUri && Request.ODataProperties().NextLink == null)
{
Uri nextPageLink = Request.GetNextPageLink(querySettings.PageSize.Value);
Request.ODataProperties().NextLink = nextPageLink;
}
}
}
return(query);
}
