borland Packages  Class Hierarchy  jbcl.dataset Package  Index 

ProviderHelp class

java.lang.Object
   +----borland.jbcl.dataset.ProviderHelp

About the ProviderHelp class

Properties  Methods  
This class collects utility functions that operate on the StorageDataSet and DataSet classes that are helpful for Provider/Resolver implementations. These methods are implemented inside StorageDataSet, but are not functions typical for DataSet usage.

ProviderHelp properties

*Read-only properties **Write-only properties

Properties implemented in java.lang.Object

ProviderHelp methods

Methods implemented in this class

Methods implemented in java.lang.Object


ProviderHelp methods

createColumnMap(borland.jbcl.dataset.StorageDataSet, borland.jbcl.dataset.Column[], int[])

  public static final int[] createColumnMap(borland.jbcl.dataset.StorageDataSet dataSet, borland.jbcl.dataset.Column[] columns, int[] columnMap)
Creates an ordinal mapping from the DataSet's Column components to the provided columns array. If the columnMap parameter is null, an array of int (int[]) is used.

endResolution(borland.jbcl.dataset.StorageDataSet)

  public static final void endResolution(borland.jbcl.dataset.StorageDataSet dataSet)
Used by the ResolutionManager to signal that StorageDataSet is no longer in a "resolving" mode. Once the startResolution() method is called, any other providing or resolving operation is prohibited until this method is called.

failIfOpen(borland.jbcl.dataset.StorageDataSet)

  public static final void failIfOpen(borland.jbcl.dataset.StorageDataSet dataSet)
Causes a DataSetException to be thrown if the DataSet is open.

getStructureAge(borland.jbcl.dataset.StorageDataSet)

  public static final int getStructureAge(borland.jbcl.dataset.StorageDataSet dataSet)

isCopyProviderStreams(borland.jbcl.dataset.StorageDataSet)

  public static final boolean isCopyProviderStreams(borland.jbcl.dataset.StorageDataSet dataSet)
Returns true if Providers should make copies of InputStreams for columns that have Variant.BINARY_STREAM data type.

isProviderPropertyChanged(borland.jbcl.dataset.StorageDataSet)

  public static final boolean isProviderPropertyChanged(borland.jbcl.dataset.StorageDataSet dataSet)
Used by Provider classes. This property reflects whether this StorageDataSet has received some property change which could affect the column structure or set of row data, for example, a change in QueryDescriptor or TextDataFile.

markPendingStatus(borland.jbcl.dataset.DataSet, boolean)

  public static final void markPendingStatus(borland.jbcl.dataset.DataSet dataSet, boolean on)
Marks a row as pending resolution. Used by the ResolutionManager when saving changes from a DataSet to a remote data provider that supports transactions, for example, JDBC connections.

replaceColumns(borland.jbcl.dataset.StorageDataSet, borland.jbcl.dataset.Column[], boolean)

  public static final void replaceColumns(borland.jbcl.dataset.StorageDataSet dataSet, borland.jbcl.dataset.Column[] columns, boolean keepExistingColumns)
Used by Provider classes. This method differs from setColumns in that it preserves persistent columns. If keepExistingColumns is true, non-persistent columns are also retained. Several column properties in the columns array will be merged in with existing columns in the StorageDataSet that have the same name property setting.

setMetaDataMissing(borland.jbcl.dataset.StorageDataSet, boolean)

  public static final void setMetaDataMissing(borland.jbcl.dataset.StorageDataSet dataSet, boolean metaDataMissing)
Normally set by Providers to indicate that there is insufficient metadata to post any changes back to its original source.

setProviderPropertyChanged(borland.jbcl.dataset.StorageDataSet, boolean)

  public static final void setProviderPropertyChanged(borland.jbcl.dataset.StorageDataSet dataSet, boolean propertiesChanged)
Used by Provider classes. This property reflects whether this StorageDataSet has received some property change which could affect the column structure or set of row data, for example, a change in QueryDescriptor or TextDataFile.

See also: isProviderPropertyChanged(borland.jbcl.dataset.StorageDataSet)

startResolution(borland.jbcl.dataset.StorageDataSet, boolean)

  public static final void startResolution(borland.jbcl.dataset.StorageDataSet dataSet, boolean postEdits)
Used by the ResolutionManager to place a StorageDataSet into a "resolving" mode. This mode prohibits any other resolution or providing to occur. After the resolution phase is complete, the endResolution() method should be called. If postEdits is true, the StorageDataSet will post an unposted row for itself and any DataSetViews that may be associated with the StorageDataSet.