com.sap.sl.sdk.authoring.datafoundation

Interface SQLJoin

All Superinterfaces:

Identifiable, Inheritable, Join

public interface SQLJoin
extends Join

A representation of the model object 'SQL Join'.

A join is a condition that links tables in the data foundation. The present release only supports SQL joins. See the Information Design Tool User Guide for more information about the types of SQL joins supported.

Use DataFoundationFactory.createSqlJoin(String, DataFoundation) to instantiate a join.

The following features are supported:

• Shortcut
• Expression
• Cardinality
• Outer Type
• Left Table
• Right Table

Method Summary

Modifier and Type	Method and Description
Cardinality	getCardinality() Returns the value of the 'Cardinality' attribute.
java.lang.String	getExpression() Returns the value of the 'Expression' attribute.
Table	getLeftTable() Returns the value of the 'Left Table' reference.
OuterType	getOuterType() Returns the value of the 'Outer Type' attribute.
Table	getRightTable() Returns the value of the 'Right Table' reference.
boolean	isShortcut() Returns the value of the 'Shortcut' attribute.
void	setCardinality(Cardinality value) Sets the value of the 'Cardinality' attribute.
void	setExpression(java.lang.String value) Sets the value of the 'Expression' attribute.
void	setOuterType(OuterType value) Sets the value of the 'Outer Type' attribute.
void	setShortcut(boolean value) Sets the value of the 'Shortcut' attribute.

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Identifiable

getIdentifier

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Inheritable

getInheritedData

Method Detail

isShortcut

boolean isShortcut()

Returns the value of the 'Shortcut' attribute.

Tells if this is a shortcut join. A shortcut join is a join that provides an alternative path between two tables.

Returns:

the value of the 'Shortcut' attribute.

See Also:

setShortcut(boolean)

setShortcut

void setShortcut(boolean value)

Sets the value of the 'Shortcut' attribute.

The join is a shortcut join if value is true.

Parameters:

value - the new value of the 'Shortcut' attribute.

See Also:

isShortcut()

getExpression

java.lang.String getExpression()

Returns the value of the 'Expression' attribute.

Based on the columns and operators selected, an SQL expression is automatically generated to define the join.

Returns:

the value of the 'Expression' attribute.

See Also:

setExpression(String)

setExpression

void setExpression(java.lang.String value)

Sets the value of the 'Expression' attribute.

This is the SQL expression that defines the join.

Parameters:

value - the new value of the 'Expression' attribute.

See Also:

getExpression()

getCardinality

Cardinality getCardinality()

Returns the value of the 'Cardinality' attribute. The literals are from the enumeration Cardinality.

Returns:

the value of the 'Cardinality' attribute.

See Also:

Cardinality, setCardinality(Cardinality)

setCardinality

void setCardinality(Cardinality value)

Sets the value of the 'Cardinality' attribute.

Parameters:

value - the new value of the 'Cardinality' attribute.

See Also:

Cardinality, getCardinality()

getOuterType

OuterType getOuterType()

Returns the value of the 'Outer Type' attribute. The default value is "OUTER_NONE". The literals are from the enumeration OuterType.

This is the type of outer join.

Returns:

the value of the 'Outer Type' attribute.

See Also:

OuterType, setOuterType(OuterType)

setOuterType

void setOuterType(OuterType value)

Sets the value of the 'Outer Type' attribute.

This is the type of outer join.

Parameters:

value - the new value of the 'Outer Type' attribute.

See Also:

OuterType, getOuterType()

getLeftTable

Table getLeftTable()

Returns the value of the 'Left Table' reference. Use in addition to getCardinality() to determine the direction of the join.

setExpression(String) does not modify the value. It is only modified with updated value at data foundation load and at SQL join creation.

Returns:

the value of the 'Left Table' reference.

getRightTable

Table getRightTable()

Returns the value of the 'Right Table' reference. Use in addition to getCardinality() to determine the direction of the join.

setExpression(String) does not modify the value. It is only modified with updated value at data foundation load and at SQL join creation.

Returns:

the value of the 'Right Table' reference.