oracle.owb.intelligence
Interface Join

All Superinterfaces:

Extensible, OWBNamedObject, PropertyOwner

public interface Join

extends OWBNamedObject, Extensible

A Join represents a join from the current Query Object to another Query Object.

Method Summary

JoinComponent	createJoinComponent(java.lang.String name) Creates a new Join Component at the end of the list of Join Components for this Join.
JoinComponent	findJoinComponent(java.lang.String name) Search for a join component of this join by name.
java.lang.String	getExternalKeyName() Returns the external name for the corresponding foreign key.
JoinComponent[]	getJoinComponents() Gets the ordered list of Join Components for this Join.
QueryObject	getOwningQueryObject() Returns the owning query object.
QueryObject	getReferencedQueryObject() Returns the referenced query object.
ForeignKey	getRelatedForeignKey() Returns the corresponding relational foreign key.
boolean	isAllowDetailNoMaster() Returns whether to generate a (+) on the detail side of the join.
boolean	isAllowMasterNoDetail() Returns whether to generate a (+) on the master side of the join.
boolean	isMandatory() Returns whether it is a "no loss" join; i.e.
boolean	isOneToOne() Returns whether the join is a one-to-one relationship between master and detail.
void	setAllowDetailNoMaster(boolean allowDetailNoMaster) Sets whether to generate a (+) on the detail side of the join.
void	setAllowMasterNoDetail(boolean allowMasterNoDetail) Sets whether to generate a (+) on the master side of the join.
void	setExternalKeyName(java.lang.String externalKeyName) Sets the external name for the corresponding foreign key.
void	setMandatory(boolean mandatory) Sets whether every detail row must reference a unique master row.
void	setOneToOne(boolean oneToOne) Sets whether the join is a one-to-one relationship.
void	setReferencedQueryObject(QueryObject queryObject) Sets the query object referenced by the Join.
void	setRelatedForeignKey(ForeignKey foreignKey) Sets the relational foreign key corresponding to the Join.

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

isAllowDetailNoMaster

public boolean isAllowDetailNoMaster()

Returns whether to generate a (+) on the detail side of the join.

Returns:

true if a detail row in this Join may have no master row.

See Also:

setAllowDetailNoMaster(boolean)

setAllowDetailNoMaster

public void setAllowDetailNoMaster(boolean allowDetailNoMaster)

Sets whether to generate a (+) on the detail side of the join.

Parameters:

allowDetailNoMaster - true if a detail row in this Join may have no master row.

See Also:

isAllowDetailNoMaster()

isAllowMasterNoDetail

public boolean isAllowMasterNoDetail()

Returns whether to generate a (+) on the master side of the join.

Returns:

true if a master row in this Join may have no detail rows.

See Also:

setAllowMasterNoDetail(boolean)

setAllowMasterNoDetail

public void setAllowMasterNoDetail(boolean allowMasterNoDetail)

Sets whether to generate a (+) on the master side of the join.

Parameters:

allowMasterNoDetail - true if a master row in this Join may have no detail rows.

See Also:

isAllowMasterNoDetail()

getExternalKeyName

public java.lang.String getExternalKeyName()

Returns the external name for the corresponding foreign key. (This is only relevant for a join that corresponds to a database foreign key.)

Returns:

a String representing the external name for the key.

See Also:

setExternalKeyName(java.lang.String)

setExternalKeyName

public void setExternalKeyName(java.lang.String externalKeyName)

Sets the external name for the corresponding foreign key.

Parameters:

externalKeyName - a String specifying the external name for the key.

See Also:

getExternalKeyName()

isMandatory

public boolean isMandatory()

Returns whether it is a "no loss" join; i.e. whether every detail row must reference a unique master row.

Returns:

true if every detail row must reference a unique master row.

See Also:

setMandatory(boolean)

setMandatory

public void setMandatory(boolean mandatory)

Sets whether every detail row must reference a unique master row.

Parameters:

mandatory - true if every detail row must reference a unique master row.

See Also:

isMandatory()

isOneToOne

public boolean isOneToOne()

Returns whether the join is a one-to-one relationship between master and detail.

Returns:

true if this join is a one-to-one relationship.

See Also:

setOneToOne(boolean)

setOneToOne

public void setOneToOne(boolean oneToOne)

Sets whether the join is a one-to-one relationship.

Parameters:

oneToOne - true if this join is a one-to-one relationship.

See Also:

isOneToOne()

getOwningQueryObject

public QueryObject getOwningQueryObject()

Returns the owning query object.

Returns:

a QueryObject representing the query object that owns the join.

setReferencedQueryObject

public void setReferencedQueryObject(QueryObject queryObject)

Sets the query object referenced by the Join.

Parameters:

queryObject - a QueryObject specifying the query object referenced by the join.

See Also:

getReferencedQueryObject()

getReferencedQueryObject

public QueryObject getReferencedQueryObject()

Returns the referenced query object.

Returns:

a QueryObject representing the query object referenced by the join.

See Also:

setReferencedQueryObject(oracle.owb.intelligence.QueryObject)

getJoinComponents

public JoinComponent[] getJoinComponents()

Gets the ordered list of Join Components for this Join.

Returns:

an array of the JoinComponents of the join.

createJoinComponent

public JoinComponent createJoinComponent(java.lang.String name)
                                  throws NameSpaceException,
                                         InvalidFormatException

Creates a new Join Component at the end of the list of Join Components for this Join.

Parameters:

name - the name of the join component

Returns:

the new JoinComponent

Throws:

NameSpaceException -

InvalidFormatException -

findJoinComponent

public JoinComponent findJoinComponent(java.lang.String name)

Search for a join component of this join by name.

Parameters:

name - the name of the join component to be found

Returns:

the Join Component object if found, null otherwise

setRelatedForeignKey

public void setRelatedForeignKey(ForeignKey foreignKey)

Sets the relational foreign key corresponding to the Join.

Parameters:

foreignKey - a ForeignKey specifying the related foreign key. (A null foreignKey value leaves the related foreign key unset.)

See Also:

getRelatedForeignKey()

getRelatedForeignKey

public ForeignKey getRelatedForeignKey()

Returns the corresponding relational foreign key.

Returns:

a ForeignKey representing the related foreign key, or null if none.

See Also:

setRelatedForeignKey(oracle.owb.relational.ForeignKey)