wt.query
Interface TableExpression

All Superinterfaces:

Cloneable

All Known Subinterfaces:

PageableTableExpression

All Known Implementing Classes:

AbstractClassTableExpression, AbstractSubSelectTableExpression, ArrayTableExpression, ExternalTableExpression, IBAValueViewTableExpression, NullTableExpression

public interface TableExpression

extends Cloneable

This interface defines an expression that can be used to specify a "table" in a SQL FROM clause.

Supported API: true

Extendable: false

Field Summary

static String	ACCESS_CONTROL_REQUIRED Label for the attribute; Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.
static String	ADVANCED_QUERY Label for the attribute; Indicates if the expression uses advanced query capabilities.
static String	ADVANCED_QUERY_ENABLED Label for the attribute; Indicates if advanced query capabilities are enabled.
static String	BIND_PARAMETER Label for the attribute; Returns a bind parameter for this expression (if supported).
static String	DESCENDANTS_INCLUDED Label for the attribute; Indicates if descendant need to be included this TableExpression in the FROM clause.
static String	TABLE_CLASS Label for the attribute; The associated class for the table expression (if supported).

Method Summary

void	appendClassAttribute(ClassAttribute a_classAttribute) Supported API: false
Object	clone() Supported API: false
void	columnsReset() Supported API: false
Object	getBindParameter() Gets the value of the attribute: BIND_PARAMETER.
ItemBuilder	getColumnAccessItemBuilder(Class a_class, int a_fromIndex) Supported API: false
String	getExpression(AttributeMapInfo a_attributeMapInfo, AccessControllerProcessor a_accessControllerProcessor, String a_alias, int a_outerJoinType, boolean a_fullPersistableTable, boolean a_useBind) Return string representation of this expression.
JoinClause	getJoinCondition(String a_alias, boolean a_fullPersistable, Class a_tableClass) Supported API: false
String	getJoinCondition(String a_alias, Class a_tableClass, boolean a_fullPersistable) Supported API: false
Class	getTableClass() Gets the value of the attribute: TABLE_CLASS.
Vector	getTables() Returns a Vector of TableExpressions corresponding to this TableExpression.
Class[]	getValidClasses() Returns Class[] for tableClass and included Interfaces (If Supported) Supported API: false
boolean	isAccessControlled() Indicates if the TableExpression involves AccessControlled classes.
boolean	isAccessControlRequired() Gets the value of the attribute: ACCESS_CONTROL_REQUIRED.
boolean	isAdvancedQuery() Gets the value of the attribute: ADVANCED_QUERY.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: ADVANCED_QUERY_ENABLED.
boolean	isAutoNavigate() Supported API: false
boolean	isDescendantsIncluded() Gets the value of the attribute: DESCENDANTS_INCLUDED.
boolean	isUseViewTableAlias() Supported API: false
void	setAccessControlRequired(boolean a_AccessControlRequired) Sets the value of the attribute: ACCESS_CONTROL_REQUIRED.
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: ADVANCED_QUERY_ENABLED.
void	setDescendantsIncluded(boolean a_DescendantsIncluded) Sets the value of the attribute: DESCENDANTS_INCLUDED.

Field Detail

TABLE_CLASS

public static final String TABLE_CLASS

Label for the attribute; The associated class for the table expression (if supported).

Supported API: false

See Also:

Constant Field Values

BIND_PARAMETER

public static final String BIND_PARAMETER

Label for the attribute; Returns a bind parameter for this expression (if supported).

Supported API: false

See Also:

Constant Field Values

ACCESS_CONTROL_REQUIRED

public static final String ACCESS_CONTROL_REQUIRED

Label for the attribute; Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.

Supported API: false

See Also:

Constant Field Values

DESCENDANTS_INCLUDED

public static final String DESCENDANTS_INCLUDED

Label for the attribute; Indicates if descendant need to be included this TableExpression in the FROM clause.

Supported API: false

See Also:

Constant Field Values

ADVANCED_QUERY

public static final String ADVANCED_QUERY

Label for the attribute; Indicates if the expression uses advanced query capabilities.

Supported API: false

See Also:

Constant Field Values

ADVANCED_QUERY_ENABLED

public static final String ADVANCED_QUERY_ENABLED

Label for the attribute; Indicates if advanced query capabilities are enabled.

Supported API: false

See Also:

Constant Field Values

Method Detail

getTableClass

public Class getTableClass()

Gets the value of the attribute: TABLE_CLASS. The associated class for the table expression (if supported).

Supported API: false

Returns:

Class

getBindParameter

public Object getBindParameter()
                        throws WTException

Gets the value of the attribute: BIND_PARAMETER. Returns a bind parameter for this expression (if supported).

Supported API: false

Returns:

Object

Throws:

WTException

isAccessControlRequired

public boolean isAccessControlRequired()

Gets the value of the attribute: ACCESS_CONTROL_REQUIRED. Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.

Supported API: false

Returns:

boolean

setAccessControlRequired

public void setAccessControlRequired(boolean a_AccessControlRequired)

Sets the value of the attribute: ACCESS_CONTROL_REQUIRED. Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.

Supported API: false

Parameters:

a_AccessControlRequired -

isDescendantsIncluded

public boolean isDescendantsIncluded()

Gets the value of the attribute: DESCENDANTS_INCLUDED. Indicates if descendant need to be included this TableExpression in the FROM clause.

Supported API: false

Returns:

boolean

setDescendantsIncluded

public void setDescendantsIncluded(boolean a_DescendantsIncluded)

Sets the value of the attribute: DESCENDANTS_INCLUDED. Indicates if descendant need to be included this TableExpression in the FROM clause.

Supported API: false

Parameters:

a_DescendantsIncluded -

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

Gets the value of the attribute: ADVANCED_QUERY. Indicates if the expression uses advanced query capabilities.

Supported API: false

Returns:

boolean

Throws:

WTException

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

Gets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: false

Returns:

boolean

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

Sets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: false

Parameters:

a_AdvancedQueryEnabled -

getTables

public Vector getTables()
                 throws QueryException

Returns a Vector of TableExpressions corresponding to this TableExpression.

Supported API: false

Returns:

Vector

Throws:

QueryException

getExpression

public String getExpression(AttributeMapInfo a_attributeMapInfo,
                            AccessControllerProcessor a_accessControllerProcessor,
                            String a_alias,
                            int a_outerJoinType,
                            boolean a_fullPersistableTable,
                            boolean a_useBind)
                     throws WTException

Return string representation of this expression.

Supported API: false

Parameters:

a_attributeMapInfo - Attribute information to use for building the expression

a_accessControllerProcessor - AccessContoller to use for building the expression

a_alias -

a_outerJoinType -

a_fullPersistableTable -

a_useBind -

Returns:

String

Throws:

WTException

isAccessControlled

public boolean isAccessControlled()
                           throws WTException

Indicates if the TableExpression involves AccessControlled classes.

Supported API: false

Returns:

boolean

Throws:

WTException

isAutoNavigate

public boolean isAutoNavigate()
                       throws WTException

Supported API: false

Returns:

boolean

Throws:

WTException

getJoinCondition

public String getJoinCondition(String a_alias,
                               Class a_tableClass,
                               boolean a_fullPersistable)
                        throws WTException

Supported API: false

Parameters:

a_alias -

a_tableClass -

a_fullPersistable -

Returns:

String

Throws:

WTException

getColumnAccessItemBuilder

public ItemBuilder getColumnAccessItemBuilder(Class a_class,
                                              int a_fromIndex)
                                       throws PersistenceException

Supported API: false

Parameters:

a_class -

a_fromIndex -

Returns:

ItemBuilder

Throws:

PersistenceException

appendClassAttribute

public void appendClassAttribute(ClassAttribute a_classAttribute)

Supported API: false

Parameters:

a_classAttribute -

getValidClasses

public Class[] getValidClasses()
                        throws WTException

Returns Class[] for tableClass and included Interfaces (If Supported)

Supported API: false

Returns:

Class[]

Throws:

WTException

getJoinCondition

public JoinClause getJoinCondition(String a_alias,
                                   boolean a_fullPersistable,
                                   Class a_tableClass)
                            throws WTException

Supported API: false

Parameters:

a_alias -

a_fullPersistable -

a_tableClass -

Returns:

JoinClause

Throws:

WTException

columnsReset

public void columnsReset()

Supported API: false

isUseViewTableAlias

public boolean isUseViewTableAlias()

Supported API: false

Returns:

boolean

clone

public Object clone()

Supported API: false

Returns:

Object