|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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. whether every detail row must reference a unique master row. |
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 |
public boolean isAllowDetailNoMaster()
setAllowDetailNoMaster(boolean)
public void setAllowDetailNoMaster(boolean allowDetailNoMaster)
allowDetailNoMaster
- true if a detail row in this Join may have no master row.isAllowDetailNoMaster()
public boolean isAllowMasterNoDetail()
setAllowMasterNoDetail(boolean)
public void setAllowMasterNoDetail(boolean allowMasterNoDetail)
allowMasterNoDetail
- true if a master row in this Join may have no detail rows.isAllowMasterNoDetail()
public java.lang.String getExternalKeyName()
setExternalKeyName(java.lang.String)
public void setExternalKeyName(java.lang.String externalKeyName)
externalKeyName
- a String specifying the external name for the key.getExternalKeyName()
public boolean isMandatory()
setMandatory(boolean)
public void setMandatory(boolean mandatory)
mandatory
- true if every detail row must reference a unique master row.isMandatory()
public boolean isOneToOne()
setOneToOne(boolean)
public void setOneToOne(boolean oneToOne)
oneToOne
- true if this join is a one-to-one relationship.isOneToOne()
public QueryObject getOwningQueryObject()
public void setReferencedQueryObject(QueryObject queryObject)
queryObject
- a QueryObject specifying the query object referenced by the join.getReferencedQueryObject()
public QueryObject getReferencedQueryObject()
setReferencedQueryObject(oracle.owb.intelligence.QueryObject)
public JoinComponent[] getJoinComponents()
public JoinComponent createJoinComponent(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the name of the join componentNameSpaceException
InvalidFormatException
public JoinComponent findJoinComponent(java.lang.String name)
name
- the name of the join component to be foundnull
otherwisepublic void setRelatedForeignKey(ForeignKey foreignKey)
foreignKey
- a ForeignKey specifying the related foreign key. (A null foreignKey value leaves the related foreign key unset.)getRelatedForeignKey()
public ForeignKey getRelatedForeignKey()
null
if none.setRelatedForeignKey(oracle.owb.relational.ForeignKey)
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |