com.progress.open4gl
Class SDOParameters

java.lang.Object
  |
  +--com.progress.open4gl.SDOParameters

All Implemented Interfaces:

java.io.Serializable

public final class SDOParameters

extends java.lang.Object

implements java.io.Serializable

This is a "catch all" class for passing initial parameters to an SDOResultSet object through the _createSDOResultSet() method. All the parameters not specified as parameters of _createSDOResultSet() are passed through an SDOParameters object.

See Also:

SDOAppObject, SDOResultSet, SDOScrollingMode, Serialized Form

Field Summary

static int	DEFAULT_FETCH_SIZE
static int	DEFAULT_MAXPREFETCH_ROWS
static int	MINIMUM_FETCH_SIZE
static int	MINIMUM_MAXPREFETCH_ROWS
static int	PREFETCH_SIZE

Constructor Summary

SDOParameters()

Method Summary

int	getFetchSize()
int	getPrefetchMaxRows()
java.lang.String	getRowIdentity()
SDOScrollingMode	getScrollingMode()
boolean	getStateless()
boolean	scrollingModeWasSet()
void	setFetchSize(int fSize) Sets the number of rows to be fetched whenever the SDOResultSet gets more rows from the server.
void	setPrefetchMaxRows(int maxRows) Sets the maximum number of rows to be fetched in PREFETCH mode.
void	setRowIdentity(java.lang.String id) To create an SDOResultSet object with the cursor positioned before a specific row.
void	setScrollingMode(SDOScrollingMode mode) Sets the scrolling mode of the SDOResultSet object.
void	setStateless(boolean s) If Stateless is set to true then the implementation of the SDOResultSet object will automatically create and delete the underlying SDOProcObject in order to free the AppServer for requests from other clients.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FETCH_SIZE

public static final int DEFAULT_FETCH_SIZE

See Also:

Constant Field Values

DEFAULT_MAXPREFETCH_ROWS

public static final int DEFAULT_MAXPREFETCH_ROWS

See Also:

Constant Field Values

MINIMUM_FETCH_SIZE

public static final int MINIMUM_FETCH_SIZE

See Also:

Constant Field Values

MINIMUM_MAXPREFETCH_ROWS

public static final int MINIMUM_MAXPREFETCH_ROWS

See Also:

Constant Field Values

PREFETCH_SIZE

public static final int PREFETCH_SIZE

See Also:

Constant Field Values

Constructor Detail

SDOParameters

public SDOParameters()

Method Detail

getFetchSize

public int getFetchSize()

Returns:

the value set by setFetchSize(), or the default.

getPrefetchMaxRows

public int getPrefetchMaxRows()

Returns:

the value set by setPrefetchMaxRows(), or the default.

getRowIdentity

public java.lang.String getRowIdentity()

Returns:

the value set by setRowIdentity

getScrollingMode

public SDOScrollingMode getScrollingMode()

Returns:

the value set by setScrollingMode(), or the KEEP_ROWS default

getStateless

public boolean getStateless()

Returns:

the value set by setStateless(), or the default which is false

scrollingModeWasSet

public boolean scrollingModeWasSet()

Returns:

true if setScrollingMode was called

setFetchSize

public void setFetchSize(int fSize)

Sets the number of rows to be fetched whenever the SDOResultSet gets more rows from the server.

Parameters:

fSize - the number of rows

setPrefetchMaxRows

public void setPrefetchMaxRows(int maxRows)

Sets the maximum number of rows to be fetched in PREFETCH mode. Since the Stateless mode is always a PREFETCH mode, it also determines the maximum number of rows fetched in Stateless mode. setPrefetchMaxRows() would be typically used in conjunction with reOpenQuery(String rowId) to handle very large result sets: The setPrefetchMaxRows() call limits the number of rows fetched by the query while the reOpenQuery(String rowId) is used to get more rows from a specific rowId. setPrefetchMaxRows() has no effect on scrolling modes other than the PREFETCH mode.

Parameters:

maxRows - the number of rows

setRowIdentity

public void setRowIdentity(java.lang.String id)

To create an SDOResultSet object with the cursor positioned before a specific row. If rowId is null then position before the first row.

Parameters:

id - the row identity of the specified row

setScrollingMode

public void setScrollingMode(SDOScrollingMode mode)

Sets the scrolling mode of the SDOResultSet object. The default is KEEP_ROWS

Parameters:

mode - one of the modes specified by the SDOScrollingMode class

setStateless

public void setStateless(boolean s)

If Stateless is set to true then the implementation of the SDOResultSet object will automatically create and delete the underlying SDOProcObject in order to free the AppServer for requests from other clients.

Parameters:

s - true if a Stateless mode is desired