wt.query
Class PageableQuerySpec

java.lang.Object
  wt.query.PageableQuerySpec

All Implemented Interfaces:

Externalizable, Serializable, StatementSpec

Direct Known Subclasses:

BasicPageableQuerySpec, ObjectReferenceSpec, PagingSessionSpec

public abstract class PageableQuerySpec

extends Object

implements StatementSpec, Externalizable

This abstract class provides common APIs and functionality for queries that support paging. The primary statement is the source of the results that can be paged. The offset and range values specify the page offset and size.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private boolean	advancedQueryEnabled
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private int	offset
protected static long	OLD_FORMAT_VERSION_UID
private StatementSpec	primaryStatement
private int	range
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from interface wt.pds.StatementSpec

ADVANCED_QUERY, ADVANCED_QUERY_ENABLED, AGGREGATE_SELECT, CORRELATED_CLASS_ATTRIBUTES, FETCH_SIZE, PRIMARY_CLASS, QUERY_LIMIT, RESULT_BUILDER, RESULT_CURSOR, SINGLE_RESULT_COMPATIBLE, STATEMENT_BUILDER, USE_BIND

Constructor Summary

PageableQuerySpec()

Method Summary

int	getBindParameterCount() Supported API: false
List	getCorrelatedClassAttributes() Gets the value of the attribute: correlatedClassAttributes.
int	getFetchSize() Gets the value of the attribute: fetchSize; A hint as to the number of rows that should be fetched from the database when more rows are needed.
int	getOffset() Gets the value of the attribute: offset; Paging offset into the original result set.
Class	getPrimaryClass() Gets the value of the attribute: primaryClass; Primary class for the query.
StatementSpec	getPrimaryStatement() Gets the object for the association that plays role: primaryStatement.
int	getQueryLimit() Gets the value of the attribute: queryLimit.
int	getRange() Gets the value of the attribute: range; Paging range that specifies the number of requested elements.
ResultBuilder	getResultBuilder() Gets the object for the association that plays role: resultBuilder.
ResultCursor	getResultCursor() Gets the object for the association that plays role: resultCursor.
StatementBuilder	getStatementBuilder() Gets the object for the association that plays role: statementBuilder.
boolean	isAdvancedQuery() Gets the value of the attribute: advancedQuery; Indicates if the statement uses advanced query capabilities.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
boolean	isAggregateSelect() Gets the value of the attribute: aggregateSelect; Indicates if the statement has aggregate select .
boolean	isSingleResultCompatible() Gets the value of the attribute: singleResultCompatible; Indicates if the query result should be returned as a single result (for backward compatibility) Supported API: false
boolean	isUseBind() Gets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.
private void	primaryStatementValidate(StatementSpec a_PrimaryStatement)
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(PageableQuerySpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
void	setBindParameterAt(Object a_value, int a_index) Supported API: false
void	setFetchSize(int a_FetchSize) Sets the value of the attribute: fetchSize; A hint as to the number of rows that should be fetched from the database when more rows are needed.
void	setLocale(Locale a_locale) Set the client locale.
void	setOffset(int a_Offset) Sets the value of the attribute: offset; Paging offset into the original result set.
protected void	setPrimaryStatement(StatementSpec a_PrimaryStatement) Sets the object for the association that plays role: primaryStatement.
void	setRange(int a_Range) Sets the value of the attribute: range; Paging range that specifies the number of requested elements.
void	setUseBind(boolean a_UseBind) Sets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

offset

private int offset

range

private int range

advancedQueryEnabled

private transient boolean advancedQueryEnabled

primaryStatement

private StatementSpec primaryStatement

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

PageableQuerySpec

public PageableQuerySpec()

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(PageableQuerySpec 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

getOffset

public int getOffset()

Gets the value of the attribute: offset; Paging offset into the original result set.

Supported API: true

Returns:

int

setOffset

public void setOffset(int a_Offset)
               throws WTPropertyVetoException

Sets the value of the attribute: offset; Paging offset into the original result set.

Supported API: true

Parameters:

a_Offset -

Throws:

WTPropertyVetoException

getRange

public int getRange()

Gets the value of the attribute: range; Paging range that specifies the number of requested elements. If the range is less than or equal to zero, then all elements are returned.

Supported API: true

Returns:

int

setRange

public void setRange(int a_Range)
              throws WTPropertyVetoException

Sets the value of the attribute: range; Paging range that specifies the number of requested elements. If the range is less than or equal to zero, then all elements are returned.

Supported API: true

Parameters:

a_Range -

Throws:

WTPropertyVetoException

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

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

Supported API: true

Specified by:

isAdvancedQueryEnabled in interface StatementSpec

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: true

Specified by:

setAdvancedQueryEnabled in interface StatementSpec

Parameters:

a_AdvancedQueryEnabled -

getPrimaryStatement

public StatementSpec getPrimaryStatement()

Gets the object for the association that plays role: primaryStatement.

Supported API: false

Returns:

StatementSpec

setPrimaryStatement

protected void setPrimaryStatement(StatementSpec a_PrimaryStatement)
                            throws WTPropertyVetoException

Sets the object for the association that plays role: primaryStatement.

Supported API: false

Parameters:

a_PrimaryStatement -

Throws:

WTPropertyVetoException

primaryStatementValidate

private void primaryStatementValidate(StatementSpec a_PrimaryStatement)
                               throws WTPropertyVetoException

Parameters:

a_PrimaryStatement -

Throws:

WTPropertyVetoException

setLocale

public void setLocale(Locale a_locale)
               throws WTException

Set the client locale.

Supported API: true

Specified by:

setLocale in interface StatementSpec

Parameters:

a_locale -

Throws:

WTException

setBindParameterAt

public void setBindParameterAt(Object a_value,
                               int a_index)

Supported API: false

Specified by:

setBindParameterAt in interface StatementSpec

Parameters:

a_value -

a_index -

getBindParameterCount

public int getBindParameterCount()

Supported API: false

Specified by:

getBindParameterCount in interface StatementSpec

Returns:

int

getPrimaryClass

public Class getPrimaryClass()

Gets the value of the attribute: primaryClass; Primary class for the query.

Supported API: false

Specified by:

getPrimaryClass in interface StatementSpec

Returns:

Class

isSingleResultCompatible

public boolean isSingleResultCompatible()

Gets the value of the attribute: singleResultCompatible; Indicates if the query result should be returned as a single result (for backward compatibility)

Supported API: false

Specified by:

isSingleResultCompatible in interface StatementSpec

Returns:

boolean

getQueryLimit

public int getQueryLimit()

Gets the value of the attribute: queryLimit.

Supported API: false

Specified by:

getQueryLimit in interface StatementSpec

Returns:

int

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

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

Supported API: false

Specified by:

isAdvancedQuery in interface StatementSpec

Returns:

boolean

Throws:

WTException

isAggregateSelect

public boolean isAggregateSelect()

Gets the value of the attribute: aggregateSelect; Indicates if the statement has aggregate select .

Supported API: false

Specified by:

isAggregateSelect in interface StatementSpec

Returns:

boolean

getCorrelatedClassAttributes

public List getCorrelatedClassAttributes()

Gets the value of the attribute: correlatedClassAttributes.

Supported API: false

Specified by:

getCorrelatedClassAttributes in interface StatementSpec

Returns:

List

isUseBind

public boolean isUseBind()

Gets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.

Supported API: true

Specified by:

isUseBind in interface StatementSpec

Returns:

boolean

setUseBind

public void setUseBind(boolean a_UseBind)
                throws WTPropertyVetoException

Sets the value of the attribute: useBind; Indicates if bind parameters should be used for this statement.

Supported API: true

Specified by:

setUseBind in interface StatementSpec

Parameters:

a_UseBind -

Throws:

WTPropertyVetoException

getFetchSize

public int getFetchSize()

Gets the value of the attribute: fetchSize; A hint as to the number of rows that should be fetched from the database when more rows are needed.

Supported API: false

Specified by:

getFetchSize in interface StatementSpec

Returns:

int

setFetchSize

public void setFetchSize(int a_FetchSize)
                  throws WTPropertyVetoException

Sets the value of the attribute: fetchSize; A hint as to the number of rows that should be fetched from the database when more rows are needed.

Supported API: false

Specified by:

setFetchSize in interface StatementSpec

Parameters:

a_FetchSize -

Throws:

WTPropertyVetoException

getStatementBuilder

public StatementBuilder getStatementBuilder()

Gets the object for the association that plays role: statementBuilder.

Supported API: false

Specified by:

getStatementBuilder in interface StatementSpec

Returns:

StatementBuilder

getResultBuilder

public ResultBuilder getResultBuilder()

Gets the object for the association that plays role: resultBuilder.

Supported API: false

Specified by:

getResultBuilder in interface StatementSpec

Returns:

ResultBuilder

getResultCursor

public ResultCursor getResultCursor()

Gets the object for the association that plays role: resultCursor.

Supported API: false

Specified by:

getResultCursor in interface StatementSpec

Returns:

ResultCursor