Libraries.Data.Database.Support.Join Documentation

This is a support class for implementing Joins in the Find query. This class holds information about a join so the Join portion of the Find can be written out correctly.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetJoinCondition()Returns this joins join condition
GetJoinType()Returns the type of join this is.
GetTable()Returns the table being joined to the query
SetJoinCondition(text condition)Sets the join condition of this join.
SetTable(text table)Sets the table to join to the query
SetToCrossJoin()Sets the type of the join to a Cross Join
SetToInnerJoin()Sets the type of the join to an Inner Join
SetToLeftJoin()Sets the type of the join to a Left Join
SetToRightJoin()Sets the type of the join to a Right Join

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetJoinCondition()

Returns this joins join condition

Return

text:

GetJoinType()

Returns the type of join this is. The type is set using the SetToXJoin actions so the actual value for the join doesn't need to be remembered.

Return

text:

GetTable()

Returns the table being joined to the query

Return

text:

SetJoinCondition(text condition)

Sets the join condition of this join. In SQL this would be what goes in the ON clause. In the Find query this is converted using the filter converter.

Parameters

SetTable(text table)

Sets the table to join to the query

Parameters

SetToCrossJoin()

Sets the type of the join to a Cross Join

SetToInnerJoin()

Sets the type of the join to an Inner Join

SetToLeftJoin()

Sets the type of the join to a Left Join

SetToRightJoin()

Sets the type of the join to a Right Join