wt.pds
Interface JoinDelegate

All Known Implementing Classes:

ObjectJoinDelegate, PersistentJoinDelegate, UsesOccurrenceDataJoinDelegate, UsesOccurrenceJoinDelegate, VersionJoinDelegate

public interface JoinDelegate

This interface specifies the methods for implementing a join.

Supported API: false

Extendable: false

Method Summary

WhereExpression	buildArrayWhereExpression(Class a_sourceClass, Object a_targetArray, int a_sourceIndex, boolean a_sourceOuterJoin, String a_referenceName) Returns a WhereExpression for the specified source object array and target class.
WhereExpression	buildWhereExpression(Class a_sourceClass, Class a_targetClass, int a_sourceIndex, int a_targetIndex, String a_sourceFromAlias, String a_targetFromAlias, boolean a_sourceOuterJoin, boolean a_targetOuterJoin, String a_referenceName) Returns a WhereExpression for the specified source and target classes.
WhereExpression	buildWhereExpression(Class a_sourceClass, Persistable a_target, int a_sourceIndex, boolean a_sourceOuterJoin, String a_referenceName) Returns a WhereExpression for the specified source object and target class.

Method Detail

buildWhereExpression

public WhereExpression buildWhereExpression(Class a_sourceClass,
                                            Class a_targetClass,
                                            int a_sourceIndex,
                                            int a_targetIndex,
                                            String a_sourceFromAlias,
                                            String a_targetFromAlias,
                                            boolean a_sourceOuterJoin,
                                            boolean a_targetOuterJoin,
                                            String a_referenceName)
                                     throws WTException

Returns a WhereExpression for the specified source and target classes.

Supported API: false

Parameters:

a_sourceClass - Source class of the join (i.e. the class containing the referencing column(s)).

a_targetClass - Target class of the join (i.e. the class that is referenced).

a_sourceIndex - Index of the source class

a_targetIndex - Index of the target class

a_sourceFromAlias - From alias for the source class.

a_targetFromAlias - From alias for the target class.

a_sourceOuterJoin - Indicates if the source side of the join expression should be made an outer join

a_targetOuterJoin - Indicates if the target side of the join expression should be made an outer join

a_referenceName - Reference column name (i.e. query name) in the source class

Returns:

WhereExpression

Throws:

WTException

buildWhereExpression

public WhereExpression buildWhereExpression(Class a_sourceClass,
                                            Persistable a_target,
                                            int a_sourceIndex,
                                            boolean a_sourceOuterJoin,
                                            String a_referenceName)
                                     throws WTException

Returns a WhereExpression for the specified source object and target class.

Supported API: false

Parameters:

a_sourceClass - Source class of the join (i.e. the class containing the referencing column(s)).

a_target - Target of the reference

a_sourceIndex - Index of the source class

a_sourceOuterJoin - Indicates if the source side of the join expression should be made an outer join

a_referenceName - Reference column name (i.e. query name) in the source class

Returns:

WhereExpression

Throws:

WTException

buildArrayWhereExpression

public WhereExpression buildArrayWhereExpression(Class a_sourceClass,
                                                 Object a_targetArray,
                                                 int a_sourceIndex,
                                                 boolean a_sourceOuterJoin,
                                                 String a_referenceName)
                                          throws WTException

Returns a WhereExpression for the specified source object array and target class.

Supported API: false

Parameters:

a_sourceClass - Source class of the join (i.e. the class containing the referencing column(s)).

a_targetArray - Target array of the reference

a_sourceIndex - Index of the source class

a_sourceOuterJoin - Indicates if the source side of the join expression should be made an outer join

a_referenceName - Reference column name (i.e. query name) in the source class

Returns:

WhereExpression

Throws:

WTException