All Packages  Class Hierarchy  Index

Package borland.jbcl.dataset

About the dataset package

Interfaces

  • AccessListener
  • CalcAggFieldsListener
  • CalcFieldsListener
  • ColumnChangeListener
  • ConnectionUpdateListener
  • DataChangeListener
  • DataFile
  • DataModule
  • DefaultResolver
  • EditListener
  • ExceptionListener
  • LoadCancel
  • LoadListener
  • MasterNavigateListener
  • MasterUpdateListener
  • MetaDataUpdate
  • NavigationListener
  • OpenListener
  • Resolver
  • ResolverListener
  • RowFilterListener
  • SQLExtensions
  • SQLResolver
  • StatusListener
  • Store
  • Task
  • TransactionSupport
  • Classes and components

  • AccessEvent
  • AggDescriptor
  • AggManager
  • AggOperator
  • BoundsAggOperator
  • CalcAggFieldsAdapter
  • CalcType
  • Column
  • ColumnBeanInfo
  • ColumnChangeAdapter
  • ColumnVariant
  • ConnectionDescriptor
  • ConnectionUpdateAdapter
  • ConnectionUpdateEvent
  • CountAggOperator
  • CustomAggOperator
  • d
  • Database
  • DatabaseBeanInfo
  • DataChangeAdapter
  • DataChangeEvent
  • DataFileFormat
  • DataRow
  • DataSet
  • DataSetException
  • DataSetView
  • DataSetViewBeanInfo
  • DesignerConnectionCache
  • DirectIndex
  • EditAdapter
  • ExceptionEvent
  • HelpDataSet
  • Index
  • InternalRow
  • LoadEvent
  • Locate
  • LookupDescriptor
  • MasterLinkDescriptor
  • MasterNavigateEvent
  • MasterUpdateEvent
  • MatrixData
  • MatrixDataSetManager
  • MaxAggOperator
  • MemoryStore
  • MinAggOperator
  • NavigationEvent
  • OpenAdapter
  • ParameterRow
  • PickListDescriptor
  • ProcedureDataSet
  • ProcedureDataSetBeanInfo
  • ProcedureDescriptor
  • Query
  • QueryAnalyzer
  • QueryDataSet
  • QueryDataSetBeanInfo
  • QueryDescriptor
  • QueryResolver
  • QueryResolverBeanInfo
  • ReadRow
  • ReadWriteRow
  • ResolutionException
  • ResolverAdapter
  • ResolverResponse
  • ResTable
  • RowFilterResponse
  • RowStatus
  • RowVariant
  • SingletonDataSetManager
  • SortDescriptor
  • SQLDialect
  • SQLResolutionManager
  • StatusEvent
  • StorageDataSet
  • SumAggOperator
  • TableDataSet
  • TableDataSetBeanInfo
  • TextDataFile
  • TextDataFileBeanInfo
  • UpdateMode
  • ValidationException
  • VectorDataSetManager

  • About the dataset package

    The dataset package contains classes and interfaces that provide data connectivity. This package defines Database components as well as an abstract DataSet class that is extended to other DataSet objects. These classes provide access to information stored in remote databases as well as other data sources.

    Functionality covers the three main phases of data handling:
    Providing Login to remote data servers, and generation of local DataSets through queries and stored procedures.
    Manipulation    Navigation and editing of the data locally.
    Resolving Updating of data from the local DataSet back to the original source of the data.

    See also:


    Overview of classes in the dataset package

    DataSet types

    Database - Encapsulates a database connection through JDBC to a SQL server and provides lightweight transaction support using local caching. Required for accessing data on a SQL server.
    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 synchronized to the same DataSet. Supports master-detail relationships.

    StorageDataSet - Implements DataSet, to store data. 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. 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 JBCL component is storing the data.
    ProcedureDataSet - Extends StorageDataSet, to run a stored procedure against a SQL database. Supports executing stored procedures via a SQL query.
    QueryDataSet - Extends StorageDataSet, to run a query statement against a table in a SQL database. Requires a Database component and a QueryDescriptor. The query result set is stored in this component, allowing flexible navigation of the results.
    TableDataSet - Extends StorageDataSet. A simple DataSet with optional formal provider, but no formal resolver of its data. Used to create a StorageDataSet from sources other than SQL databases. Mimics a single-user SQL server, with no database connection.

    DataFile - This interface collects the basic behavior of all file-based data sources: importing data from a file and exporting data to a file. Implement this interface for new classes defining a custom file format that you want to import data from, or export data to. Implemented 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.

    DataModule - An interface that you implement when creating a custom data module, or model. The model stores data for data-aware components, and stores business logic to control how data is manipulated before and after the user or client sees the data.

    Row-related

    DataRow - Represents a single row of values across the columns of a DataSet. Useful for comparing values it contains against those in a DataSet. Supports running a locate operation against specified columns, and handles columns of any data type.
    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.
    ReadRow - Provides read-only row operations.
    ReadWriteRow - Provides read and write row operations.
    RowFilterResponse - Used for row filtering.
    RowStatus - Stores status settings used by DataSets, such as whether the row is visible or hidden (filtered). Tracks the edit state of the row, such as Deleted, to enable resolving data back to the source.

    Column-related

    Column - Used to access column data in a DataSet. Can derive its values as a result of a calculated expression, using a formula defined in the StorageDataSet; the formula can use values from other columns to generate a value for each row of the calculated column. Stores column properties such as persistence, max and min values, alignment, and data type.
    ColumnVariant - Extends variant. Used in the context of data-aware controls. Provides the associated column and DataSet from which this value came.

    DataSet managers

    SingletonDataSetManager - A data-aware adapter to connect a DataSet to model-view components that use a single data item.
    VectorDataSetManager - A data-aware adapter to connect a DataSet to model-view components that use a list of data items.
    MatrixDataSetManager - A data-aware adapter to connect a DataSet to model-view components that use a table of data items.

    Events, listeners, and adapters

    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.

    ConnectionUpdateEvent - Used when a database connection is about to close, or is closed. Also used when the transaction isolationLevel has changed.
    ConnectionUpdateListener - A listener interface for ConnectionUpdateEvent.
    ConnectionUpdateAdapter - An adapter class for ConnectionUpdateListener.

    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.

    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. Useful for component writers. Not for general usage.
    AccessListener - Useful notifications for component writers. Not for general usage.

    DataChangeEvent - The object that is passed to DataSets and to listeners of DataSets when data changes. Event types indicate the type of update. Useful for component writers. Not for general usage.
    DataChangeListener - Useful notifications for component writers. Not for general usage.
    DataChangeAdapter - Adapter class for DataChangeListener.

    Descriptors

    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.
    ConnectionDescriptor - Stores properties related to connecting to a SQL database, such as the connection URL, user name, and password. Required for accessing data on a SQL server. Can be configured via the UI Designer, to show connection history, test the connection, and register drivers with JDBC.
    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.
    ProcedureDescriptor - Stores properties of a stored procedure (ProcedureDataSet) against a SQL database.
    QueryDescriptor - Stores properties that set a query statement to run against a SQL database. Required for accessing SQL table data. Easy to use via the UI Designer.

    Aggregate operators

    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.

    Exceptions

    DataSetException - A base class used often throughout the dataset package.
    ResolutionException - Used whenever there is an error during resolution of a DataSet. Extends DataSetException.
    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.

    Resolvers

    Resolver - The resolver property setting for DataSets.
    DefaultResolver - An interface to provide a resolver.
    QueryResolver - Can be used to customize DataSet-resolving events and properties.
    SQLResolver - Specific to DataSets that resolve against a Database component.

    ResolverResponse - Used for collecting a response from another component.
    SQLResolutionManager - Manages the resolution of one or more DataSets to a Database component.

    Miscellaneous dataset classes

    CalcType - Defines the types of calculations that a column may use: calculated values, aggregate values, or no calculations.
    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.
    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.
    MetaDataUpdate - Used by QueryDataSet and ProcedureDataSet.
    SQLDialect - Not currently used.
    SQLExtensions - JDBC drivers can implement this interface on their implementation of java.sql.ResultSet. Looks for extensions of java.sql.ResultSet. Contains the extension() method. New requests are added by adding a new functionCode/extraInfo pair, to avoid interface versioning issues.
    Store - Used to specify the storage for DataSet data.
    TransactionSupport - Used internally by ResolutionManager.
    UpdateMode - A QueryResolver property used to specify the level of optimistic concurrency for row update operations.

    Library overview