wt.query
Class ExternalTableExpression

java.lang.Object
  wt.query.ExternalTableExpression

All Implemented Interfaces:

Cloneable, Externalizable, Serializable, TableExpression

public class ExternalTableExpression

extends Object

implements TableExpression, Externalizable

This class represents a table which can be used in a SQL FROM clause. The exact table name specified is used directly in the SQL statement.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private boolean	advancedQueryEnabled
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	name
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from interface wt.query.TableExpression

ACCESS_CONTROL_REQUIRED, ADVANCED_QUERY, ADVANCED_QUERY_ENABLED, BIND_PARAMETER, DESCENDANTS_INCLUDED, TABLE_CLASS

Constructor Summary

ExternalTableExpression()


Supported API: false

ExternalTableExpression(String a_name)


Supported API: false

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: bindParameter; Returns a bind parameter for this expression (if supported).
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
String	getName() Gets the value of the attribute: name; Name of the external table.
Class	getTableClass() Gets the value of the attribute: tableClass; The associated class for the table expression (if supported).
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: accessControlRequired; Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.
boolean	isAdvancedQuery() Gets the value of the attribute: advancedQuery; Indicates if the expression uses advanced query capabilities.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
boolean	isAutoNavigate() Supported API: false
boolean	isDescendantsIncluded() Gets the value of the attribute: descendantsIncluded; Indicates if descendant need to be included this TableExpression in the FROM clause.
boolean	isUseViewTableAlias() Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ExternalTableExpression thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAccessControlRequired(boolean a_AccessControlRequired) Sets the value of the attribute: accessControlRequired; Indicates if Access Control is required for SELECT columns that reference this TableExpression in the FROM clause.
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
void	setDescendantsIncluded(boolean a_DescendantsIncluded) Sets the value of the attribute: descendantsIncluded; Indicates if descendant need to be included this TableExpression in the FROM clause.
void	setName(String a_Name) Sets the value of the attribute: name; Name of the external table.
String	toString()
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

advancedQueryEnabled

private transient boolean advancedQueryEnabled

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ExternalTableExpression

public ExternalTableExpression()

Supported API: false

ExternalTableExpression

public ExternalTableExpression(String a_name)

Supported API: false

Parameters:

a_name - Name of the external table.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ExternalTableExpression thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getName

public String getName()

Gets the value of the attribute: name; Name of the external table.

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name; Name of the external table.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isDescendantsIncluded

public boolean isDescendantsIncluded()

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

Supported API: false

Specified by:

isDescendantsIncluded in interface TableExpression

Returns:

boolean

setDescendantsIncluded

public void setDescendantsIncluded(boolean a_DescendantsIncluded)

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

Supported API: false

Specified by:

setDescendantsIncluded in interface TableExpression

Parameters:

a_DescendantsIncluded -

getTableClass

public Class getTableClass()

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

Supported API: false

Specified by:

getTableClass in interface TableExpression

Returns:

Class

getBindParameter

public Object getBindParameter()
                        throws WTException

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

Supported API: false

Specified by:

getBindParameter in interface TableExpression

Returns:

Object

Throws:

WTException

isAccessControlRequired

public boolean isAccessControlRequired()

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

Supported API: false

Specified by:

isAccessControlRequired in interface TableExpression

Returns:

boolean

setAccessControlRequired

public void setAccessControlRequired(boolean a_AccessControlRequired)

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

Supported API: false

Specified by:

setAccessControlRequired in interface TableExpression

Parameters:

a_AccessControlRequired -

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

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

Supported API: false

Specified by:

isAdvancedQuery in interface TableExpression

Returns:

boolean

Throws:

WTException

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

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

Supported API: false

Specified by:

isAdvancedQueryEnabled in interface TableExpression

Returns:

boolean

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

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

Supported API: false

Specified by:

setAdvancedQueryEnabled in interface TableExpression

Parameters:

a_AdvancedQueryEnabled -

getTables

public Vector getTables()
                 throws QueryException

Returns a Vector of TableExpressions corresponding to this TableExpression.

Supported API: false

Specified by:

getTables in interface TableExpression

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

Specified by:

getExpression in interface TableExpression

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

Specified by:

isAccessControlled in interface TableExpression

Returns:

boolean

Throws:

WTException

isAutoNavigate

public boolean isAutoNavigate()
                       throws WTException

Supported API: false

Specified by:

isAutoNavigate in interface TableExpression

Returns:

boolean

Throws:

WTException

getJoinCondition

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

Supported API: false

Specified by:

getJoinCondition in interface TableExpression

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

Specified by:

getColumnAccessItemBuilder in interface TableExpression

Parameters:

a_class -

a_fromIndex -

Returns:

ItemBuilder

Throws:

PersistenceException

appendClassAttribute

public void appendClassAttribute(ClassAttribute a_classAttribute)

Supported API: false

Specified by:

appendClassAttribute in interface TableExpression

Parameters:

a_classAttribute -

getValidClasses

public Class[] getValidClasses()
                        throws WTException

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

Supported API: false

Specified by:

getValidClasses in interface TableExpression

Returns:

Class[]

Throws:

WTException

getJoinCondition

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

Supported API: false

Specified by:

getJoinCondition in interface TableExpression

Parameters:

a_alias -

a_fullPersistable -

a_tableClass -

Returns:

JoinClause

Throws:

WTException

columnsReset

public void columnsReset()

Supported API: false

Specified by:

columnsReset in interface TableExpression

isUseViewTableAlias

public boolean isUseViewTableAlias()

Supported API: false

Specified by:

isUseViewTableAlias in interface TableExpression

Returns:

boolean

clone

public Object clone()

Supported API: false

Specified by:

clone in interface TableExpression

Returns:

Object

toString

public String toString()