Class EntityCollectionProperty<T>

Namespace

The.Relationships

Assembly

Instagile.dll

A one-to-many-T foreign key

public sealed class EntityCollectionProperty<T> : EntityCollectionProperty, IEntitySet<T>, IFrozenQuery<T>, IEntityQuery<T>, IEntityQuery, IDisposable, ILazy<ILoadedSet<T>>, ILazy, ILoadedSet<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable, INotifyCollectionChanged, IProperty, IOwned, IHasChanges, IVisitor<IEntityQuery<T>> where T : IEntity<T>

Type Parameters

T

Inheritance

object

RelationshipProperty

EntityCollectionProperty

EntityCollectionProperty<T>

Implements

IEntitySet<T>

IFrozenQuery<T>

IEntityQuery<T>

IEntityQuery

IDisposable

ILazy<ILoadedSet<T>>

ILazy

ILoadedSet<T>

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

INotifyCollectionChanged

IProperty

IOwned

IHasChanges

IVisitor<IEntityQuery<T>>

Inherited Members

EntityCollectionProperty.IsInitialised

EntityCollectionProperty.IsPresent

EntityCollectionProperty.WasModifiedWhileUnloaded

EntityCollectionProperty.EagerLoad(Mutation, IEnumerable<IEntity>)

EntityCollectionProperty.Count

EntityCollectionProperty.MarkUnchanged()

EntityCollectionProperty.CollectionChanged

RelationshipProperty.Parent

RelationshipProperty.Metadata

RelationshipProperty.Loaded

RelationshipProperty.EnsurePresent()

RelationshipProperty.EnsurePresentAsync(CancellationToken?)

RelationshipProperty.ToString()

RelationshipProperty.TrackedKernels

RelationshipProperty.GetAllAsync(CancellationToken?)

RelationshipProperty.GetAllAsLoaded()

RelationshipProperty.HasChanges()

RelationshipProperty.NeedsSave()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

EntityQueryExtensions.AsReadOperation(IEntityQuery, TranslationPolicy?)

EntityQueryExtensions.Cast<TResult>(IEntityQuery)

EntityQueryExtensions.ToQueryable(IEntityQuery)

EntityQueryExtensions.AllAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>, CancellationToken?)

EntityQueryExtensions.All<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>)

EntityQueryExtensions.AnyAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>, CancellationToken?)

EntityQueryExtensions.AnyAsync<TSource>(IEntityQuery<TSource>, CancellationToken?)

EntityQueryExtensions.Any<TSource>(IEntityQuery<TSource>)

EntityQueryExtensions.Any<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>)

EntityQueryExtensions.AsReadOperation<T>(IEntityQuery<T>, TranslationPolicy?)

EntityQueryExtensions.AverageAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, decimal>>, CancellationToken?)

EntityQueryExtensions.AverageAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, double>>, CancellationToken?)

EntityQueryExtensions.AverageAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, int>>, CancellationToken?)

EntityQueryExtensions.AverageAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, long>>, CancellationToken?)

EntityQueryExtensions.AverageAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, float>>, CancellationToken?)

EntityQueryExtensions.Average<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, decimal>>)

EntityQueryExtensions.Average<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, double>>)

EntityQueryExtensions.Average<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, int>>)

EntityQueryExtensions.Average<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, long>>)

EntityQueryExtensions.Average<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, float>>)

EntityQueryExtensions.ChangeContext<T>(IEntityQuery<T>, IEntityContext)

EntityQueryExtensions.Concat<TSource>(IEntityQuery<TSource>, IEntityQuery<TSource>)

EntityQueryExtensions.CountAsync<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>, CancellationToken?)

EntityQueryExtensions.CountAsync<TSource>(IEntityQuery<TSource>, CancellationToken?)

EntityQueryExtensions.Count<TSource>(IEntityQuery<TSource>)

EntityQueryExtensions.Count<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>)

EntityQueryExtensions.Distinct<TSource>(IEntityQuery<TSource>)

EntityQueryExtensions.ElementAtAsync<T>(IEntityQuery<T>, int, CancellationToken?)

EntityQueryExtensions.ElementAtOrDefaultAsync<T>(IEntityQuery<T>, int, CancellationToken?)

EntityQueryExtensions.ElementAtOrDefault<T>(IEntityQuery<T>, int)

EntityQueryExtensions.ElementAt<T>(IEntityQuery<T>, int)

EntityQueryExtensions.Except<TSource>(IEntityQuery<TSource>, IEntityQuery<TSource>)

EntityQueryExtensions.FirstAsync<T>(IEntityQuery<T>, Expression<Func<T, bool>>, CancellationToken?)

EntityQueryExtensions.FirstAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.FirstOrDefaultAsync<T>(IEntityQuery<T>, Expression<Func<T, bool>>, CancellationToken?)

EntityQueryExtensions.FirstOrDefaultAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.FirstOrDefault<T>(IEntityQuery<T>)

EntityQueryExtensions.FirstOrDefault<T>(IEntityQuery<T>, Expression<Func<T, bool>>)

EntityQueryExtensions.First<T>(IEntityQuery<T>)

EntityQueryExtensions.First<T>(IEntityQuery<T>, Expression<Func<T, bool>>)

EntityQueryExtensions.FreezeAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.Freeze<T>(IEntityQuery<T>)

EntityQueryExtensions.Include<T>(IEntityQuery<T>, IEnumerable<RelationshipPath>, bool)

EntityQueryExtensions.Include<T>(IEntityQuery<T>, IEntityInfo, bool)

EntityQueryExtensions.Include<T>(IEntityQuery<T>, RelationshipInfo, bool)

EntityQueryExtensions.Include<T>(IEntityQuery<T>, RelationshipPath, bool)

EntityQueryExtensions.Include<T, U>(IEntityQuery<T>, Expression<Func<T, IEntityQuery<U>>>, bool)

EntityQueryExtensions.Include<T, U>(IEntityQuery<T>, Expression<Func<T, IEntitySet<U>>>, bool)

EntityQueryExtensions.Include<T, U>(IEntityQuery<T>, Expression<Func<T, IEntityPath<U>>>, bool)

EntityQueryExtensions.Include<T, U>(IEntityQuery<T>, Expression<Func<T, U?>>, bool)

EntityQueryExtensions.Intersect<TSource>(IEntityQuery<TSource>, IEntityQuery<TSource>)

EntityQueryExtensions.MaxAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.MaxAsync<T, U>(IEntityQuery<T>, Expression<Func<T, U>>, CancellationToken?)

EntityQueryExtensions.Max<T>(IEntityQuery<T>)

EntityQueryExtensions.Max<T, U>(IEntityQuery<T>, Expression<Func<T, U>>)

EntityQueryExtensions.MinAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.MinAsync<T, U>(IEntityQuery<T>, Expression<Func<T, U>>, CancellationToken?)

EntityQueryExtensions.Min<T>(IEntityQuery<T>)

EntityQueryExtensions.Min<T, U>(IEntityQuery<T>, Expression<Func<T, U>>)

EntityQueryExtensions.OrderByDescending<T>(IEntityQuery<T>, PropertyInfo)

EntityQueryExtensions.OrderByDescending<TSource, TKey>(IEntityQuery<TSource>, Expression<Func<TSource, TKey>>)

EntityQueryExtensions.OrderBy<T>(IEntityQuery<T>, PropertyInfo)

EntityQueryExtensions.OrderBy<T>(IEntityQuery<T>, PropertyInfo, bool)

EntityQueryExtensions.OrderBy<TSource, TKey>(IEntityQuery<TSource>, Expression<Func<TSource, TKey>>)

EntityQueryExtensions.SelectIDPairs<T>(IEntityQuery<T>, RelationshipInfo)

EntityQueryExtensions.SelectMany<TSource, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, int, IEntitySet<TResult>>>)

EntityQueryExtensions.SelectMany<TSource, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, IEntityQuery<TResult>>>)

EntityQueryExtensions.SelectMany<TSource, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, IEntitySet<TResult>>>)

EntityQueryExtensions.SelectMany<TSource, TCollection, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, int, IEntitySet<TCollection>>>, Expression<Func<TSource, TCollection, TResult>>)

EntityQueryExtensions.SelectMany<TSource, TCollection, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, IEntitySet<TCollection>>>, Expression<Func<TSource, TCollection, TResult>>)

EntityQueryExtensions.Select<T>(IEntityQuery<T>, RelationshipInfo)

EntityQueryExtensions.Select<T>(IEntityQuery<T>, RelationshipPath)

EntityQueryExtensions.Select<TSource, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, int, TResult>>)

EntityQueryExtensions.Select<TSource, TEntity>(IEntityQuery<TSource>, Expression<Func<TSource, IEntityPath<TEntity>>>)

EntityQueryExtensions.Select<TSource, TResult>(IEntityQuery<TSource>, Expression<Func<TSource, TResult>>)

EntityQueryExtensions.Select<T, U>(IEntityQuery<T>, AttributeInfo)

EntityQueryExtensions.Select<T, U>(IEntityQuery<T>, RelationshipInfo)

EntityQueryExtensions.SingleAsync<T>(IEntityQuery<T>, Expression<Func<T, bool>>, CancellationToken?)

EntityQueryExtensions.SingleAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.SingleOrDefaultAsync<T>(IEntityQuery<T>, Expression<Func<T, bool>>, CancellationToken?)

EntityQueryExtensions.SingleOrDefaultAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.SingleOrDefault<T>(IEntityQuery<T>)

EntityQueryExtensions.SingleOrDefault<T>(IEntityQuery<T>, Expression<Func<T, bool>>)

EntityQueryExtensions.Single<T>(IEntityQuery<T>)

EntityQueryExtensions.Single<T>(IEntityQuery<T>, Expression<Func<T, bool>>)

EntityQueryExtensions.Skip<TSource>(IEntityQuery<TSource>, int)

EntityQueryExtensions.SumAsync<T>(IEntityQuery<T>, Expression<Func<T, decimal>>, CancellationToken?)

EntityQueryExtensions.SumAsync<T>(IEntityQuery<T>, Expression<Func<T, double>>, CancellationToken?)

EntityQueryExtensions.SumAsync<T>(IEntityQuery<T>, Expression<Func<T, int>>, CancellationToken?)

EntityQueryExtensions.SumAsync<T>(IEntityQuery<T>, Expression<Func<T, long>>, CancellationToken?)

EntityQueryExtensions.SumAsync<T>(IEntityQuery<T>, Expression<Func<T, float>>, CancellationToken?)

EntityQueryExtensions.Sum<T>(IEntityQuery<T>, Expression<Func<T, decimal>>)

EntityQueryExtensions.Sum<T>(IEntityQuery<T>, Expression<Func<T, double>>)

EntityQueryExtensions.Sum<T>(IEntityQuery<T>, Expression<Func<T, int>>)

EntityQueryExtensions.Sum<T>(IEntityQuery<T>, Expression<Func<T, long>>)

EntityQueryExtensions.Sum<T>(IEntityQuery<T>, Expression<Func<T, float>>)

EntityQueryExtensions.Take<TSource>(IEntityQuery<TSource>, int)

EntityQueryExtensions.ToArrayAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.ToArray<T>(IEntityQuery<T>)

EntityQueryExtensions.ToDictionaryAsync<T, TKey>(IEntityQuery<T>, Func<T, TKey>, IEqualityComparer<TKey>, CancellationToken?)

EntityQueryExtensions.ToDictionaryAsync<T, TKey>(IEntityQuery<T>, Func<T, TKey>, CancellationToken?)

EntityQueryExtensions.ToDictionaryAsync<T, TKey, TElement>(IEntityQuery<T>, Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>, CancellationToken?)

EntityQueryExtensions.ToDictionaryAsync<T, TKey, TElement>(IEntityQuery<T>, Func<T, TKey>, Func<T, TElement>, CancellationToken?)

EntityQueryExtensions.ToHashSetAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.ToHashSet<T>(IEntityQuery<T>)

EntityQueryExtensions.ToListAsync<T>(IEntityQuery<T>, CancellationToken?)

EntityQueryExtensions.ToList<T>(IEntityQuery<T>)

EntityQueryExtensions.ToLookupAsync<T, TKey>(IEntityQuery<T>, Func<T, TKey>, IEqualityComparer<TKey>, CancellationToken?)

EntityQueryExtensions.ToLookupAsync<T, TKey>(IEntityQuery<T>, Func<T, TKey>, CancellationToken?)

EntityQueryExtensions.ToLookupAsync<T, TKey, TElement>(IEntityQuery<T>, Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>, CancellationToken?)

EntityQueryExtensions.ToLookupAsync<T, TKey, TElement>(IEntityQuery<T>, Func<T, TKey>, Func<T, TElement>, CancellationToken?)

EntityQueryExtensions.ToQueryable<T>(IEntityQuery<T>)

EntityQueryExtensions.Union<TSource>(IEntityQuery<TSource>, IEntityQuery<TSource>)

EntityQueryExtensions.Where<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, bool>>)

EntityQueryExtensions.Where<TSource>(IEntityQuery<TSource>, Expression<Func<TSource, int, bool>>)

EntityQueryExtensions.WithReadUncommitted<T>(IEntityQuery<T>)

QueryCacheExtensions.Cached<T>(IEntityQuery<T>, RequestOptions?)

Constructors

EntityCollectionProperty(RelationshipInfo, EntityKernel)

public EntityCollectionProperty(RelationshipInfo metadata, EntityKernel parent)

Parameters

metadata RelationshipInfo

parent EntityKernel

Properties

CacheState

Whether data was loaded from the entity cache and, if so, whether it's up to date.

public ResultState CacheState { get; }

Property Value

ResultState

ElementType

Gets the type of the element(s) that are returned when the expression tree associated with this instance of IEntityQuery is executed.

public Type ElementType { get; }

Property Value

Type

Expression

Gets the expression tree that is associated with the instance of IEntityQuery.

public Expression Expression { get; }

Property Value

Expression

OriginalValue

public IEntityQuery<T> OriginalValue { get; }

Property Value

IEntityQuery<T>

Provider

Gets the query provider that is associated with this data source.

public IEntityQueryProvider Provider { get; }

Property Value

IEntityQueryProvider

Methods

Add(IEntity)

public override void Add(IEntity item)

Parameters

item IEntity

Add(T)

public void Add(T item)

Parameters

item T

AddAsync(IEntity, CancellationToken?)

public Task AddAsync(IEntity item, CancellationToken? cancellationToken = null)

Parameters

item IEntity

cancellationToken CancellationToken?

Returns

Task

AddAsync(T, CancellationToken?)

public Task AddAsync(T item, CancellationToken? cancellationToken = null)

Parameters

item T

cancellationToken CancellationToken?

Returns

Task

AddRange(IEnumerable<IEntity>)

public override void AddRange(IEnumerable<IEntity> items)

Parameters

items IEnumerable<IEntity>

AddRange(IEnumerable<T>)

public void AddRange(IEnumerable<T> items)

Parameters

items IEnumerable<T>

AddRangeAsync(IEnumerable<T>, CancellationToken?)

public Task AddRangeAsync(IEnumerable<T> items, CancellationToken? cancellationToken = null)

Parameters

items IEnumerable<T>

cancellationToken CancellationToken?

Returns

Task

AsLoaded()

Asserts that the property object is loaded and returns it; never performs I/O.

public ILoadedSet<T> AsLoaded()

Returns

ILoadedSet<T>

Exceptions

InvalidOperationException

Thrown if the property or any reference along the path to it is unloaded.

AsUnloaded()

Assert that the set is unloaded and treat it as a datastore query.

public IEntityQuery<T> AsUnloaded()

Returns

IEntityQuery<T>

Remarks

An empty set is always considered loaded. Calling this method on an empty set will cause an exception to be thrown.

Exceptions

InvalidOperationException

Thrown if the set is partially or entirely loaded.

Clear()

public override void Clear()

ClearAsync(CancellationToken?)

public override Task ClearAsync(CancellationToken? cancellationToken = null)

Parameters

cancellationToken CancellationToken?

Returns

Task

Clone(IEntityContext?)

public EntityCollectionProperty<T> Clone(IEntityContext? context = null)

Parameters

context IEntityContext

Returns

EntityCollectionProperty<T>

Contains(IEntity?)

protected override bool Contains(IEntity? item)

Parameters

item IEntity

Returns

bool

Contains(T?)

public bool Contains(T? item)

Parameters

item T

Returns

bool

ContainsAsync(T?, CancellationToken?)

public Task<bool> ContainsAsync(T? item, CancellationToken? cancellationToken = null)

Parameters

item T

cancellationToken CancellationToken?

Returns

Task<bool>

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

EagerLoad(IEnumerable<T>)

public void EagerLoad(IEnumerable<T> entities)

Parameters

entities IEnumerable<T>

EagerLoad(params T[])

public void EagerLoad(params T[] entities)

Parameters

entities T[]

GetEnumerator()

public IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>

GetRelatedEntities()

protected override IEnumerable<IEntity> GetRelatedEntities()

Returns

IEnumerable<IEntity>

GetRelatedEntitiesAsync(RelationshipPath[], CancellationToken?)

protected override Task<IEnumerable<IEntity>> GetRelatedEntitiesAsync(RelationshipPath[] includeRelationships, CancellationToken? cancellationToken)

Parameters

includeRelationships RelationshipPath[]

cancellationToken CancellationToken?

Returns

Task<IEnumerable<IEntity>>

GetRelatedEntitiesCachedAsync(RelationshipPath[], RequestOptions, CancellationToken?)

protected override Task<IEnumerable<IEntity>> GetRelatedEntitiesCachedAsync(RelationshipPath[] includeRelationships, RequestOptions options, CancellationToken? cancellationToken)

Parameters

includeRelationships RelationshipPath[]

options RequestOptions

cancellationToken CancellationToken?

Returns

Task<IEnumerable<IEntity>>

IsInMemory()

Returns true if the frozen query is at least partially-loaded. In-memory queries should not be transformed into ReadOperations for batching.

public bool IsInMemory()

Returns

bool

LoadAsync(CancellationToken?)

Loads the property object in at most one read batch.

public Task<ILoadedSet<T>> LoadAsync(CancellationToken? cancellationToken = null)

Parameters

cancellationToken CancellationToken?

Returns

Task<ILoadedSet<T>>

LoadAsync(RelationshipPath[], CancellationToken?)

Loads the property object and related data in at most one read batch.

public Task<ILoadedSet<T>> LoadAsync(RelationshipPath[] includeRelationships, CancellationToken? cancellationToken = null)

Parameters

includeRelationships RelationshipPath[]

cancellationToken CancellationToken?

Returns

Task<ILoadedSet<T>>

LoadCachedAsync(RequestOptions?, CancellationToken?)

Loads the property object and related data in at most one read batch. Uses the entity cache if possible. If the result was stale, ValueChanged will be raised after validation.

public Task<ILoadedSet<T>> LoadCachedAsync(RequestOptions? options = null, CancellationToken? cancellationToken = null)

Parameters

options RequestOptions

cancellationToken CancellationToken?

Returns

Task<ILoadedSet<T>>

LoadCachedAsync(RequestOptions?, RelationshipPath[], CancellationToken?)

Loads the property object and related data in at most one read batch. Uses the entity cache if possible. If the result was stale, ValueChanged will be raised after validation.

public Task<ILoadedSet<T>> LoadCachedAsync(RequestOptions? options, RelationshipPath[] includes, CancellationToken? cancellationToken = null)

Parameters

options RequestOptions

includes RelationshipPath[]

cancellationToken CancellationToken?

Returns

Task<ILoadedSet<T>>

Remove(IEntity)

public override void Remove(IEntity item)

Parameters

item IEntity

Remove(T)

public void Remove(T item)

Parameters

item T

RemoveAsync(IEntity, CancellationToken?)

public Task RemoveAsync(IEntity item, CancellationToken? cancellationToken = null)

Parameters

item IEntity

cancellationToken CancellationToken?

Returns

Task

RemoveAsync(T, CancellationToken?)

public Task RemoveAsync(T item, CancellationToken? cancellationToken = null)

Parameters

item T

cancellationToken CancellationToken?

Returns

Task

RemoveRange(IEnumerable<IEntity>)

public override void RemoveRange(IEnumerable<IEntity> items)

Parameters

items IEnumerable<IEntity>

RemoveRange(IEnumerable<T>)

public void RemoveRange(IEnumerable<T> items)

Parameters

items IEnumerable<T>

RemoveRangeAsync(IEnumerable<T>, CancellationToken?)

public Task RemoveRangeAsync(IEnumerable<T> items, CancellationToken? cancellationToken = null)

Parameters

items IEnumerable<T>

cancellationToken CancellationToken?

Returns

Task

ReplaceAll(IEnumerable<T>)

public void ReplaceAll(IEnumerable<T> entities)

Parameters

entities IEnumerable<T>

ReplaceAll(IEntitySet<T>)

public void ReplaceAll(IEntitySet<T> entities)

Parameters

entities IEntitySet<T>

ReplaceAllAsync(IEnumerable<T>, CancellationToken?)

public Task ReplaceAllAsync(IEnumerable<T> entities, CancellationToken? cancellationToken = null)

Parameters

entities IEnumerable<T>

cancellationToken CancellationToken?

Returns

Task