Libraries.Data.Database.Support.TableTarget Documentation

This is a support class not exposed to the user that holds information about a reference to table used in a query. This class holds the name of the table, the alias of the table if there is one, and whether or not the name is referencing another query.

Inherits from: Libraries.Language.Object, Libraries.Data.Database.Support.RemappableName

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.
GetRemappedName()Returns the alias
GetSubquery()Returns the query object being used as a table.
GetTable()Returns the name of this target.
HasColumn(text column)FOR USE WHEN A SUBQUERY Subqueries act as a table and this action is to check the "columns" of the table this subquery mimics.
IsSubquery()Returns true if this table is a subquery.
SetIsSubquery(boolean isSubquery)Set to true if this is subquery.
SetRemappedName(text remappedName)Sets the alias
SetSubquery(Libraries.Data.Database.Find subquery)Sets the Subquery that the given name will reference.
SetTable(text table)Sets the name of this target.

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.

GetRemappedName()

Returns the alias

Return

text:

GetSubquery()

Returns the query object being used as a table.

Return

Libraries.Data.Database.Find:

GetTable()

Returns the name of this target.

Return

text:

HasColumn(text column)

FOR USE WHEN A SUBQUERY Subqueries act as a table and this action is to check the "columns" of the table this subquery mimics.

Parameters

Return

boolean:

IsSubquery()

Returns true if this table is a subquery.

Return

boolean:

SetIsSubquery(boolean isSubquery)

Set to true if this is subquery. Query classes use this because how the query is written changes if a subquery is being used.

Parameters

SetRemappedName(text remappedName)

Sets the alias

Parameters

SetSubquery(Libraries.Data.Database.Find subquery)

Sets the Subquery that the given name will reference. Only Find queries are supported for sub queries.

Parameters

SetTable(text table)

Sets the name of this target.

Parameters