Interface IDataStructure

Data object structure

Namespace: XData.DataSource.Structure
Assembly: XData.docfx.dll
Syntax
public interface IDataStructure

Properties

| Improve this Doc View Source

BaseSource

Base source

Declaration
ITableLike BaseSource { get; }
Property Value
Type Description
ITableLike
| Improve this Doc View Source

Context

Data structure context

Declaration
string Context { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Distinct

Structure distinct values flag

Declaration
bool Distinct { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

FilterValues

Runtime filter values

Declaration
SortedList<string, object> FilterValues { get; }
Property Value
Type Description
SortedList<String, Object>
| Improve this Doc View Source

Flags

Data object flags

Declaration
DataStructureFlag Flags { get; }
Property Value
Type Description
DataStructureFlag
| Improve this Doc View Source

GroupBy

Group by list

Declaration
List<Grouping> GroupBy { get; }
Property Value
Type Description
List<Grouping>
| Improve this Doc View Source

Hint

Query hints

Declaration
HintInfo[] Hint { get; set; }
Property Value
Type Description
HintInfo[]
| Improve this Doc View Source

Inverse

Structure filters inverse flag

Declaration
bool Inverse { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsReadOnly

Read only structure flag

Declaration
bool IsReadOnly { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSubquery

Subquery flag

Declaration
bool IsSubquery { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsUnion

Combined structure flag

Declaration
bool IsUnion { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Limit

Limit objects count

Declaration
int? Limit { get; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

ObjectType

Structure data object type

Declaration
Type ObjectType { get; }
Property Value
Type Description
Type
| Improve this Doc View Source

OrderBy

Order by list

Declaration
List<Order> OrderBy { get; }
Property Value
Type Description
List<Order>
| Improve this Doc View Source

Parameters

Stored procedure parameters definitions

Declaration
List<IParameterDescription> Parameters { get; }
Property Value
Type Description
List<IParameterDescription>
| Improve this Doc View Source

ResultSets

Stored procedure result sets

Declaration
IResultSetDescription[] ResultSets { get; }
Property Value
Type Description
IResultSetDescription[]
| Improve this Doc View Source

ReverseOrder

Structure reversion order flag

Declaration
bool ReverseOrder { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

RootFilterCombination

Structure root filter combination

Declaration
IFilterCombination RootFilterCombination { get; }
Property Value
Type Description
IFilterCombination
| Improve this Doc View Source

Skip

Skip objects count

Declaration
int? Skip { get; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

Sources

Sources

Declaration
SortedSet<IDataSource> Sources { get; }
Property Value
Type Description
SortedSet<IDataSource>
| Improve this Doc View Source

StructureType

Structure type full name

Declaration
string StructureType { get; }
Property Value
Type Description
String
| Improve this Doc View Source

UnionCombination

Data object structure combination

Declaration
DataCombination UnionCombination { get; }
Property Value
Type Description
DataCombination

Methods

| Improve this Doc View Source

FillSkippedSources(SortedList<String, Object>, out ICollection<String>)

Fill skipped sources list

Declaration
bool FillSkippedSources(SortedList<string, object> filterValues, out ICollection<string> skipped)
Parameters
Type Name Description
SortedList<String, Object> filterValues

Filter values
ICollection<String> skipped

Returned skipped sources list
Returns
Type Description
Boolean

Structure skipped flag
| Improve this Doc View Source

GetField(String, String, out String, out String)

Returns field

Declaration
IField GetField(string sourceAlias, string fieldName, out string alias, out string fullName)
Parameters
Type Name Description
String sourceAlias

Source alias
String fieldName

Field name
String alias

Relative alias
String fullName

Relative full name of field
Returns
Type Description
IField

Field object
| Improve this Doc View Source

GetFields()

Returns selectable fields

Declaration
IEnumerable<SelectedField> GetFields()
Returns
Type Description
IEnumerable<SelectedField>

Selectable fields sequence
| Improve this Doc View Source

GetParent(String)

Returns parent structure by object type

Declaration
IDataStructure GetParent(string parentType)
Parameters
Type Name Description
String parentType

Parent object type
Returns
Type Description
IDataStructure

Structure
| Improve this Doc View Source

GetPrimaryKey()

Returns data object unique key fields

Declaration
IEnumerable<SelectedField> GetPrimaryKey()
Returns
Type Description
IEnumerable<SelectedField>

Unique key fields sequence
| Improve this Doc View Source

GetSubqueryVariables(String)

Subquery variables

Declaration
SortedList<string, object> GetSubqueryVariables(string subqueryAlias)
Parameters
Type Name Description
String subqueryAlias

Subquery alias
Returns
Type Description
SortedList<String, Object>

Subquery variables
| Improve this Doc View Source

GetVariableValue(String)

Returns variable value

Declaration
object GetVariableValue(string variableName)
Parameters
Type Name Description
String variableName

Variable name
Returns
Type Description
Object

Variable value
| Improve this Doc View Source

IsOuterJoined(String, String)

Check source is outer joined to parent

Declaration
bool IsOuterJoined(string alias, string parentAlias)
Parameters
Type Name Description
String alias

Checked source alias
String parentAlias

Parent source alias
Returns
Type Description
Boolean

Outer joined flag

Extension Methods