borland Packages Class Hierarchy dx.sql.dataset Package
ProcedureDescriptor class
java.lang.Object
+----com.borland.dx.sql.dataset.QueryDescriptor
+----com.borland.dx.sql.dataset.ProcedureDescriptor
About the ProcedureDescriptor class
Constructors Properties Methods
Implements Serializable
The ProcedureDescriptor class stores property settings associated with a ProcedureDataSet. Its main properties are:
- its associated Database component (required)
- the stored procedure escape sequence or the SQL statement (required)
- whether to execute the stored procedure immediately when the ProcedureDataSet is opened (defaults to true)
- how the data should be loaded into the ProcedureDataSet
To work with this component programmatically, set its properties when instantiating the
ProcedureDescriptor object, or individually by its write accessor methods. For properties that do
not have corresponding setter methods, use a constructor that takes that property as a parameter.
Data can be loaded all in one fetch, as needed, asynchronously or one at a time.
When working with asynchronous queries, opening the ProcedureDataSet then immediately calling
methods such as rowCount() typically returns a row count lower than expected. To avoid this,
either set the stored procedure to run synchronously, listen for the LoadingEvent, perform
other actions while the ProcedureDataSet completes loading, or listen for updates to the row count.
With asynchronous loading, as the stored procedure fetches rows of data, they are appended
to the end of the DataSet. If working with a sorted view of the DataSet, the new rows
appear in the specified sort order. Also, be careful to not make assumptions about the current row
position since rows are inserted into the sorted view as they are fetched, thereby changing row positions
automatically.
For more information on executing stored procedures in JBuilder, see the
ProcedureDataSet component.
Note: If a stored procedure is run against a synonym on an
Oracle server, it is dependent on the support of synonyms in the JDBC driver to determine whether the
stored procedure is updatable.
ProcedureDescriptor constructors
- ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String)
- ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean)
- ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean, boolean)
- ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean, int)
ProcedureDescriptor properties
*Read-only properties **Write-only properties
Properties implemented in java.lang.Object
ProcedureDescriptor methods
Methods implemented in java.lang.Object
- clone()
- equals(java.lang.Object)
- finalize()
- hashCode()
- notify()
- notifyAll()
- wait()
- wait(long)
- wait(long, int)
ProcedureDescriptor constructors
ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String)
public ProcedureDescriptor(Database database, String query)
Constructs a ProcedureDescriptor object with the specified parameters:
Parameters:
- database
- The associated Database object.
- query
- The stored procedure escape or SQL statement to run against the database.
ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean)
public ProcedureDescriptor(Database database, String query, ReadWriteRow parameters, boolean executeOnOpen)
Constructs a ProcedureDescriptor object with the specified parameters:
Parameters:
- database
- The associated Database object.
- query
- The stored procedure escape or SQL statement to run against the database.
- parameters
- The ReadWriteRow implementation that stores the parameter values for the stored procedure.
- executeOnOpen
- Whether or not the stored procedure escape or SQL statement should execute immediately when an object that is bound to the ProcedureDataSet is opened.
ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean, boolean)
public ProcedureDescriptor(Database database, String query, ReadWriteRow parameters, boolean executeOnOpen, boolean asynchronousExecution)
This constructor has been deprecated. Use a constructor that takes a loadOption parameter, or set the loadOption property directly.
ProcedureDescriptor(com.borland.dx.sql.dataset.Database, java.lang.String, com.borland.dx.dataset.ReadWriteRow, boolean, int)
public ProcedureDescriptor(Database database, String query, ReadWriteRow parameters, boolean executeOnOpen, int loadOption)
Constructs a ProcedureDescriptor object with the specified parameters:
Parameters:
- database
- The associated Database object.
- query
- The stored procedure escape or SQL statement to run against the database.
- parameters
- The ReadWriteRow implementation that stores the parameter values for the stored procedure.
- executeOnOpen
- Whether or not the stored procedure escape or SQL statement should execute immediately when an object that is bound to the ProcedureDataSet is opened.
- loadOption
- How the data should be loaded into the ProcedureDataSet.
Constants for this parameter are defined in Load variables.