ifs.fnd.ap

Class PlsqlSelectCommand

java.lang.Object

ifs.fnd.ap.PlsqlCommand

ifs.fnd.ap.PlsqlSelectCommand

public class PlsqlSelectCommand
extends PlsqlCommand

For executing SELECT query statement through the PL/SQL Gateway. Can be excuted individually or together with other statements in a PlsqlCommandCollection.

Must be associated with a Server object before it's executed. Unless it's run in a PlsqlCommandCollection. In that case, the collection's Server object is used.

Author:

hedjse

Field Summary

Fields inherited from class ifs.fnd.ap.PlsqlCommand

bindVariables, commandText, srv

Constructor Summary

Constructors

Constructor and Description
PlsqlSelectCommand() Creates a new instance of class.
PlsqlSelectCommand(Server srv) Creates an instance of this class.
PlsqlSelectCommand(Server srv, java.lang.String sql) Creates in instance of this class.
PlsqlSelectCommand(java.lang.String sql) Creates an instance of this class.

Method Summary

Modifier and Type	Method and Description
protected void	createCommandRecord(Record cmd) Formats this command to a Record for sending to the PL/SQL Gateway.
RecordCollection	executeQuery() Executes this SELECT query statement and returns result set.
long	getMaxRows() Gets the MAXROWS setting.
RecordCollection	getResult() Gets the select command's result set.
long	getSkipRows() Gets the SKIPROWS settings.
protected void	processCommandRecord(Record cmd) Parses a [Command] Record from the PL/SQL Gateway into this command.
void	setMaxRows(long maxRows) Sets the MAXROWS setting.
void	setSelectColumns(java.lang.String selectColumns) Sets meta-data describing type and size of every column in the select list.
void	setSkipRows(long skipRows) Sets the SKIPROWS setting.

Methods inherited from class ifs.fnd.ap.PlsqlCommand

execute, getBindVariables, getCommandText, getServer, setCommandText, setServer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlsqlSelectCommand

public PlsqlSelectCommand()

Creates a new instance of class.

PlsqlSelectCommand

public PlsqlSelectCommand(Server srv)

Creates an instance of this class. Sets the Server object to use.

Parameters:

srv - the Server object to use for this command. Not used if run in a PlsqlCommandCollection.

PlsqlSelectCommand

public PlsqlSelectCommand(java.lang.String sql)

Creates an instance of this class. Sets the query to execute.

Parameters:

sql - the SELECT query to execute.

PlsqlSelectCommand

public PlsqlSelectCommand(Server srv,
                          java.lang.String sql)

Creates in instance of this class. Sets Server object to use and the query to execute.

Parameters:

srv - Server object to use. Unless run in a collection.

sql - the SELECT query to execute.

Method Detail

createCommandRecord

protected void createCommandRecord(Record cmd)
                            throws APException

Formats this command to a Record for sending to the PL/SQL Gateway.

Overrides:

createCommandRecord in class PlsqlCommand

Throws:

APException

setSelectColumns

public void setSelectColumns(java.lang.String selectColumns)

Sets meta-data describing type and size of every column in the select list. Type of columns are specified by type markers defined in class DataType. An unknown type may be specified with "?". An unknown size may be specified with -1.

Note! The implementation of this method depends on used JDBC driver.

For Oracle JDBC driver sizes of text columns are used to optimize memory allocation, while type markers are used to define the types of columns in the result set.

For DataDirect JDBC driver only type marker DEC (DataType.DECIMAL) is supported, all other column types and sizes are ignored.

Parameters:

selectColumns - string containing meta-data, for example: "T^100,T^2000,?^0,?^0,DEC^-1"

executeQuery

public RecordCollection executeQuery()
                              throws APException

Executes this SELECT query statement and returns result set. A Server object must have been set before calling this method.

Returns:

a RecordCollection with one record per row in the result set. May be null if there is no result set (which is not the same as a result set with no rows).

Throws:

APException - if there is an error executing the command.

java.lang.IllegalStateException - If no Server object has been set prior to invoking this method.

getResult

public RecordCollection getResult()

Gets the select command's result set.

Returns:

a RecordCollection with the result set, or null if there is no result set or the command hasn't been executed.

getMaxRows

public long getMaxRows()

Gets the MAXROWS setting. A value of zero means MAXROWS is not used.

See Also:

setMaxRows(long)

getSkipRows

public long getSkipRows()

Gets the SKIPROWS settings. A value of zero means SKIPROWS is not used.

See Also:

setSkipRows(long)

processCommandRecord

protected void processCommandRecord(Record cmd)
                             throws APException

Parses a [Command] Record from the PL/SQL Gateway into this command.

Overrides:

processCommandRecord in class PlsqlCommand

Throws:

APException

setMaxRows

public void setMaxRows(long maxRows)

Sets the MAXROWS setting.

Parameters:

maxRows - the number of rows to limit the result set to. A value of zero means MAXROWS is not used.

setSkipRows

public void setSkipRows(long skipRows)

Sets the SKIPROWS setting.

Parameters:

skipRows - the number of rows in the result set to skip. A value of zero means SKIPROWS is not used.