query-class

Represents internal query structure.

public class Korzh.EasyQuery.Query

Assembly: Korzh.EasyQuery.dll

Constructors

Name	Type	Description
Query(DataModel model)	void	Initializes a new instance of the Korzh.EasyQuery.Query class.
Query(DataModel model, Query parentQuery)	void	Initializes a new instance of the Korzh.EasyQuery.Query class.

Fields

Name	Type	Description
_rootGroup	Condition	The root condition of the query
DefaultReadOptions	BitOptions
DefaultWriteOptions	BitOptions
DrillDowns	DrillDownStore
serializationQueryXml	string	Serialized query
Texts	TextStorage	Gets an instance of TextStorage object which holds all text resources used in this assembly

Properties

Name	Type	Description
AggregateSettings	AggregationSettings	Gets the aggregation settings of the query. This structure can be used to define groups, totals/sub-totals and aggregates over the existing query.
Aggregation	AggregationSettings	Gets the aggregation settings of the query. This structure can be used to define groups, totals/sub-totals and aggregates over the existing query.
AllowSyncColSort	bool
Columns	QueryColumnStore	Gets the columns.
Description	string	Gets or sets the query description.
ExtraColumns	string	Gets or sets the extra columns.
ExtraConditions	Condition	Gets the list of extra conditions for this query. These conditions are not visible to end-users but included into result SQL statement as all others (defined in Korzh.EasyQuery.Query.Root condition group).
ExtraData	ExpandoObject	Conatains user-defined extra data for the current query.
FilePath	string	Gets the query file path. It is automatically assigned when you use LoadFromFile method.
Id	string	Gets or sets the ID of this query.
ID	string	Gets or sets the query identifier.
InnerData	ExpandoObject	Conatains some internal data (lie facets) associated with the current query.
IsDrillDown	bool
IsEmpty	bool	Gets a value indicating whether this query is empty (no columns and no conditions are defined).
IsModified	bool	Indicates whether the query was changed since the creation or the latest loading. This property is reset to false on query save.
JustSortedColumns	QueryColumnStore	Gets the list of "just sorted" columns (the columns which will occur only in ORDER BY clause)
LocaleId	string	Gets or sets the locale identifier.
Model	DataModel	Gets or sets the data model used in this query.
ModelId	string
ModelResolver	Func<string, CancellationToken, Task<DataModel>>	Gets or sets the model resolver - a functions which allows to get model by its ID.
Name	string	Gets or sets the name of the query.
Parent	Query	Gets the parent query.
Root	Condition	Gets the root condition of the query.
SortedColumns	SortedColumnList	Gets the list of sorted columns.
StoreModelPath	bool	Gets or sets a value indicating whether this Query object should store the path to corresponding data model and restore it during query loading.
StoreOptions	bool	Gets or sets a value indicating whether this Query object should store the options and restore them during query loading.
SyncColSortOrder	bool	Gets or sets a value indicating whether the order of columns must be synchronized with their sorting order.
TimezoneOffset	int	Timezone offset (in minutes) for all dates used in the query
UseDefaultNumericValues	bool	Indicates whether we need to set the default values for numeric expressions in conditions.

Events

Name	Type	Description
ColumnsChanged	ColumnsChangedEventHandler	This event is raised when the list of query result columns or a particular column was changed. For example some column was added or some was deleted.
ColumnsChanging	ColumnsChangingEventHandler	This event is raised before the list of query columns or a particular column is going to be changed. For example some column will be added or deleted.
ConditionsChanged	ConditionsChangedEventHandler	This event is raised when list of query conditions or a particular condition was changed. For example some condition was added or some - was deleted.
ModelChanged	EventHandler	Occurs after the model has been changed.
QueryChanged	QueryChangedEventHandler	This event is raised when there was any change in the query, either in columns, conditions or in one of the main properties (Name, Description, etc)
SortOrderChanged	SortOrderChangedEventHandler	Occurs when the list of sorted columns was changed.
SubQueryConditionsChanged	ConditionsChangedEventHandler	This event is raised when list of subquery conditions or a particular condition was changed. For example some condition was added or some - was deleted.

Methods

Name	Type	Description
AddAggregateColumn(string attrId, string funcId, string caption = null, SortDirection sorting = 0)	QueryColumn	Creates a new aggregate column by attribute's ID and aggregate function nameand.
AddColumn(IColumnDescriptor& desc)	QueryColumn	Creates a new column by descriptor and adds it into query.
AddConditionGroup(Condition parent = null, int index = -1)	Condition	Creates a new condition group and adds it into the query.
AddDrillDown()	Query
AddSimpleColumn(string attrId, string caption = null, SortDirection sorting = 0)	QueryColumn	Creates a new column by attribute's ID and adds it into query.
BeginUpdate()	void	Turns on the "updating" state. Any changes occured during this state will not initiate any "changed" event (like Korzh.EasyQuery.Query.ColumnsChanged or Korzh.EasyQuery.Query.ConditionsChanged) until Korzh.EasyQuery.Query.EndUpdate is called.
CalculateAllowSyncColSort()	bool
ChangeColumnAttr(QueryColumn column, string attrId)	void	Changes the column's attribute to the one passed in the parameter
CheckDataModel()	void	Checks the data model object. Generates an exception if Model property has null value.
CheckModelObject(DataModel model)	void	Checks if model object has appropriate type and raise exception if not
CleanUp()	void	Clean up this query instance. This method removes columns and conditions with "ghost" attributes or operators
Clear()	void	Clears the query conditions and result columns.
CoreClear()	void	Clears all query content. Can be overriden in derived classes.
CreateAggregateColumn(string attrId, string funcId, string caption = null, SortDirection sorting = 0)	QueryColumn	Creates an aggregate column.
CreateAggrFuncExpr(string funcID, EqExpression argumentExpr)	AggrFuncExpr	Creates an aggregate function expression.
CreateColumn(EqExpression expr = null, `string` caption = null, SortDirection sortDirection = 0)	QueryColumn	Creates an empty column. If expr and caption parameters are not used they must be set later (to make the new object a proper column)
CreateColumn(IColumnDescriptor& modreq(System.Runtime.InteropServices.InAttribute) desc)	QueryColumn	Creates an empty column. If expr and caption parameters are not used they must be set later (to make the new object a proper column)
CreateColumnCore()	QueryColumn	Creates the column object. Can be overridden in descendant classes
CreateConditionGroup()	Condition	Creates a new condition group.
CreateEntityAttrExpr(EntityAttr attr)	EntityAttrExpr	Creates an entity attribute expression.
CreateEntityAttrExpr(string attrId)	EntityAttrExpr	Creates an entity attribute expression.
CreateParentColumnExpr(QueryColumn column, string name = )	ParentColumnExpr	Creates a parent column expression.
CreateParentColumnExpr(string columnId, string name = )	ParentColumnExpr	Creates a parent column expression.
CreateParentEntityAttrExpr(EntityAttr attr)	EntityAttrExpr	Creates a parent entity attribute expression.
CreateQueryExpr()	EqExpression	Creates a sub-query expression.
CreateRootCondition()	Condition	Creates the root condition.
CreateSilentConditionGroup()	Condition	Creates a new "silent" condition gropu. Here "silent" means neither this group nor its conditions will raise ConditionsChanged event in associated query
CreateSimpleColumn(EntityAttr attr, string caption = null, SortDirection sorting = 0)	QueryColumn	Creates a column by EntityAttr object.
CreateSimpleColumn(string attrId, string caption = null, SortDirection sorting = 0)	QueryColumn	Creates a column by EntityAttr object.
CreateSimpleCondition()	Condition	Creates a simple condition.
CreateSimpleCondition(string attrId, string operatorId = null, String[] values)	Condition	Creates a simple condition.
CreateSimpleCondition(string operatorId = null, EqExpression[] expressions)	Condition	Creates a simple condition.
CreateSimpleCondition(EntityAttr attr, Operator op, String[] values)	Condition	Creates a simple condition.
CreateSimpleCondition(string attrId, string operatorId, EqExpression[] values)	Condition	Creates a simple condition.
CreateSimpleCondition(EntityAttr attr, Operator op, EqExpression[] exprs)	Condition	Creates a simple condition.
CreateSubQuery()	Query	Creates the subquery.
EndUpdate()	void	Turns the "updating" state off.
GetConditionsText(QueryTextFormats formats)	string	Returns human-readable text that represents current query conditions
GetOneValueForAttr(EntityAttr attr)	string	Gets the one value set in some query condition for indicated entity attribute
GetParentQueryRootEntity()	Entity	Gets the entities from parent query.
LoadFromJsonFile(string filePath)	void	Loads the query's content from a JSON file.
LoadFromJsonFile(string filePath, BitOptions rwOptions)	void	Loads the query's content from a JSON file.
LoadFromJsonFileAsync(string fileName, CancellationToken ct = null)	Task	Loads the query's content from a JSON file (asynchronous way).
LoadFromJsonFileAsync(string fileName, BitOptions rwOptions, CancellationToken ct = null)	Task	Loads the query's content from a JSON file (asynchronous way).
LoadFromJsonObject(JObject jObject)	void	Loads query from Newtonsoft.Json.Linq.JObject.
LoadFromJsonObject(JObject jObject, BitOptions rwOptions)	void	Loads query from Newtonsoft.Json.Linq.JObject.
LoadFromJsonObjectAsync(JObject jObject, CancellationToken ct = null)	Task	Loads query from Newtonsoft.Json.Linq.JObject (asynchronous way).
LoadFromJsonObjectAsync(JObject jObject, BitOptions rwOptions, CancellationToken ct = null)	Task	Loads query from Newtonsoft.Json.Linq.JObject (asynchronous way).
LoadFromJsonStream(Stream stream)	void	Loads query from stream containing the JSON
LoadFromJsonStream(Stream stream, BitOptions rwOptions)	void	Loads query from stream containing the JSON
LoadFromJsonStreamAsync(Stream stream, CancellationToken ct = null)	Task	Loads query from stream containing the JSON (asynchronous way).
LoadFromJsonStreamAsync(Stream stream, BitOptions rwOptions, CancellationToken ct = null)	Task	Loads query from stream containing the JSON (asynchronous way).
LoadFromJsonString(string json)	void	Loads query from string containing the JSON.
LoadFromJsonString(string json, BitOptions rwOptions)	void	Loads query from string containing the JSON.
LoadFromJsonStringAsync(string json, CancellationToken ct = null)	Task	Loads query from string containing the JSON (asynchronous way).
LoadFromJsonStringAsync(string json, BitOptions rwOptions, CancellationToken ct = null)	Task	Loads query from string containing the JSON (asynchronous way).
LoadFromXmlFile(string path)	void	Loads query from XML file.
LoadFromXmlFile(string path, BitOptions options)	void	Loads query from XML file.
LoadFromXmlReader(XmlReader reader)	void	Loads query from XML reader.
LoadFromXmlReader(XmlReader reader, BitOptions options)	void	Loads query from XML reader.
LoadFromXmlStream(Stream stream)	void	Loads query from XML stream.
LoadFromXmlStream(Stream stream, BitOptions options)	void	Loads query from XML stream.
LoadFromXmlString(string xml)	void	Loads query from XML string.
LoadFromXmlString(string xml, BitOptions options)	void	Loads query from XML string.
LoadNode(XmlReader reader, BitOptions rwOptions)	void	Loads the root node.
NewModel()	DataModel	Creates new model object of appropriate type.
OnSortOrderChanged(SortOrderChangedEventArgs e)	void	Raises the SortOrderChanged event.
OnSubQueryConditionsChanged(ConditionsChangeEventArgs e)	void	Raises the SubQueryConditionsChanged event.
ReadFromJson(JsonReader reader)	void	Loads query from JSON reader. Calls See function.
ReadFromJson(JsonReader reader, BitOptions rwOptions)	void	Loads query from JSON reader. Calls See function.
ReadFromJsonAsync(JsonReader reader, CancellationToken ct = null)	Task	Loads query from JSON reader. Calls See Korzh.EasyQuery.Query.ReadOnePropFromJsonAsync(Newtonsoft.Json.JsonReader,System.String,EasyData.BitOptions,System.Threading.CancellationToken) function.
ReadFromJsonAsync(JsonReader reader, BitOptions rwOptions, CancellationToken ct = null)	Task	Loads query from JSON reader. Calls See Korzh.EasyQuery.Query.ReadOnePropFromJsonAsync(Newtonsoft.Json.JsonReader,System.String,EasyData.BitOptions,System.Threading.CancellationToken) function.
ReadOnePropFromJsonAsync(JsonReader reader, string propName, BitOptions rwOptions, CancellationToken ct)	Task	Reads the property from JSON reader or skip unused.
ResolveDataModelAsync(string modelId, CancellationToken ct)	Task	Resolves the data model by its ID
SaveNodes(XmlWriter writer, BitOptions rwOptions)	void	Saves the root nodes.
SaveToJsonFile(string filePath)	void	Saves query to a file in JSON format.
SaveToJsonFile(string filePath, BitOptions rwOptions)	void	Saves query to a file in JSON format.
SaveToJsonFileAsync(string filePath, CancellationToken ct = null)	Task	Saves query to a file in JSON format (asynchronous way).
SaveToJsonFileAsync(string filePath, BitOptions rwOptions, CancellationToken ct = null)	Task	Saves query to a file in JSON format (asynchronous way).
SaveToJsonObject()	JObject	Saves query to Newtonsoft.Json.Linq.JObject.
SaveToJsonObject(BitOptions rwOptions)	JObject	Saves query to Newtonsoft.Json.Linq.JObject.
SaveToJsonObjectAsync(CancellationToken ct = null)	Task<JObject>	Saves query to Newtonsoft.Json.Linq.JObject (asynchronous way).
SaveToJsonObjectAsync(BitOptions rwOptions, CancellationToken ct = null)	Task<JObject>	Saves query to Newtonsoft.Json.Linq.JObject (asynchronous way).
SaveToJsonStream(Stream stream)	void	Saves query to a stream in JSON format.
SaveToJsonStream(Stream stream, BitOptions rwOptions)	void	Saves query to a stream in JSON format.
SaveToJsonStreamAsync(Stream stream, CancellationToken ct = null)	Task	Saves query to a stream in JSON format (asynchronous way).
SaveToJsonStreamAsync(Stream stream, BitOptions rwOptions, CancellationToken ct = null)	Task	Saves query to a stream in JSON format (asynchronous way).
SaveToJsonString()	string	Saves query to string containing the JSON.
SaveToJsonString(BitOptions rwOptions)	string	Saves query to string containing the JSON.
SaveToJsonStringAsync(CancellationToken ct = null)	Task<string>	Saves query to string containing the JSON (asynchronous way).
SaveToJsonStringAsync(BitOptions rwOptions, CancellationToken ct = null)	Task<string>	Saves query to string containing the JSON (asynchronous way).
SaveToXmlFile(string path)	void	Saves query to XML file.
SaveToXmlFile(string path, BitOptions options)	void	Saves query to XML file.
SaveToXmlStream(Stream stream)	void	Saves query XML to stream.
SaveToXmlStream(Stream stream, BitOptions options)	void	Saves query XML to stream.
SaveToXmlString()	string	Saves query to string containing the XML.
SaveToXmlString(BitOptions options)	string	Saves query to string containing the XML.
SaveToXmlWriter(XmlWriter writer)	void	Saves query to XML using XML writer.
SaveToXmlWriter(XmlWriter writer, BitOptions rwOptions)	void	Saves query to XML using XML writer.
SetModel(DataModel newModel)	void	Sets the data model and performs some initialization procedures.
Validate()	void	Validates this query instance. This method throws an exception if query has "ghost" attributes
WritePropertiesToJsonAsync(JsonWriter writer, BitOptions rwOptions, CancellationToken ct)	Task	Saves content of the query to JSON (asynchronous way).
WriteToJson(JsonWriter writer)	void	Saves query to JSON using JSON writer.
WriteToJson(JsonWriter writer, BitOptions rwOptions)	void	Saves query to JSON using JSON writer.
WriteToJsonAsync(JsonWriter writer, CancellationToken ct = null)	Task	Saves query to JSON using JSON writer (asynchronous way). Calls Korzh.EasyQuery.Query.WriteToJsonAsync(Newtonsoft.Json.JsonWriter,EasyData.BitOptions,System.Threading.CancellationToken) function.
WriteToJsonAsync(JsonWriter writer, BitOptions rwOptions, CancellationToken ct = null)	Task	Saves query to JSON using JSON writer (asynchronous way). Calls Korzh.EasyQuery.Query.WriteToJsonAsync(Newtonsoft.Json.JsonWriter,EasyData.BitOptions,System.Threading.CancellationToken) function.