wt.pds
Class ReferenceJoinCondition

java.lang.Object
  wt.pds.ReferenceJoinCondition

All Implemented Interfaces:

Externalizable, JoinCondition, Serializable, WhereCondition

public class ReferenceJoinCondition

extends Object

implements JoinCondition, Externalizable

This class specifies a join in terms of a source and target class with a reference property from the source class.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private JoinIndex	joinIndex
protected static long	OLD_FORMAT_VERSION_UID
private String	referencePropertyName
private static String	RESOURCE
(package private) static long	serialVersionUID
private int	sourceFromIndex
private boolean	sourceOuterJoin
private int	targetFromIndex
private boolean	targetOuterJoin

Fields inherited from interface wt.pds.WhereCondition

OUTER_JOIN_FROM_INDICIES

Constructor Summary

ReferenceJoinCondition()


Supported API: false

ReferenceJoinCondition(int a_sourceFromIndex, int a_targetFromIndex, String a_referencePropertyName)


Supported API: false

Method Summary

WhereExpression	getExpression(Vector a_tables) Returns the condition expression based on the specified concreate classes.
JoinIndex	getJoinIndex(int a_tableTotalSize) Supported API: false
int[]	getOuterJoinFromIndicies() Gets the value of the attribute: outerJoinFromIndicies; The index values in the From clause for any classes that use an outer join in this condition.
String	getReferencePropertyName() Gets the value of the attribute: referencePropertyName; Property name of the reference specifying the join Supported API: false
int	getSourceFromIndex() Gets the value of the attribute: sourceFromIndex; From index of the source side of the join (i.e.
int	getTargetFromIndex() Gets the value of the attribute: targetFromIndex; From index of the target side of the join Supported API: false
boolean	isSourceOuterJoin() Gets the value of the attribute: sourceOuterJoin; Indicates if an outer join should be used on the source class.
boolean	isTargetOuterJoin() Gets the value of the attribute: targetOuterJoin; Indicates if an outer join should be used on the target class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ReferenceJoinCondition thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setReferencePropertyName(String a_ReferencePropertyName) Sets the value of the attribute: referencePropertyName; Property name of the reference specifying the join Supported API: false
void	setSourceFromIndex(int a_SourceFromIndex) Sets the value of the attribute: sourceFromIndex; From index of the source side of the join (i.e.
void	setSourceOuterJoin(boolean a_SourceOuterJoin) Sets the value of the attribute: sourceOuterJoin; Indicates if an outer join should be used on the source class.
void	setTargetFromIndex(int a_TargetFromIndex) Sets the value of the attribute: targetFromIndex; From index of the target side of the join Supported API: false
void	setTargetOuterJoin(boolean a_TargetOuterJoin) Sets the value of the attribute: targetOuterJoin; Indicates if an outer join should be used on the target class.
String	toString()
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

sourceFromIndex

private int sourceFromIndex

targetFromIndex

private int targetFromIndex

referencePropertyName

private String referencePropertyName

sourceOuterJoin

private boolean sourceOuterJoin

targetOuterJoin

private boolean targetOuterJoin

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

joinIndex

private transient JoinIndex joinIndex

Constructor Detail

ReferenceJoinCondition

public ReferenceJoinCondition()

Supported API: false

ReferenceJoinCondition

public ReferenceJoinCondition(int a_sourceFromIndex,
                              int a_targetFromIndex,
                              String a_referencePropertyName)

Supported API: false

Parameters:

a_sourceFromIndex - From index of the source side of the join (i.e. the side containing the reference)

a_targetFromIndex - From index of the target side of the join

a_referencePropertyName - Property name of the reference specifying the join

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ReferenceJoinCondition thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getSourceFromIndex

public int getSourceFromIndex()

Gets the value of the attribute: sourceFromIndex; From index of the source side of the join (i.e. the side containing the reference)

Supported API: false

Returns:

int

setSourceFromIndex

public void setSourceFromIndex(int a_SourceFromIndex)

Sets the value of the attribute: sourceFromIndex; From index of the source side of the join (i.e. the side containing the reference)

Supported API: false

Parameters:

a_SourceFromIndex -

getTargetFromIndex

public int getTargetFromIndex()

Gets the value of the attribute: targetFromIndex; From index of the target side of the join

Supported API: false

Returns:

int

setTargetFromIndex

public void setTargetFromIndex(int a_TargetFromIndex)

Sets the value of the attribute: targetFromIndex; From index of the target side of the join

Supported API: false

Parameters:

a_TargetFromIndex -

getReferencePropertyName

public String getReferencePropertyName()

Gets the value of the attribute: referencePropertyName; Property name of the reference specifying the join

Supported API: false

Returns:

String

setReferencePropertyName

public void setReferencePropertyName(String a_ReferencePropertyName)

Sets the value of the attribute: referencePropertyName; Property name of the reference specifying the join

Supported API: false

Parameters:

a_ReferencePropertyName -

isSourceOuterJoin

public boolean isSourceOuterJoin()

Gets the value of the attribute: sourceOuterJoin; Indicates if an outer join should be used on the source class. Setting this attribute to true, automatically sets the targetOuterJoin attribute to false.

Supported API: false

Returns:

boolean

setSourceOuterJoin

public void setSourceOuterJoin(boolean a_SourceOuterJoin)

Sets the value of the attribute: sourceOuterJoin; Indicates if an outer join should be used on the source class. Setting this attribute to true, automatically sets the targetOuterJoin attribute to false.

Supported API: false

Parameters:

a_SourceOuterJoin -

isTargetOuterJoin

public boolean isTargetOuterJoin()

Gets the value of the attribute: targetOuterJoin; Indicates if an outer join should be used on the target class. Setting this attribute to true, automatically sets the sourceOuterJoin attribute to false.

Supported API: false

Returns:

boolean

setTargetOuterJoin

public void setTargetOuterJoin(boolean a_TargetOuterJoin)

Sets the value of the attribute: targetOuterJoin; Indicates if an outer join should be used on the target class. Setting this attribute to true, automatically sets the sourceOuterJoin attribute to false.

Supported API: false

Parameters:

a_TargetOuterJoin -

getJoinIndex

public JoinIndex getJoinIndex(int a_tableTotalSize)

Supported API: false

Specified by:

getJoinIndex in interface JoinCondition

Parameters:

a_tableTotalSize -

Returns:

JoinIndex

getOuterJoinFromIndicies

public int[] getOuterJoinFromIndicies()

Gets the value of the attribute: outerJoinFromIndicies; The index values in the From clause for any classes that use an outer join in this condition.

Supported API: false

Specified by:

getOuterJoinFromIndicies in interface WhereCondition

Returns:

int[]

getExpression

public WhereExpression getExpression(Vector a_tables)
                              throws WTException

Returns the condition expression based on the specified concreate classes.

Supported API: false

Specified by:

getExpression in interface WhereCondition

Parameters:

a_tables -

Returns:

WhereExpression

Throws:

WTException

toString

public String toString()