Class EntitySchemaQueryExpressionCollection
Collection of expressions of the entity schema query.
Inheritance
Implements
Inherited Members
Namespace: Terrasoft.Core.Entities
Assembly: Terrasoft.Core.dll
Syntax
public class EntitySchemaQueryExpressionCollection : FactoryMetaItemCollection<EntitySchemaQueryExpression>, IList<EntitySchemaQueryExpression>, ICollection<EntitySchemaQueryExpression>, IList, ICollection, IReadOnlyList<EntitySchemaQueryExpression>, IReadOnlyCollection<EntitySchemaQueryExpression>, IEnumerable<EntitySchemaQueryExpression>, IEnumerable, IMetaDataSerializable, ITempalteSerializable, ICloneable
Constructors
EntitySchemaQueryExpressionCollection(EntitySchemaQuery)
Initializes the EntitySchemaQueryExpressionCollection instance for the specified entity schema query.
Declaration
public EntitySchemaQueryExpressionCollection(EntitySchemaQuery parentQuery)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQuery | parentQuery | Query against the entity schema. |
EntitySchemaQueryExpressionCollection(EntitySchemaQueryExpressionCollection)
Initializes the EntitySchemaQueryExpressionCollection instance that is a clone of the passed-in collection of expressions.
Declaration
public EntitySchemaQueryExpressionCollection(EntitySchemaQueryExpressionCollection source)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollection | source | Instance of the EntitySchemaQueryExpressionCollection collection whose clone is being created. |
Properties
IsInCollectionCleared
Determines whether the handling of the CollectionCleared event is performed.
Declaration
public bool IsInCollectionCleared { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInCollectionClearing
Determines whether the handling of the CollectionClearing event is performed.
Declaration
public bool IsInCollectionClearing { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionChanged
Determines whether the handling of the QueryExpressionChanged event is performed.
Declaration
public bool IsInQueryExpressionChanged { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionChanging
Determines whether the handling of the QueryExpressionChanging event is performed.
Declaration
public bool IsInQueryExpressionChanging { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionInserted
Determines whether the handling of the QueryExpressionInserted event is performed.
Declaration
public bool IsInQueryExpressionInserted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionInserting
Determines whether the handling of the QueryExpressionInserting event is performed.
Declaration
public bool IsInQueryExpressionInserting { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionRemoved
Determines whether the handling of the QueryExpressionRemoved event is performed.
Declaration
public bool IsInQueryExpressionRemoved { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInQueryExpressionRemoving
Determines whether the handling of the QueryExpressionRemoving event is performed.
Declaration
public bool IsInQueryExpressionRemoving { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ParentQuery
Query against the entity schema, which contains the collection of expressions.
Declaration
public EntitySchemaQuery ParentQuery { get; set; }
Property Value
Type | Description |
---|---|
EntitySchemaQuery |
Methods
ClearItems()
Declaration
protected override void ClearItems()
Overrides
Clone()
Gets the System.Object instance that is a clone of the current collection of expressions of the entity schema query.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
System.Object | The System.Object instance that is a clone of the current collection of expressions of the entity schema query. |
CreateQueryColumnExpression(DBSecurityEngine)
For the current collection of expressions, gets the enumerator of expressions of query columns. The enumerator is generated taking into account the specified access rights.
Declaration
public IEnumerable<QueryColumnExpression> CreateQueryColumnExpression(DBSecurityEngine dbSecurityEngine)
Parameters
Type | Name | Description |
---|---|---|
DBSecurityEngine | dbSecurityEngine | The DBSecurityEngine object that specifies the database access permissions for the current query expression to the object schema. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<QueryColumnExpression> | Enumerator of expressions of query columns for the current collection of expressions. |
GetMaxQueryColumnAliasLength(String)
For the current collection of expressions, gets the maximum length of the alias of the query column in a specified path.
Declaration
public int GetMaxQueryColumnAliasLength(string joinPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | joinPath | Path to the query column. |
Returns
Type | Description |
---|---|
System.Int32 | Maximum length of the alias of the query column. |
GetUniqueQueryColumnAlias(String)
Gets a unique alias for the query column with the specified alias.
Declaration
public string GetUniqueQueryColumnAlias(string alias)
Parameters
Type | Name | Description |
---|---|---|
System.String | alias | The alias of the column for which the unique alias is returned. |
Returns
Type | Description |
---|---|
System.String | Unique alias of the query column for the |
GetUniqueQueryColumnAlias(String, Int32)
Gets a unique alias of the specified maximum length for the query column with the specified alias.
Declaration
public string GetUniqueQueryColumnAlias(string alias, int aliasMaxLength)
Parameters
Type | Name | Description |
---|---|---|
System.String | alias | The alias of the column for which the unique alias is returned. |
System.Int32 | aliasMaxLength | Maximum length of the returned unique alias. |
Returns
Type | Description |
---|---|
System.String | Unique alias with the |
GetUniqueQueryColumnAlias(String, String)
Gets the unique alias for the column with the specified alias in a specified path.
Declaration
public string GetUniqueQueryColumnAlias(string joinPath, string alias)
Parameters
Type | Name | Description |
---|---|---|
System.String | joinPath | Path to the column for which the unique alias is returned. |
System.String | alias | The alias of the column for which the unique alias is returned. |
Returns
Type | Description |
---|---|
System.String | The unique alias for the column with the |
GetUniqueQueryColumnAlias(String, String, Int32)
Gets the unique alias with the specified maximum length limit for the column with the specified alias in a specified path.
Declaration
public string GetUniqueQueryColumnAlias(string joinPath, string alias, int aliasMaxLength)
Parameters
Type | Name | Description |
---|---|---|
System.String | joinPath | Path to the column for which the unique alias is returned. |
System.String | alias | The alias of the column for which the unique alias is returned. |
System.Int32 | aliasMaxLength | Maximum length of the returned unique alias. |
Returns
Type | Description |
---|---|
System.String | Unique alias with the |
GetUsingSchemaColumnExpressions()
For the current collection of expressions, generates a collection of expressions that will be used for building an SQL query.
Declaration
public EntitySchemaQueryExpressionCollection GetUsingSchemaColumnExpressions()
Returns
Type | Description |
---|---|
EntitySchemaQueryExpressionCollection | Collection of expressions that will be used for building an SQL query. |
InsertItem(Int32, EntitySchemaQueryExpression)
Declaration
protected override void InsertItem(int index, EntitySchemaQueryExpression item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
EntitySchemaQueryExpression | item |
Overrides
OnCollectionCleared(EventArgs)
Declaration
protected virtual void OnCollectionCleared(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e |
OnCollectionClearing(CancelEventArgs)
Declaration
protected virtual void OnCollectionClearing(CancelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.ComponentModel.CancelEventArgs | e |
OnQueryExpressionChanged(EntitySchemaQueryExpressionCollectionItemChangedEventArgs)
Declaration
protected virtual void OnQueryExpressionChanged(EntitySchemaQueryExpressionCollectionItemChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionItemChangedEventArgs | e |
OnQueryExpressionChanging(EntitySchemaQueryExpressionCollectionBeforeItemChangedEventArgs)
Declaration
protected virtual void OnQueryExpressionChanging(EntitySchemaQueryExpressionCollectionBeforeItemChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionBeforeItemChangedEventArgs | e |
OnQueryExpressionInserted(EntitySchemaQueryExpressionCollectionEventArgs)
Declaration
protected virtual void OnQueryExpressionInserted(EntitySchemaQueryExpressionCollectionEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionEventArgs | e |
OnQueryExpressionInserting(EntitySchemaQueryExpressionCollectionBeforeEventArgs)
Declaration
protected virtual void OnQueryExpressionInserting(EntitySchemaQueryExpressionCollectionBeforeEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionBeforeEventArgs | e |
OnQueryExpressionRemoved(EntitySchemaQueryExpressionCollectionEventArgs)
Declaration
protected virtual void OnQueryExpressionRemoved(EntitySchemaQueryExpressionCollectionEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionEventArgs | e |
OnQueryExpressionRemoving(EntitySchemaQueryExpressionCollectionBeforeEventArgs)
Declaration
protected virtual void OnQueryExpressionRemoving(EntitySchemaQueryExpressionCollectionBeforeEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EntitySchemaQueryExpressionCollectionBeforeEventArgs | e |
RemoveItem(Int32)
Declaration
protected override void RemoveItem(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Overrides
ResetQueryColumnAliases()
Resets aliases for all items of the current collection.
Declaration
public void ResetQueryColumnAliases()
SetItem(Int32, EntitySchemaQueryExpression)
Declaration
protected override void SetItem(int index, EntitySchemaQueryExpression item)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | |
EntitySchemaQueryExpression | item |
Overrides
Events
CollectionCleared
An event that occurs after all the items in the collection of query expressions have been deleted from the schema of the object.
Declaration
public event EventHandler CollectionCleared
Event Type
Type | Description |
---|---|
System.EventHandler |
CollectionClearing
An event that occurs before the item of the query expression collection is changed to an object schema.
Declaration
public event EventHandler<CancelEventArgs> CollectionClearing
Event Type
Type | Description |
---|---|
System.EventHandler<System.ComponentModel.CancelEventArgs> |
QueryExpressionChanged
An event that occurs after the collection element of the query expression collection has changed to an object schema.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionItemChangedEventArgs> QueryExpressionChanged
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionItemChangedEventArgs> |
QueryExpressionChanging
An event that occurs before the item of the query expression collection is changed to an object schema.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionBeforeItemChangedEventArgs> QueryExpressionChanging
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionBeforeItemChangedEventArgs> |
QueryExpressionInserted
An event that occurs after an element is added to a collection of query expressions to an object schema.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionEventArgs> QueryExpressionInserted
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionEventArgs> |
QueryExpressionInserting
An event that occurs before an element is added to a collection of query expressions to an object schema.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionBeforeEventArgs> QueryExpressionInserting
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionBeforeEventArgs> |
QueryExpressionRemoved
An event that occurs after an item is removed from a collection of query expressions to an object schema.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionEventArgs> QueryExpressionRemoved
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionEventArgs> |
QueryExpressionRemoving
Event that occurs before removing an item from the collection of expressions of the entity schema query.
Declaration
public event EventHandler<EntitySchemaQueryExpressionCollectionBeforeEventArgs> QueryExpressionRemoving
Event Type
Type | Description |
---|---|
System.EventHandler<EntitySchemaQueryExpressionCollectionBeforeEventArgs> |