Class QuerySourceBase<TSource>

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Defines base class for the query source

public class QuerySourceBase<TSource> : QueryParametersBase<TSource>, IQueryParameters<TSource>, IQuerySource, IQueryParameters, IQueryObject where TSource : QuerySourceBase<TSource>, new()

Type Parameters

TSource

Inheritance

object

AbstractQueryObject

QueryParametersBase<TSource>

QuerySourceBase<TSource>

Implements

IQueryParameters<TSource>

IQuerySource

IQueryParameters

IQueryObject

Derived

ObjectSourceBase<TSource>

QuerySource

Inherited Members

QueryParametersBase<TSource>.mParameters

QueryParametersBase<TSource>.IsImmutable

QueryParametersBase<TSource>.Parameters

QueryParametersBase<TSource>.ApplyParametersTo(IQueryObject)

QueryParametersBase<TSource>.CopyPropertiesTo(IQueryObject)

QueryParametersBase<TSource>.CloneObject()

QueryParametersBase<TSource>.Clone()

QueryParametersBase<TSource>.EnsureParameters()

QueryParametersBase<TSource>.IncludeDataParameters(QueryDataParameters, string)

QueryParametersBase<TSource>.Immutable()

QueryParametersBase<TSource>.GetTypedQuery()

QueryParametersBase<TSource>.Expand(string)

QueryParametersBase<TSource>.ToString()

AbstractQueryObject.Name

AbstractQueryObject.Changed()

AbstractQueryObject.Reset()

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

QuerySourceBase()

Default constructor

protected QuerySourceBase()

QuerySourceBase(QuerySourceTable)

Constructor

public QuerySourceBase(QuerySourceTable source)

Parameters

source QuerySourceTable

Source table

Properties

LeftSourceName

Left source name

protected string LeftSourceName { get; set; }

Property Value

string

RightSourceName

Left source name

protected string RightSourceName { get; set; }

Property Value

string

SourceExpression

Source expression

public string SourceExpression { get; set; }

Property Value

string

Methods

GetSourceExpression(QueryDataParameters, bool)

Gets the source expression represented as string

public string GetSourceExpression(QueryDataParameters parameters, bool expand = false)

Parameters

parameters QueryDataParameters

Query parameters. If provided, the column parameters are included into the parameters and column expression is altered accordingly

expand bool

If true, the result expression is expanded with parameters

Returns

string

InnerJoin(QuerySourceTable, IWhereCondition)

Joins the given source with another

public TSource InnerJoin(QuerySourceTable source, IWhereCondition condition)

Parameters

source QuerySourceTable

Source table

condition IWhereCondition

Join condition

Returns

TSource

InnerJoin(QuerySourceTable, string)

Joins the given source with another

public TSource InnerJoin(QuerySourceTable source, string condition = null)

Parameters

source QuerySourceTable

Source table

condition string

Join condition

Returns

TSource

InnerJoin(QuerySourceTable, string, string)

Joins the given source with another

public TSource InnerJoin(QuerySourceTable source, string leftColumn, string rightColumn)

Parameters

source QuerySourceTable

Source table

leftColumn string

Left column

rightColumn string

Right column

Returns

TSource

InnerJoin<TObject>(string, string, IWhereCondition)

Joins the given source with another

public TSource InnerJoin<TObject>(string leftColumn, string rightColumn, IWhereCondition additionalCondition = null) where TObject : BaseInfo, new()

Parameters

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

Type Parameters

TObject

Join(QuerySourceTable, IWhereCondition, JoinTypeEnum)

Joins the given source with another

public TSource Join(QuerySourceTable source, IWhereCondition condition, JoinTypeEnum joinType = JoinTypeEnum.Inner)

Parameters

source QuerySourceTable

Source table

condition IWhereCondition

Join condition

joinType JoinTypeEnum

Type of the join

Returns

TSource

Join(QuerySourceTable, string, JoinTypeEnum)

Joins the given source with another

public TSource Join(QuerySourceTable source, string condition = null, JoinTypeEnum joinType = JoinTypeEnum.Inner)

Parameters

source QuerySourceTable

Source table

condition string

Join condition

joinType JoinTypeEnum

Type of the join

Returns

TSource

Join(QuerySourceTable, string, string, IWhereCondition, JoinTypeEnum)

Joins the given source with another

public TSource Join(QuerySourceTable source, string leftColumn, string rightColumn, IWhereCondition additionalCondition = null, JoinTypeEnum joinType = JoinTypeEnum.Inner)

Parameters

source QuerySourceTable

Source table

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

joinType JoinTypeEnum

Type of the join

Returns

TSource

Join<TObject>(string, string, JoinTypeEnum, IWhereCondition)

Joins the given source with another

public TSource Join<TObject>(string leftColumn, string rightColumn, JoinTypeEnum joinType = JoinTypeEnum.Inner, IWhereCondition additionalCondition = null) where TObject : BaseInfo, new()

Parameters

leftColumn string

Left column

rightColumn string

Right column

joinType JoinTypeEnum

Type of the join

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

Type Parameters

TObject

LeftJoin(QuerySourceTable, string, string, IWhereCondition)

Joins the given source with another

public TSource LeftJoin(QuerySourceTable source, string leftColumn, string rightColumn, IWhereCondition additionalCondition = null)

Parameters

source QuerySourceTable

Source table

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

LeftJoin(string, IWhereCondition)

Joins the given source with another

public TSource LeftJoin(string sourceExpression, IWhereCondition condition)

Parameters

sourceExpression string

Source expression

condition IWhereCondition

Join condition

Returns

TSource

LeftJoin(string, string)

Joins the given source with another

public TSource LeftJoin(string sourceExpression, string condition = null)

Parameters

sourceExpression string

Source expression

condition string

Join condition

Returns

TSource

LeftJoin<TObject>(string, string, IWhereCondition)

Joins the given source with another

public TSource LeftJoin<TObject>(string leftColumn, string rightColumn, IWhereCondition additionalCondition = null) where TObject : BaseInfo, new()

Parameters

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

Type Parameters

TObject

RightJoin(QuerySourceTable, IWhereCondition)

Joins the given source with another

public TSource RightJoin(QuerySourceTable source, IWhereCondition condition)

Parameters

source QuerySourceTable

Source table

condition IWhereCondition

Join condition

Returns

TSource

RightJoin(QuerySourceTable, string)

Joins the given source with another

public TSource RightJoin(QuerySourceTable source, string condition = null)

Parameters

source QuerySourceTable

Source table

condition string

Join condition

Returns

TSource

RightJoin(QuerySourceTable, string, string, IWhereCondition)

Joins the given source with another

public TSource RightJoin(QuerySourceTable source, string leftColumn, string rightColumn, IWhereCondition additionalCondition = null)

Parameters

source QuerySourceTable

Source table

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

RightJoin<TObject>(string, string, IWhereCondition)

Joins the given source with another

public TSource RightJoin<TObject>(string leftColumn, string rightColumn, IWhereCondition additionalCondition = null) where TObject : BaseInfo, new()

Parameters

leftColumn string

Left column

rightColumn string

Right column

additionalCondition IWhereCondition

Additional JOIN condition, this will be added with AND operator to the base condition

Returns

TSource

Type Parameters

TObject

ToString(bool)

Returns the string representation of the expression, with possibility of expanding parameters

public override string ToString(bool expand)

Parameters

expand bool

If true, the result is expanded with parameters so it can act as standalone value.

Returns

string

TranslateSource(QuerySourceTable)

Translates the source to the final query expression

protected virtual void TranslateSource(QuerySourceTable source)

Parameters

source QuerySourceTable

Source table

Operators

implicit operator QuerySourceTable(QuerySourceBase<TSource>)

Implicit operator for conversion from query source to query source table expression

public static implicit operator QuerySourceTable(QuerySourceBase<TSource> source)

Parameters

source QuerySourceBase<TSource>

Source object

Returns

QuerySourceTable

implicit operator string(QuerySourceBase<TSource>)

Implicit operator for conversion from query source to string expression

public static implicit operator string(QuerySourceBase<TSource> source)

Parameters

source QuerySourceBase<TSource>

Source object

Returns

string