borland Packages Class Hierarchy sql.dataset Package Index
java.lang.Object +----borland.jbcl.dataset.ReadRow +----borland.jbcl.dataset.ReadWriteRow +----borland.jbcl.dataset.DataSet +----borland.jbcl.dataset.StorageDataSet +----borland.sql.dataset.ProcedureDataSet
Constructors Properties Methods Event Listeners
Implements AccessListener, ColumnDesigner, MasterNavigateListener, StatusListener, Serializable, EventListener
The ProcedureDataSet component is an extension of its superclass (StorageDataSet) and provides functionality to run a stored procedure against data stored in a SQL database, passing in parameters if the procedure expects them. The procedure call is expected to return a cursor, or in the case of an InterBase select procedure, output that can be used to generate a DataSet. This component is recommended for advanced users only.
In any application that uses the ProcedureDataSet, the following components are also required:
The data contained in a ProcedureDataSet is the result of the most recent execution of the stored procedure. Storing the "result set" from the execution of the stored procedure in a ProcedureDataSet allows for greater flexibility in navigation of the resulting data.
The ProcedureDataSet inherits the maxRows property which allows you to set the maximum number of rows stored initially in the ProcedureDataSet as a result of the stored procedure execution.
Once the data is stored in the ProcedureDataSet, you manipulate it and connect it to UI controls in exactly the same way as you would other StorageDataSet components, without regard to which JBCL component is storing the data.
This component is used with servers whose JDBC driver supports executing stored procedures that generate a result set. Not all JDBC drivers support this; some vendor libraries require special API calls to invoke stored procedures. Refer to your server documentation for more information on whether it meets this requirement.
For an example on executing stored procedures in JBuilder, see Obtaining data through a stored procedure in the Database Application Developer's Guide.
Sybase users: Stored procedures on Sybase servers are created in a "Chained" transaction mode. In order to call Sybase stored procedures as part of a ProcedureResolver, the procedures must be modified to run in an unchained transaction mode. Use the Sybase stored system procedure sp_procxmode to change the transaction mode to either "anymore" or "unchained". See your Sybase documentation for additional information.
public ProcedureDataSet()Constructs a ProcedureDataSet component.
public final boolean isAccumulateResults() public final void setAccumulateResults(boolean accumulate)If true, the provided data is accumulated over consecutive calls to executeQuery. If false, subsequent executeQuery calls overwrite the existing DataSet.
public final Database getDatabase()Read-only property that returns the Database object associated with this ProcedureDataSet. This property is short cut to the database property of the ProcedureDescriptor object. Set this property using any ProcedureDescriptor constructor that takes a Database object as a parameter.
public ReadWriteRow getParameterRow()Read-only property that returns the ReadWriteRow object associated with this ProcedureDataSet. This property is short cut to the parameterRow property of the ProcedureDescriptor object. Set this property using any ProcedureDescriptor constructor that takes a ReadWriteRow object as a parameter.
public final ProcedureDescriptor getProcedure() public final void setProcedure(borland.sql.dataset.ProcedureDescriptor procedureDescriptor)The ProcedureDescriptor that stores the properties for this ProcedureDataSet.
public Provider getProvider() public void setProvider(borland.jbcl.dataset.Provider provider)The provider for this ProcedureDataSet.
public final String getQueryString()Read-only property that returns the query String associated with this ProcedureDataSet. This property is short cut to the queryString property of the ProcedureDescriptor object. Set this property using any ProcedureDescriptor constructor that takes a query string as a parameter.
public final void executeQuery()Executes the procedure with the specified Database and procedure properties, and populates the DataSet.
public void refresh()
Overrides: borland.jbcl.dataset.StorageDataSet.refresh()
public boolean refreshSupported()Used internally to specify whether refresh() is always supported by the ProcedureDataSet. This method is called, for example, to determine whether to enable the Refresh button on the NavigatorControl.
Overrides: borland.jbcl.dataset.StorageDataSet.refreshSupported()
public void saveChanges(borland.jbcl.dataset.DataSet dataSet)Saves changes made to the data. If no resolver has been specified, a QueryResolver is used by default.
Overrides: borland.jbcl.dataset.StorageDataSet.saveChanges(borland.jbcl.dataset.DataSet)
public boolean saveChangesSupported()Used internally to specify whether saveChanges() is always supported by the ProcedureDataSet. This method is called, for example, to determine whether to enable the Save button on the NavigatorControl.
Overrides: borland.jbcl.dataset.StorageDataSet.saveChangesSupported()
public final void addAccessListener(borland.jbcl.dataset.AccessListener listener) public final void removeAccessListener(borland.jbcl.dataset.AccessListener listener)
public synchronized void addCalcAggFieldsListener(borland.jbcl.dataset.CalcAggFieldsListener listener) public synchronized void removeCalcAggFieldsListener(borland.jbcl.dataset.CalcAggFieldsListener listener)
public synchronized void addCalcFieldsListener(borland.jbcl.dataset.CalcFieldsListener listener) public synchronized void removeCalcFieldsListener(borland.jbcl.dataset.CalcFieldsListener listener)
public final void addDataChangeListener(borland.jbcl.dataset.DataChangeListener listener) public final void removeDataChangeListener(borland.jbcl.dataset.DataChangeListener listener)
public void addEditListener(borland.jbcl.dataset.EditListener listener) public synchronized void removeEditListener(borland.jbcl.dataset.EditListener listener)
public final synchronized void addLoadListener(borland.jbcl.dataset.LoadListener listener) public final synchronized void removeLoadListener(borland.jbcl.dataset.LoadListener listener)
public final void addMasterNavigateListener(borland.jbcl.dataset.MasterNavigateListener listener) public final void removeMasterNavigateListener(borland.jbcl.dataset.MasterNavigateListener listener)
public final void addNavigationListener(borland.jbcl.dataset.NavigationListener listener) public final void removeNavigationListener(borland.jbcl.dataset.NavigationListener listener)
public final void addOpenListener(borland.jbcl.dataset.OpenListener listener) public final void removeOpenListener(borland.jbcl.dataset.OpenListener listener)
public final void addRowFilterListener(borland.jbcl.dataset.RowFilterListener listener) public final void removeRowFilterListener(borland.jbcl.dataset.RowFilterListener listener)
public final void addStatusListener(borland.jbcl.dataset.StatusListener listener) public final void removeStatusListener(borland.jbcl.dataset.StatusListener listener)