Class JoinRestriction
JoinRestriction implements the collection part of the join-clause.
Inherited Members
Namespace: SuperOffice.Data.SQL
Assembly: SoDataBase.dll
Syntax
public sealed class JoinRestriction : IEnumerable<JoinCompare>, IEnumerable, ICloneableConstructors
JoinRestriction()
Initializes a new instance of the JoinRestriction class.
Declaration
public JoinRestriction()Properties
Item[Int32]
Get a JoinCompare at index
Declaration
public JoinCompare this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index |
Property Value
| Type | Description |
|---|---|
| JoinCompare |
Joins
Get/Set an ArrayList of JoinRestriction
Declaration
public List<JoinCompare> Joins { get; }Property Value
| Type | Description |
|---|---|
| List<JoinCompare> |
Methods
AddJoin<TargetTableInfo>(TargetedInnerJoin<TargetTableInfo>)
Add a pre-generated inner join to the querys join restriction list
Declaration
public TargetTableInfo AddJoin<TargetTableInfo>(TargetedInnerJoin<TargetTableInfo> join)
where TargetTableInfo : TableInfoParameters
| Type | Name | Description |
|---|---|---|
| TargetedInnerJoin<TargetTableInfo> | join | One of the pre-generated inner joins |
Returns
| Type | Description |
|---|---|
| TargetTableInfo | Instance of join target table info |
Type Parameters
| Name | Description |
|---|---|
| TargetTableInfo | Implicit target tableinfo type |
AddJoin<TargetTableInfo>(TargetedLeftOuterJoin<TargetTableInfo>)
Add a pre-generated left outer join to the querys join restriction list
Declaration
public TargetTableInfo AddJoin<TargetTableInfo>(TargetedLeftOuterJoin<TargetTableInfo> join)
where TargetTableInfo : TableInfoParameters
| Type | Name | Description |
|---|---|---|
| TargetedLeftOuterJoin<TargetTableInfo> | join | One of the pre-generated left outer joins |
Returns
| Type | Description |
|---|---|
| TargetTableInfo | Instance of join target table info |
Type Parameters
| Name | Description |
|---|---|
| TargetTableInfo | Implicit target tableinfo type |
AppendJoinRestriction(JoinRestriction)
Append joins from another joinrestriction.
Declaration
public void AppendJoinRestriction(JoinRestriction joinRestriction)Parameters
| Type | Name | Description |
|---|---|---|
| JoinRestriction | joinRestriction | JoinRestriction holding the joins to append. |
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public object Clone()Returns
| Type | Description |
|---|---|
| Object | A new object that is a copy of this instance. |
GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
public IEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator | An IEnumerator object that can be used to iterate through the collection. |
GetNumberOfItems()
Returns number of items in the join-clause.
Declaration
public int GetNumberOfItems()Returns
| Type | Description |
|---|---|
| Int32 |
InnerJoin(Equal)
Add-function for the Inner Join
Declaration
public void InnerJoin(Equal comp)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
InnerJoin(Equal, Restriction)
Add-function for the Inner Join with two parameters.
Declaration
public void InnerJoin(Equal comp, Restriction res)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
| Restriction | res | The Restriction-parameter |
LeftOuterJoin(Equal)
Add-function for the Left Outer Join
Declaration
public void LeftOuterJoin(Equal comp)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
LeftOuterJoin(Equal, Restriction)
Add-function for the Left Outer Join with two parameters.
Declaration
public void LeftOuterJoin(Equal comp, Restriction res)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
| Restriction | res | The Restriction-parameter |
Remove(JoinCompare)
Remove a join from the join collection
Declaration
public void Remove(JoinCompare join)Parameters
| Type | Name | Description |
|---|---|---|
| JoinCompare | join |
Replace(JoinCompare, JoinCompare)
Declaration
public void Replace(JoinCompare original, JoinCompare replacement)Parameters
| Type | Name | Description |
|---|---|---|
| JoinCompare | original | |
| JoinCompare | replacement |
RightOuterJoin(Equal)
Add-function for the Right Outer Join.
Declaration
public void RightOuterJoin(Equal comp)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
RightOuterJoin(Equal, Restriction)
Add-function for the Right Outer Join with two parameters.
Declaration
public void RightOuterJoin(Equal comp, Restriction res)Parameters
| Type | Name | Description |
|---|---|---|
| Equal | comp | The Compare-parameter. |
| Restriction | res | The Restriction-parameter |
ToString()
String output: joins
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | ... |
Overrides
Explicit Interface Implementations
IEnumerable<JoinCompare>.GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
IEnumerator<JoinCompare> IEnumerable<JoinCompare>.GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<JoinCompare> | A IEnumerator<T> that can be used to iterate through the collection. |