Package org.eclipse.birt.data.engine.api

This package contains the main public API classes and interfaces of the BIRT Data Engine (DtE).

See:
          Description

Interface Summary
IBaseDataSetDesign Describes the static design of any data set to be used by the Data Engine.
IBaseDataSourceDesign Describes the static design of any data source (connection) to be used by the Data Engine.
IBaseExpression Base type to represent a generic data expression used in a report design.
IBasePreparedQuery General Interface of prepared query.
IBaseQueryDefinition /** Represents attributes common to a data engine query and a subquery.
IBaseQueryResults The new IBaseQueryResults is an interface which will be extends by IQueryResults and ICubeQueryResults interfaces.
IBaseTransform Base class to define set of transforms that are common to queries, and groups within queries.
IBinding  
IColumnDefinition Describes a column that appears in the data row of a data set.
IComputedColumn Describes a computed column defined for a data set, or a report query.
IConditionalExpression Describes a conditional expression that produces a Boolean type result.
IDataEngineFactory Factory class to create an instance of DataEngine
IDataQueryDefinition General interface for Query definition.
IExpressionCollection Describes an Array Collection of IBaseExpression, it will return an result Array.
IFilterDefinition Describes a data row filter defined in a data set or a report query.
IGroupDefinition Provides information about a grouping level within a query or subquery.
IGroupInstanceInfo This class provides information that can identify a unique group instance of a ResultSet.
IInputParameterBinding Describes on input parameter binding, which associates one input parameter (identified by either parameter name or position) to a JavaScript expression
IJoinCondition This interface describes a specified conditional expression which returns a Boolean value, and used for Joint Data Set only.
IJointDataSetDesign This interface describes the static design of a Joint Data Set.
INamedObject  
IOdaDataSetDesign Describes the static design of a generic ODA (Open Data AccesS) Data Set.
IOdaDataSourceDesign Describes the static design of an ODA (Open Data Access) Data Source.
IParameterDefinition Describes the metadata of a data set parameter.
IParameterMetaData Describes the metadata of a parameter in an IPreparedQuery.
IPreparedQuery A prepared data engine query ready for execution.
IQueryDefinition Defines a data engine query: a set of data transforms that provides data for a list-like element in the report.
IQueryExecutionHints This class provides hints info for a Data Engine Query to execution.
IQueryResults A handle used to retrieve a data engine query's results.
IResultIterator An iterator on a result set from a prepared and executed query.
IResultMetaData Describes the metadata of a detail row in an IResultIterator.
IScriptDataSetDesign Describes the static design of a scripted Data Set.
IScriptDataSourceDesign Describes the static design of a scripted Data Source.
IScriptExpression Describes a Javascript expression used in the report design.
IShutdownListener  
ISortDefinition Describes one sort (key, direction) pair in a sort sequence.
ISubqueryDefinition Provides definition of subquery: a supplemental use of rows returned by a data set or a group.
 

Class Summary
DataEngine Data Engine API class.
DataEngineContext Define in which context Data Engine is running.
 

Package org.eclipse.birt.data.engine.api Description

This package contains the main public API classes and interfaces of the BIRT Data Engine (DtE).

The Data Engine provides data access and transform services for the BIRT reporting platform. It handles connection to data sources, executes data set queries, provides metadata for data sets, retrieves data set query results, and performs additional data transforms such as grouping, filtering, sorting and aggregation.

A Data Engine client typically requests Data Engine services in these steps:

  1. Obtains an instance of DataEngine class by calling DataEngine.newDataEngine(). A single instances of DataEngine is typically used throughout an application.
  2. Defines data sources and data sets available to the data engine by calling DataEngine.defineDataSet() and DataEngine.defineDataSource(). A data set or data source need only be defined once. This is typically done before any data engine query is executed.
  3. Defines a data engine query by creating and populating an instance of IQueryDefinition. Calls DataEngine.prepare() to prepare the query and obtain an instance of IPreparedQuery
  4. Calls IPreparedQuery.execute() to execute the query and obtain an IQueryResults instance, from which an IResultIterator can be obtained. Calls methods on IResultIterator to iterate through data rows in the query result set and to evaluate expressions.

All request classes that define data set, data source, query and related objects are defined as interfaces in this package. A Data Engine client may choose to implement these interfaces, or it can use the default implementation of these interfaces in the org.eclipse.birt.data.engine.api.querydefn package.

See Also:
org.eclipse.birt.data.engine.api.querydefn


Copyright © 2008 Actuate Corp. All rights reserved.