com.ibm.websphere.sdo.mediator.jdbc.metadata
Interface Relationship


public interface Relationship

Defines a Relationship between two database tables.


Method Summary
 Key getChildKey()
          Get the Key from the child side of the Relationship
 java.lang.String getName()
          Get the name of the Relationship.
 java.lang.String getOppositeName()
          Get the name of the Relationship from the child side.
 Key getParentKey()
          Get the Key from the parent side of the Relationship
 boolean isExclusive()
          Returns the value of the Is Exclusive attribute.
 void setChildKey(Key value)
          Sets the value of the 'Child Key' reference.
 void setExclusive(boolean value)
          Sets the value of the 'Exclusive' attribute.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setOppositeName(java.lang.String value)
          Sets the value of the 'Opposite Name' attribute.
 void setParentKey(Key value)
          Sets the value of the 'Parent Key' reference.
 

Method Detail

getChildKey

public Key getChildKey()
Get the Key from the child side of the Relationship

Returns:
the key

setChildKey

public void setChildKey(Key value)
Sets the value of the 'Child Key' reference.

Parameters:
value - the new value of the 'Child Key' reference.
See Also:
getChildKey()

getParentKey

public Key getParentKey()
Get the Key from the parent side of the Relationship

Returns:
the key

setParentKey

public void setParentKey(Key value)
Sets the value of the 'Parent Key' reference.

Parameters:
value - the new value of the 'Parent Key' reference.
See Also:
getParentKey()

getName

public java.lang.String getName()
Get the name of the Relationship. If the value of the Name attribute is not specified, the name defaults to the parent table name and child name seperated by "_". For example, "CUSTOMERS_ORDERS".

Returns:
the name

setName

public void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getOppositeName

public java.lang.String getOppositeName()
Get the name of the Relationship from the child side. If the value of the Opposite Name attribute is not specified, it defaults to the child table name and parent table name seperated by "_". For example, "ORDERS_CUSTOMERS".

Returns:
the name

setOppositeName

public void setOppositeName(java.lang.String value)
Sets the value of the 'Opposite Name' attribute.

Parameters:
value - the new value of the 'Opposite Name' attribute.
See Also:
getOppositeName()

isExclusive

public boolean isExclusive()
Returns the value of the Is Exclusive attribute. If the value is true, queries generated from this Relationship will use an inner join. If the value is false, a left outer join will be used. The default value is true.

Returns:
the value of the Is Exclusive attribute

setExclusive

public void setExclusive(boolean value)
Sets the value of the 'Exclusive' attribute.

Parameters:
value - the new value of the 'Exclusive' attribute.
See Also:
isExclusive()