com.borland Packages  com.borland Class Hierarchy

Chapter 4
dx.dataset package


About the com.borland.dx.dataset package

The dx.dataset package contains classes and interfaces that provide basic data access. This package also defines base provider and resolver classes as well as an abstract DataSet class that is extended to other DataSet objects. These classes provide access to information stored in databases and other data sources.

This package includes functionality covering the three main phases of data handling:

Data handling

Providing General functionality to obtain data and manage local data sets. (JDBC specific connections to remote servers are handled by classes in the com.borland.dx.sql.dataset package.)
Manipulation    Navigation and editing of the data locally.
Resolving General routines for the updating of data from the local DataSet back to the original source of the data. (Resolving data changes to remote servers through JDBC is handled by classes in the com.borland.dx.sql.dataset package.)
 

The dx.dataset package contains the following types of classes:

The following classes, components, and interfaces in this package are used internally by classes in this and other com.borland packages. These classes, components, and interfaces are not intended for general use and are not documented. Do not use them directly in your application.

The following classes in this package are BeanInfos:

For more information, visit the database newsgroup. Details on newsgroups can be found at http://www.borland.com/newsgroups. The database newsgroup is dedicated to issues about writing database applications in and is actively monitored by our support engineers as well as the Development team.

See also:
Overview of classes in this package
com.borland.dx.sql.dataset package
Library overview


Interfaces

  • AccessListener
  • CalcAggFieldsListener
  • CalcFieldsListener
  • CalcType
  • CoerceFromListener
  • CoerceToListener
  • ColumnAware
  • ColumnChangeListener
  • ColumnDesigner
  • ColumnPaintListener
  • CustomPaintSite
  • DataChangeListener
  • DataModule
  • DataSetAware
  • Designable
  • DxDispatch
  • EditListener
  • ExceptionListener
  • LoadCancel
  • LoadListener
  • LoadRowListener
  • Locate
  • MasterNavigateListener
  • MasterUpdateListener
  • MetaDataUpdate
  • NavigationListener
  • OpenListener
  • ResolverListener
  • ResponseListener
  • RowFilterListener
  • RowStatus
  • Sort
  • StatusListener
  • Store
  • StoreClassFactory
  • StoreInternals
  • UpdateMode
  • Classes and components

  • AccessEvent
  • AggDescriptor
  • AggManager
  • AggOperator
  • BoundsAggOperator
  • CalcAggFieldsAdapter
  • Coercer
  • Column
  • ColumnBeanInfo
  • ColumnChangeAdapter
  • ColumnList
  • ColumnPaintAdapter
  • ColumnVariant
  • CountAggOperator
  • CustomAggOperator
  • DataChangeAdapter
  • DataChangeEvent
  • DataFile
  • DataFileFormat
  • DataIndex
  • DataRow
  • DataSet
  • DataSetData
  • DataSetException
  • DataSetView
  • DataSetViewBeanInfo
  • DirectIndex
  • EditAdapter
  • ExceptionEvent
  • Index
  • IndexData
  • InternalRow
  • LoadEvent
  • MasterLinkDescriptor
  • MasterNavigateEvent
  • MasterUpdateEvent
  • MatrixData
  • MaxAggOperator
  • MinAggOperator
  • NavigationEvent
  • OpenAdapter
  • ParameterRow
  • ParameterRowBeanInfo
  • ParameterType
  • PickListDescriptor
  • Provider
  • ProviderHelp
  • ReadRow
  • ReadWriteRow
  • Resolver
  • ResolverAdapter
  • ResolverResponse
  • ResponseAdapter
  • ResponseEvent
  • RowFilterResponse
  • RowIterator
  • RowVariant
  • SortDescriptor
  • StatusEvent
  • StorageDataSet
  • StorageDataSetBeanInfo
  • SumAggOperator
  • TableDataSet
  • TableDataSetBeanInfo
  • TextDataFile
  • TextDataFileBeanInfo
  • ValidationException
  • Variant
  • VariantException

  • Overview of classes in the com.borland.dx.dataset package

    Aggregate operator classes

    AggOperator
    Components that perform aggregate operations for aggregate columns. Specified through the aggDescriptor property of a Column.

    CountAggOperator
    Extends AggOperator. Used to maintain a count aggregation. Specified through the aggDescriptor property of a Column.
    SumAggOperator
    Extends AggOperator. Used to maintain a sum aggregation. Specified through the aggDescriptor property of a Column.
    CustomAggOperator
    Extends AggOperator. Used to maintain a custom aggregation via the implementation of the CalcAggFieldsListener methods. Specified through the aggDescriptor property of a Column.

    MaxAggOperator
    Extends AggOperator. Used to maintain a Max aggregation. Specified through the aggDescriptor property of a Column.
    MinAggOperator
    Extends AggOperator. Used to maintain a Min aggregation. Specified through the aggDescriptor property of a Column.

    Column-related classes

    Column
    Stores column properties such as persistence, max and min values, alignment, and data type. Values stored in a Column are accessed through DataSet APIs.
    ColumnVariant
    Extends variant. Used in the context of data-aware controls. Provides the associated column and DataSet from which this value came.

    DataSet classes

    DataSet
    An abstract class to provide a cursor for accessing and navigating table data. Manages a pseudo-record in memory to temporarily store a newly inserted row, or changes to the current row. Multiple data-aware controls can be bound to and synchronized with the same DataSet. Supports master-detail relationships. Supports model-view data-aware controls, to enable easy and flexible editing and navigation of data in a common way regardless of how the data was obtained.

    StorageDataSet
    Implements DataSet, to store data. Can obtain data from a remote server through the use of a query or stored procedure, or from a text file. After data is stored in a StorageDataSet, you can easily manipulate it and connect it to UI controls, without regard to which component is storing the data.
    TableDataSet
    Extends StorageDataSet. A simple DataSet with no formal provider or resolver of its data. Used to create a StorageDataSet from sources other than SQL databases.

    CoerceFromListener
    Used by implementors of Providers and Resolvers to coerce data from the type of the data source to the type of the Column. It is used by QueryDataSet, ProcedureDataSet, QueryResolver, and ProcedureResolver components.
    CoerceToListener
    Used by implementors of Providers and Resolvers to coerce data from the data type of the source to the data type of the Column. It is used by QueryDataSet, ProcedureDataSet, QueryProvider and ProcedureProvider components.
    DataSetView
    Presents alternate views and navigation of the data in the DataSet, without the need for multiple objects that each store data. Can display a different sort order and filtering than the source StorageDataSet.

    Descriptor classes

    SortDescriptor
    Describes the order of presentation for rows of data that are visible to a DataSet. The DataSet can automatically reposition a new or updated row within the cursor, based on the ordering of data in specified columns.
    AggDescriptor
    Used to specify the grouping, target field to aggregate on, and the aggregation operation for a column with a calcType of AGGREGATE.
    MasterLinkDescriptor
    Stores properties that establish a master-detail relationship between two DataSets. You can link different DataSets together, such as a QueryDataSet and a TableDataSet, if there is common data to base the link relationship on.
    PickListDescriptor
    Used as a property setting for columns, to describe a picklist relationship between a column in one DataSet and separate picklist DataSet. When a row is selected, the values of the picklist columns in the picklist DataSet are copied into the destination columns.

    Event, listener, and adapter classes

    CalcFieldsListener
    Used for performing calculations on row values.
    CalcAggFieldsListener
    Used for performing calculations on aggregated values.
    CalcAggFieldsAdapter
    Used for performing calculations on aggregated values.

    ColumnChangeListener
    For events related to editing column values.
    ColumnChangeAdapter
    For events related to editing column values.

    ColumnPaintAdapter
    For events related to the painting of a value in a Column at a specific row location.
    ColumnPaintListener
    The listener interface for events related to the painting of a value in a Column at a specific row location.

    EditListener
    Listens for events that are generated when a DataSet is edited, both before and after editing.
    EditAdapter
    An adapter class for EditListener.

    ExceptionEvent
    Used to override the DataSet error handling for data-aware controls.
    ExceptionListener
    A listener interface for ExceptionEvent.

    LoadEvent
    Indicates completion of a load operation on a StorageDataSet. Occurs when a query or procedure is executed, and when a StorageDataSet is loaded from an import operation. Of interest for queries, or procedures, that are executed with asynchronous fetching.
    LoadListener
    Listens for completion of a load operation on a StorageDataSet.

    NavigationEvent
    A notification that the DataSet's cursor position has changed.
    NavigationListener
    A listener interface for NavigationEvent.

    OpenListener
    Notification that a DataSet is opening, has opened, is closing, or has closed.
    OpenAdapter
    An adapter class for OpenListener.

    ResolverListener
    Used to process insert-, delete-, and update-related events that occur during dataset resolution.
    ResolverAdapter
    An adapter class for ResolverListener.

    ResponseEvent
    Used to collect a response from the user.
    ResponseListener
    Listener class for ResponseEvent.
    ResponseAdapter
    An adapter class for ResponseListener.

    RowFilterListener
    Used to filter out rows for a DataSet's view. To prevent rows from appearing in the storage of a DataSet, listen for an EditListener.adding() event.

    StatusEvent
    Used to inform listeners when specified types of status messages occur.
    StatusListener
    A listener interface for StatusEvent.

    Events for component writers

    AccessEvent
    Internal event generated when a DataSet is opened, closed, or restructured.
    AccessListener
    Useful notifications for component writers. Not for general usage.

    DataChangeEvent
    The event object dispatched when data changes. Event types indicate the type of update.
    DataChangeListener
    Listener interface for the DataChangeEvent.
    DataChangeAdapter
    Adapter class for DataChangeListener.

    Exception classes

    DataSetException
    A base Exception class used often throughout the dataset package.
    ValidationException
    Used often throughout the dataset package for column- and row-level validation errors that occur when posting changed rows or new rows of data. Extends DataSetException.
    VariantException
    An exception thrown when Variant runs into a problem.

    Import/export classes

    DataFile
    This base class collects the behavior of all file-based data sources: importing data from a file and exporting data to a file. Extend this class for new classes defining a custom file format that you want to import data from, or export data to. Extended by TextDataFile.
    TextDataFile
    Used when importing data stored in a text format into a TableDataSet component, or when exporting the data stored in any StorageDataSet to a text file.
    DataFileFormat
    Contains localization variables to store whether data is stored as 8-bit ASCII characters, and whether conversations from locale-specific Unicode to multibyte character sets need to take place when reading and writing data. Often used by TextDataFile.

    Provider and resolver classes

    DataSetData
    Provides the capability of using Java serialization to serialize the data in a DataSet.
    MetaDataUpdate
    Used to cusomize metadata discovery.
    Provider
    Abstract class that defines provider basics.
    ProviderHelp
    Collection of methods that are helpful to the providing or resolving phases.
    Resolver
    The resolver property setting for DataSets.
    ResolverResponse
    Used for collecting a response from another component.
    UpdateMode
    Used to specify the level of optimistic concurrency for row update operations.

    Row-related classes

    DataRow
    Stores a single row of values across the columns of a DataSet. Useful for adding, updating and locating rows in a DataSet. Supports running a locate operation against specified columns, and handles columns of any data type in a DataSet.
    ParameterRow
    Useful for setting and getting Query and StoredProcedure parameter values. Allows a column to be included more than once in a data row. Useful for query parameters, to specify the same column multiple times, such as for multiple range comparisons.
    ParameterType
    Constants used by Column objects in ParameterRows.
    ReadRow
    Provides read-only row operations.
    ReadWriteRow
    Provides read and write row operations.
    RowFilterResponse
    Used for row filtering.
    RowStatus
    Stores status settings used by DataSet components, such as whether the row is inserted, updated or deleted.

    Miscellaneous dataset classes

    CustomPaintSite
    Provides custom item painters and painters with information about the host container in which the painting occurs.
    CalcType
    Defines the types of calculations that a column may use: calculated values, aggregate values, lookups or no calculations.
    ColumnAware
    An interface that allows a component to declare to JDataStore that it knows how to bind to a specific column in a specific DataSet.
    DataModule
    An interface that you implement when creating a custom data module (data model). The data model is a container for non-visual components such as the Dataset and Database components, and contains business logic that controls how data is manipulated before and after the user or client sees the data.
    DataSetAware
    Permits a component to declare to JDataStore that it knows how to bind to a com.borland DataSet.
    LoadCancel
    Can be used to cancel a load operation. Especially useful for asynchronous queries. Can also be used to cancel a TextDataFile load operation.
    Locate
    Encapsulates commonly-used search options, such as search for the first, subsequent or last occurrence; case sensitivity; and closest match.
    Variant
    A type storage class used for the dataset package.