A B C D E F G H I J K L M N O P Q R S U V W Y

A

Accumulator - Class in org.eclipse.birt.data.engine.api.aggregation
The Accumulator class calculates values for its associated Aggregation.
Accumulator() - Constructor for class org.eclipse.birt.data.engine.api.aggregation.Accumulator
 
addAggregateOn(String) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
addAggregateOn(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
addArgument(IBaseExpression) - Method in interface org.eclipse.birt.data.engine.api.IBinding
Deprecated.  
addArgument(String, IBaseExpression) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
addArgument(IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
addArgument(String, IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
addBinding(IBinding) - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Add a column binding instance to query definition.
addBinding(IBinding) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
addColumn(String, Class) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSetMetaDataDefinition
Adds a column to the metadata definition.
addComputedColumn(IComputedColumn) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Adds a new computed column to the data set.
addFilter(IFilterDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Adds a filter to the filter list.
addFilter(IFilterDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Add one filter to the filter list
addGroup(GroupDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Appends a group definition to the group list.
addInputParamBinding(IInputParameterBinding) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Adds an input parameter binding.
addInputParamBinding(InputParameterBinding) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Adds an input parameter binding to this report query.
addJoinCondition(JoinCondition) - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
addParameter(IParameterDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Adds a parameter definition to the data set.
addPrivateProperty(String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Adds a private connection property, in the form of a (Name, value) string pair.
addPrivateProperty(String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Adds a private connection property, in the form of a (Name, value) string pair.
addProperty(Map, String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Add given value to the set of values for named property in the given properties map.
addProperty(Map, String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Adds given value to the named property in the given properties map.
addPublicProperty(String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Adds a public connection property, in the form of a (Name, value) string pair.
addPublicProperty(String, String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Adds a public connection property, in the form of a (Name, value) string pair.
addResultSetExpression(String, IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Deprecated.  
addResultSetHint(IColumnDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Adds a column to the result set hints definition.
addShutdownListener(IShutdownListener) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Add a shut down listener.
addSort(SortDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Appends one sort definition to the list of sort criteria
addSubquery(SubqueryDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Add a subquery to the list
addTargetGroupInstance(IGroupInstanceInfo) - Method in interface org.eclipse.birt.data.engine.api.IQueryExecutionHints
Add a target group instance.
addTargetGroupInstance(IGroupInstanceInfo) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryExecutionHints
 
AFTER_LAST_ROW - Static variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
The expression is evaluated after the last row in the series.
afterExpressions - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
AGGR_MEASURE - Static variable in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
 
AGGR_TABULAR - Static variable in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
 
AGGR_XTAB - Static variable in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
 
Aggregation - Class in org.eclipse.birt.data.engine.api.aggregation
Deprecated. use AggrFunction instead
Aggregation() - Constructor for class org.eclipse.birt.data.engine.api.aggregation.Aggregation
Deprecated.  
AggregationManager - Class in org.eclipse.birt.data.engine.api.aggregation
 
aggrMap - Static variable in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
 
ALWAYS_EXPORT - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
ALWAYS_SEARCHABLE - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
applyOnGroup() - Method in interface org.eclipse.birt.data.engine.api.ISubqueryDefinition
Subquery can apply to the group in which the sub query is added, or to the each row of current query definition.
applyOnGroup() - Method in class org.eclipse.birt.data.engine.api.querydefn.SubqueryDefinition
 
ASCII_SORT_STRENGTH - Static variable in interface org.eclipse.birt.data.engine.api.ISortDefinition
When the sort strength is set to -1, it indicate we do an ASCII sort rather than Collator sort.

B

BaseDataSetDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IBaseDataSetDesign interface.
BaseDataSetDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Instantiates a data set with given name.
BaseDataSetDesign(String, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Instantiates a data set with given name and data source name.
BaseDataSourceDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IBaseDataSourceDesign interface.
BaseDataSourceDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Constructor: Creates a data source with specified name
BaseExpression - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IBaseExpression interface.
BaseExpression() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
Constructs an instance with unknown data type
BaseExpression(int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
Constructs an instance with specified data type
BaseQueryDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IBaseQueryDefinition interface.
BaseTransform - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IBaseTransform interface.
BaseTransform() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
BEFORE_FIRST_ROW - Static variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
The expression is evaluated before the first row in the series.
beforeExpressions - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
Binding - Class in org.eclipse.birt.data.engine.api.querydefn
 
Binding(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.Binding
 
Binding(String, IBaseExpression) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.Binding
 
bindings - Variable in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 

C

CACHE_MODE_IN_DISK - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
CACHE_MODE_IN_MEMORY - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
CACHE_USE_ALWAYS - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
Always use cached data if available, disregard data set cache setting and AppContext.
CACHE_USE_DEFAULT - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
AppContext and Data Set cache count setting decide whether cache is used, which is default value for data engine context.
CACHE_USE_DISABLE - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
Do not use cache, regardless of data set cache setting
cacheQueryResults() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Indicates if the query need cache the result rows .
cacheQueryResults() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
cancel() - Method in interface org.eclipse.birt.data.engine.api.IQueryResults
Cancel the current operation.
clearCache(IBaseDataSourceDesign, IBaseDataSetDesign) - Method in class org.eclipse.birt.data.engine.api.DataEngine
If user wants to use the latest data from data set rather than local cache, user needs to call this clearCache method to delete the cache content from update local environment.
close() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryResults
Closes all query result set(s) associated with this object; provides a hint to the query that it can safely release all associated resources.
close() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Closes this result and any associated secondary result iterator(s), providing a hint that the consumer is done with this result, whose resources can be safely released as appropriate.
closeDataSource(String) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Provides a hint to DtE that the consumer is done with the given data source, and that its resources can be safely released as appropriate.
ColumnDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IColumnDefinition interface.
ColumnDefinition(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Construct a Column definition for a named column
ComputedColumn - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IComputedColumn interface.
ComputedColumn(String, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
ComputedColumn(String, String, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
Constructs a new computed column with specified name and expression
ComputedColumn(String, String, int, String, IScriptExpression, List) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
ConditionalExpression - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IConditionalExpression interface.
ConditionalExpression(String, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Constructs an instance, setting main expression and the operator (which takes no operands)
ConditionalExpression(String, int, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Constructs an instance, setting main expression, a unary operator, and its operand
ConditionalExpression(String, int, String, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Constructs an instance, setting main expression, a binary operator, and its two operands
ConditionalExpression(IScriptExpression, int, IBaseExpression, IBaseExpression) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Constructs an instance, setting main expression, operator, and operands
ConditionalExpression(String, int, List) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Constructs an instance, setting main expression, a unary operator, and its Collection operand
createDataEngine(DataEngineContext) - Method in interface org.eclipse.birt.data.engine.api.IDataEngineFactory
create a new report engine object.
CUBECURSOR_FETCH_LIMIT_ON_COLUMN_EDGE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
The fetch size on column and row edge in cube cursor.
CUBECURSOR_FETCH_LIMIT_ON_LEVEL - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
Deprecated. use DataEngine.CUBECURSOR_FETCH_LIMIT_ON_COLUMN_EDGE and DataEngine.CUBECUSROR_FETCH_LIMIT_ON_ROW_EDGE instead
CUBECUSROR_FETCH_LIMIT_ON_ROW_EDGE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
 

D

DATA_SET_CACHE_DELTA_FILE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
 
DATA_SET_CACHE_ROW_LIMIT - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
Indicates whether data set cache function need to be used: Negative integer: Enable data set cache.
DataEngine - Class in org.eclipse.birt.data.engine.api
Data Engine API class.
DataEngine() - Constructor for class org.eclipse.birt.data.engine.api.DataEngine
 
DataEngineContext - Class in org.eclipse.birt.data.engine.api
Define in which context Data Engine is running.
dataEngineShutdown() - Method in interface org.eclipse.birt.data.engine.api.IShutdownListener
 
DATASET_CACHE_OPTION - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
Deprecated.  
DATASET_DATA_LEN_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
DATASET_DATA_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
DATASET_META_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
dataSetName - Variable in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
dataType - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
dataType - Variable in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
DAY_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Day.
DEFAULT_SORT_STRENGTH - Static variable in interface org.eclipse.birt.data.engine.api.ISortDefinition
 
defineDataSet(IBaseDataSetDesign) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Provides the definition of a data set to Data Engine.
defineDataSource(IBaseDataSourceDesign) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Provides the definition of a data source to Data Engine.
destroyInstance() - Static method in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
Destroy shared instance of AggregationManager.
DIRECT_PRESENTATION - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
direction - Variable in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
distinctValue - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
DONOT_EXPORT - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
doSortBeforeGrouping() - Method in interface org.eclipse.birt.data.engine.api.IQueryExecutionHints
Indicate whether should we do sort before grouping.
doSortBeforeGrouping() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryExecutionHints
 
dropStream(String, String, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
dropStream(String) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
Directly drop stream

E

equals(Object) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
execute(Scriptable) - Method in interface org.eclipse.birt.data.engine.api.IPreparedQuery
Executes the prepared execution plan.
execute(IQueryResults, Scriptable) - Method in interface org.eclipse.birt.data.engine.api.IPreparedQuery
Executes the prepared execution plan as an inner query that appears within the scope of another query.
execute(IBaseQueryResults, Scriptable) - Method in interface org.eclipse.birt.data.engine.api.IPreparedQuery
Executes the prepared execution plan as an inner query that appears within the scope of another query.
EXPORT_IF_REALIZED - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
exportable() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
exportable() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
expr - Variable in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
expr - Variable in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
expr - Variable in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
 
EXPR_META_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
EXPR_ROWLEN_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
EXPR_VALUE_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
ExpressionCollection - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IExpressionCollection interface.
ExpressionCollection(List) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ExpressionCollection
 
ExpressionCollection(IBaseExpression[]) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ExpressionCollection
 
exprText - Variable in class org.eclipse.birt.data.engine.api.querydefn.ScriptExpression
 
EXTENSION_DATA_ENGINE_FACTORY - Static variable in interface org.eclipse.birt.data.engine.api.IDataEngineFactory
the extension point used to create the factory object.

F

FilterDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IFilterDefinition interface.
FilterDefinition(IBaseExpression) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.FilterDefinition
Constructs a new filter using the specified expression.
filters - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
findGroup(Object[]) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Move the current position of the iterator to the first element of the group with matching group key values.
finish() - Method in class org.eclipse.birt.data.engine.api.aggregation.Accumulator
This method is called after the last onRow() call.
FULL_OUTER_JOIN - Static variable in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
The integer value stands for a full outer join operator.

G

getAfterCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the afterClose script to be called just after the data set is closed.
getAfterCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the afterClose script of the data source.
getAfterCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getAfterCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Gets the afterClose script of the data source
getAfterOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the afterOpen script to be called just after the data set is opened, but before fetching each row.
getAfterOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the afterOpen script of the data source.
getAfterOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getAfterOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Gets the afterOpen script of the data source
getAggregateArgument() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
 
getAggregateArgument() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getAggregateFilter() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
Return the filter of this computed column iff it is an aggregation.
getAggregateFilter() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getAggregateFunction() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
Return the aggregation function.
getAggregateFunction() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getAggregation(String) - Method in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
 
getAggregation(String) - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregationFactory
get an IAggrFunction instance whos's name is name.
getAggregations(int) - Method in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
get a list of IAggrFunction instances for the specified type, which must be one of the values below: AggregationManager.AGGR_TABULAR,AggregationManager.AGGR_XTAB,AggregationManager.AGGR_MEASURE.
getAggregations() - Method in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
get a list of IAggrFunction instances which contains all the aggregations function.
getAggregations() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregationFactory
returns a list of IAggrFunction instances that current factory produces.
getAggregatOns() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getAggregatOns() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getAggrFunction() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getAggrFunction() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getAlias() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the alias of the column.
getAlias() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the alias of the column.
getAllExtensionProperties() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the data set extension properties, in the form of a ( name [String], value [String] ) map.
getAllExtensionProperties() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSourceInstanceHandle
Gets all public extension property, in the form of a (name, value) pair.
getArguments() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getArguments() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getBeforeCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the beforeClose script to be called just before closing the data set.
getBeforeCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the beforeClose script to be called just before closing the data source (connection).
getBeforeCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getBeforeCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Gets the beforeClose script of the data source
getBeforeOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the beforeOpen script to be called just before opening the data set.
getBeforeOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the beforeOpen script to be called just before opening the data source (connection).
getBeforeOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getBeforeOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Gets the beforeOpen Script of the data source
getBigDecimal(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the BigDecimal data type.
getBindingName() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getBindingName() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getBindings() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Get all column binding instance from query definition.
getBindings() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getBlob(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the Blob data type.
getBoolean(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the Boolean data type.
getBytes(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the byte[] data type.
getCacheCount() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getCachedDataSetMetaData(IBaseDataSourceDesign, IBaseDataSetDesign) - Method in class org.eclipse.birt.data.engine.api.DataEngine
This method will return NULL if the named data set is not cached.
getCacheOption() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getCacheRowCount() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Deprecated.  
getCacheRowCount() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Deprecated.  
getClassLoader() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSetDesign
Gets the Close script for closing the data set.
getCloseScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSourceDesign
Gets the close script for closing the data source.
getCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
 
getCloseScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSourceDesign
 
getColumn() - Method in interface org.eclipse.birt.data.engine.api.ISortDefinition
Returns the name of the column to sort on.
getColumn() - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
Returns the name of the column to sort on.
getColumnAlias(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the column alias at the specified index.
getColumnCount() - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the number of columns in a detail row of the result set.
getColumnLabel(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Gets the label or display name of the column at the specified index.
getColumnName() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the column name.
getColumnName(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the column name at the specified index.
getColumnName() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the column name
getColumnNativeTypeName(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the data provider specific data type name of the specified column.
getColumnPosition() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the column position.
getColumnPosition() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the column position
getColumnProjection() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
Provides a column projection hint to the data engine.
getColumnProjection() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
getColumnType(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the data type of the column at the specified index.
getColumnTypeName(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Returns the Data Engine data type name of the column at the specified index.
getColumnValue(int) - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Gets the column data by index.
getColumnValue(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Gets the column data by column name.
getComputedColumns() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns a list of computed columns.
getComputedColumns() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getDataSet() - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Gets the data set runtime instance which contains this row
getDataSetName() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
Gets the name of the data set used by this query
getDataSetName() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Gets the name of the data set used by this query
getDataSource() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
 
getDataSourceName() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the data source (connection) name for this data set.
getDataSourceName() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getDataType() - Method in class org.eclipse.birt.data.engine.api.aggregation.Aggregation
Deprecated.  
getDataType() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated. get the aggregation data type.
getDataType() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
get the aggregation data type.
getDataType() - Method in interface org.eclipse.birt.data.engine.api.IBaseExpression
Gets the data type of the expression.
getDataType() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getDataType() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the data type of the column.
getDataType() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
Gets the data type of the computed column.
getDataType() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the data type of this parameter.
getDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
getDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the data type of the column.
getDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
getDataTypeName() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the data type name of this parameter.
getDate(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the Date data type.
getDefaultInputValue() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the default input value of this parameter.
getDefaultInputValue() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the default value of this input parameter.
getDefaultInputValue() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getDefaultValue() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Returns the default aggregation result if the data series that the accumulator of this aggregation function requires is empty.
getDescribeScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSetDesign
Gets the Describe script for describing the data set's result columns metadata.
getDescribeScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
 
getDescription() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Gets the functional description of this aggregation function.
getDescription() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
get the description of this parameter.
getDisplayName() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Gets the display name that identifies the aggregation function in the report designer user interface.
getDisplayName() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
get the display name of this parameter.
getDisplayName() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getDisplayName() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getDistinctValue() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
If the flag is true this query will return the rows with distinct or unique column values.
getDistinctValue() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getDocReader() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getDocWriter() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getDouble(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the Double data type.
getEndingGroupLevel() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the 1-based index of the outermost group in which the current row is the last row.
getEventHandler() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the event handler for the data set
getEventHandler() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the event handler for the data source
getEventHandler() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getEventHandler() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
 
getExportHint() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the export hint for the column
getExportHint() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the export hint for the column
getExpr() - Method in interface org.eclipse.birt.data.engine.api.IInputParameterBinding
Returns the expression that provides the value of the parameter.
getExpr() - Method in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
Returns the expression that provides the value of the parameter.
getExpression() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getExpression() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
Gets the expression of the computed column
getExpression() - Method in interface org.eclipse.birt.data.engine.api.IConditionalExpression
Gets the main expression
getExpression() - Method in interface org.eclipse.birt.data.engine.api.IFilterDefinition
Gets the Boolean expression used to define this filter.
getExpression() - Method in interface org.eclipse.birt.data.engine.api.ISortDefinition
Returns the JavaScript expression that defines the group key.
getExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
getExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.FilterDefinition
 
getExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
Returns the JavaScript expression that defines the group key.
getExpressions() - Method in interface org.eclipse.birt.data.engine.api.IExpressionCollection
Gets the expression collection.
getExpressions() - Method in class org.eclipse.birt.data.engine.api.querydefn.ExpressionCollection
 
getExtensionID() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Gets the unique id that identifies the type of the data set, assigned by the extension providing the implementation of this data set.
getExtensionID() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSourceDesign
Gets the unique id of this data source type, assigned by the extension providing the implementation of this ODA data source.
getExtensionID() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getExtensionID() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Gets the data source extension id as defined by ODA driver This property is required in a data source design.
getExtensionID() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the unique id that identifies the type of the data set, assigned by the extension providing the implementation of this data set.
getExtensionID() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSourceInstanceHandle
Gets the ID of the ODA extension which defines this type of data source
getExtensionProperty(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Get the value of a data set extension property.
getExtensionProperty(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSourceInstanceHandle
Get the extension property value
getFetchScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSetDesign
Gets the Fetch script that creates, populates and returns an object of type DataRow.
getFetchScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
 
getFilter() - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
getFilter() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
getFilters() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns a list of filters.
getFilters() - Method in interface org.eclipse.birt.data.engine.api.IBaseTransform
Returns the filters defined in this transform, as an ordered list of IFilterDefinition objects.
getFilters() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getFilters() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Returns the filters defined in this transform, as an ordered list of IFilterDefintion objects.
getGroupLevel() - Method in interface org.eclipse.birt.data.engine.api.IGroupInstanceInfo
Return the group level of target group instance.
getGroupLevel() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupInstanceInfo
 
getGroupName() - Method in interface org.eclipse.birt.data.engine.api.IBaseExpression
Deprecated.  
getGroupName() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
getGroups() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Returns the group definitions as an ordered collection of IGroupDefinition objects.
getGroups() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Returns the group definitions as an ordered collection of GroupDefinition objects.
getHandle() - Method in interface org.eclipse.birt.data.engine.api.IBaseExpression
Returns the handle associated with the expression.
getHandle() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
getID() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryResults
Every query results has a unique id.
getID() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
getInputParamBindings() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the set of input parameter bindings as an unordered collection of IInputParameterBinding objects.
getInputParamBindings() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
Returns the set of input parameter bindings as an unordered collection of IInputParameterBinding objects.
getInputParamBindings() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getInputParamBindings() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Returns the set of input parameter bindings as an unordered collection of InputParameterBinding objects.
getInputParameters() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the names and values of all data set input parameters, as a read-only Name (String) -> Value (Object) map.
getInputParameterValue(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the current value of the named data set input parameter.
getInputStream(String, String, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
According to the paramters of streamID, subStreamID and streamType, an input stream will be created for it.
getInstance() - Static method in class org.eclipse.birt.data.engine.api.aggregation.AggregationManager
Return a shared instance of AggregationManager.
getInteger(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the Integer data type.
getInterval() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the interval for grouping on a range of contiguous group key values.
getInterval() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the interval for grouping on a range of contiguous group key values.
getIntervalRange() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the number of contiguous group intervals that form one single group, when Interval is used to define group break level.
getIntervalRange() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the number of contiguous group intervals that form one single group, when Interval is used to define group break level.
getIntervalStart() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns a start value for grouping by range.
getIntervalStart() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Gets the starting value for the first interval
getJavaScriptScope() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getJoinConditions() - Method in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
This method returns the Joint conditions.
getJoinConditions() - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
getJoinType() - Method in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
This method returns the Joint Type.
getJoinType() - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
getKeyColumn() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the name of the column that defines the group key.
getKeyColumn() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the name of the column that defines the group key.
getKeyExpression() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the JavaScript expression that defines the group key.
getKeyExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the JavaScript expression that defines the group key.
getLeftDataSetDesignName() - Method in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
This method returns the name of data set which servers as left operand of a joint.
getLeftDataSetDesignName() - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
getLeftExpression() - Method in interface org.eclipse.birt.data.engine.api.IJoinCondition
This method returns the IScriptExpression instance which will be evaluated against the data set which servers as left operand of a joint.
getLeftExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.JoinCondition
 
getLocale() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getMaxRows() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Gets the maximum number of detail rows that can be retrieved by this query
getMaxRows() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Gets the maximum number of detail rows that can be retrieved by this report query
getMode() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getName() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated. Gets the name that identifies the aggregate function represented by this class.
getName() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Gets the name that identifies the aggregate function represented by this class.
getName() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
get the native name of this parameter.
getName() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Gets the name of the data set.
getName() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSourceDesign
Gets the name of this data source.
getName() - Method in interface org.eclipse.birt.data.engine.api.IComputedColumn
Gets the name of the computed column
getName() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the name of the group
getName() - Method in interface org.eclipse.birt.data.engine.api.IInputParameterBinding
Returns the parameter name.
getName() - Method in interface org.eclipse.birt.data.engine.api.INamedObject
get the name of current object.
getName() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the parameter name.
getName() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the name of this parameter.
getName() - Method in interface org.eclipse.birt.data.engine.api.ISubqueryDefinition
Gets the name of the subquery.
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Gets the name of this data source
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the name of the group
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
Returns the parameter name.
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getName() - Method in class org.eclipse.birt.data.engine.api.querydefn.SubqueryDefinition
 
getName() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the name of this data set
getName() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSourceInstanceHandle
Gets the name of this data source
getNativeDataType() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the column's native data type as defined by the underlying data source.
getNativeDataType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
 
getNativeName() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the native name of the parameter as known to the underlying data source.
getNativeName() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getNativeType() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the parameter's native data type as defined by the underlying data source.
getNativeType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getNativeTypeName() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the data provider specific data type name of this parameter.
getNumberOfPasses() - Method in class org.eclipse.birt.data.engine.api.aggregation.Aggregation
Deprecated. Returns the number of passes over the data series that the accumulator of this aggregate requires.
getNumberOfPasses() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Returns the number of passes over the data series that the accumulator of this aggregate requires.
getOnFetchScript() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the onFetch script to be called just after the a row is read from the data set.
getOnFetchScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSetDesign
Gets the Open script for opening the data set.
getOpenScript() - Method in interface org.eclipse.birt.data.engine.api.IScriptDataSourceDesign
Gets the open script for opening the data source (connection).
getOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
 
getOpenScript() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSourceDesign
 
getOperand1() - Method in interface org.eclipse.birt.data.engine.api.IConditionalExpression
Gets the expression for operand 1.
getOperand1() - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
getOperand2() - Method in interface org.eclipse.birt.data.engine.api.IConditionalExpression
Gets the expression for operand 2.
getOperand2() - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
getOperator() - Method in interface org.eclipse.birt.data.engine.api.IConditionalExpression
Gets the operator.
getOperator() - Method in interface org.eclipse.birt.data.engine.api.IJoinCondition
This method returns the integer standing for a compare operator.
getOperator() - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
getOperator() - Method in class org.eclipse.birt.data.engine.api.querydefn.JoinCondition
 
getOutputParameters() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the names and values of all data set output parameters, as a read-only Name (String) -> Value (Object) map.
getOutputParameterValue(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the current value of the named data set output parameter.
getOutputStream(String, String, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
According to the paramters of streamID, subStreamID and streamType, an output stream will be created for it.
getParameterDefn() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated. Gets information about the parameters that this aggregate function takes as an array of boolean values.
getParameterDefn() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Gets information about the parameters that this aggregate function takes as an array of IParameterDefn values.
getParameterMetaData() - Method in interface org.eclipse.birt.data.engine.api.IPreparedQuery
Returns a collection of IParameterMetaData that each describes the meta-data of a parameter defined in this query.
getParameters() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the data set parameter definitions as a list of IParameterDefinition objects.
getParameters() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getParentQuery() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Returns the parent query.
getParentQuery() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Returns the parent query.
getPath(String, String, int) - Static method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getPosition() - Method in interface org.eclipse.birt.data.engine.api.IInputParameterBinding
Returns the parameter position.
getPosition() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the parameter position.
getPosition() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the 1-based parameter position of this parameter, as defined by the underlying data provider.
getPosition() - Method in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
Returns the parameter position.
getPosition() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getPrecision() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the maximum number of decimal digits of this parameter.
getPreparedQuery() - Method in interface org.eclipse.birt.data.engine.api.IQueryResults
Returns the IPreparedQuery that produced this instance.
getPrimaryResultSetName() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Gets the name of the primary result set retrieved by the query.
getPrimaryResultSetName() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getPrimaryResultSetNumber() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Get the number of the primary result set retrieved by the query.
getPrimaryResultSetNumber() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getPrivateProperties() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Gets the private data set property, in the form of a ( name[String], value[String] ) map
getPrivateProperties() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSourceDesign
Gets the private connection property, in the form of a (name, setValue) pair.
getPrivateProperties() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getPrivateProperties() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Gets the private properties for the data source.
getPublicProperties() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Gets the public data set property, in the form of a ( name[String], value[String] ) map
getPublicProperties() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSourceDesign
Gets the public connection property, in the form of a (name, value) pair.
getPublicProperties() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getPublicProperties() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Gets the public properties for the data source.
getQueryExecutionHints() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Return the Query Execution Hints information.
getQueryExecutionHints() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getQueryResults(String) - Method in class org.eclipse.birt.data.engine.api.DataEngine
If and only if current mode is DataEngineContext.MODE_PRESENTATION, query result can be retrieved from report document.
getQueryResults() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the IQueryResults from which this result iterator is obtained.
getQueryResultsID() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
When this value is not null, the data set name will not be used, since it indicates query is running on the data of report document or local caching of QueryResults.
getQueryResultsID() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
getQueryText() - Method in interface org.eclipse.birt.data.engine.api.IOdaDataSetDesign
Gets the static query text of the data set.
getQueryText() - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
 
getQueryText() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the query text of the data set.
getReportQueryDefn() - Method in interface org.eclipse.birt.data.engine.api.IPreparedQuery
Returns the same IQueryDefinition used to prepare this instance, without any changes.
getResultIterator() - Method in interface org.eclipse.birt.data.engine.api.IQueryResults
Returns the current result's iterator.
getResultMetaData() - Method in interface org.eclipse.birt.data.engine.api.IQueryResults
Returns the metadata of the first or current result set
This method provides the result metadata without having to first fetch the result data.
getResultMetaData() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the metadata of this result set's detail row.
getResultMetaData() - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Gets the metadata of the data row.
getResultMetaData() - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Gets the current data set's column metadata, if available.
getResultSetExpressions() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Deprecated.  
getResultSetExpressions() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getResultSetHints() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Returns the primary result set hints as a list of IColumnDefinition objects.
getResultSetHints() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getRightDataSetDesignName() - Method in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
This method returns the name of data set which servers as right operand of a joint.
getRightDataSetDesignName() - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
getRightExpression() - Method in interface org.eclipse.birt.data.engine.api.IJoinCondition
This method returns the IScriptExpression instance which will be evaluated against the data set which servers as right operand of a joint.
getRightExpression() - Method in class org.eclipse.birt.data.engine.api.querydefn.JoinCondition
 
getRowFetchLimit() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Return the max number of rows that the data set represent by this IBaseDataSetDesign intance can fetch from data source.
getRowFetchLimit() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
getRowId() - Method in interface org.eclipse.birt.data.engine.api.IGroupInstanceInfo
Return row number of one of rows in the group.
getRowId() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Each row has its an ID associated with it, and this id will never be changed no matter when the query is running against a data set or against a report document.
getRowId() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupInstanceInfo
 
getRowId() - Method in class org.eclipse.birt.data.engine.api.querydefn.SubqueryLocator
Get the row ID.
getRowIndex() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Each row has its own index, which indicates this row position in the result set.
getScale() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns the maximum number of digits to the right of the decimal point of this parameter.
getScope() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the JavaScript scope associated with this result iterator.
getScriptContext() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
getScriptScope() - Method in interface org.eclipse.birt.data.engine.api.script.IJavascriptContext
Returns a Scriptable object that should be used as the scope in which to execute Javascript code associated with the runtime object.
getSearchHint() - Method in interface org.eclipse.birt.data.engine.api.IColumnDefinition
Gets the search hint for the column
getSearchHint() - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Gets the search hint for the column
getSecondaryIterator(String, Scriptable) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the secondary result specified by a sub query that was defined in the prepared IQueryDefinition.
getSortDirection() - Method in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Returns the sort direction on the group key.
getSortDirection() - Method in interface org.eclipse.birt.data.engine.api.ISortDefinition
Returns the sort direction.
getSortDirection() - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Returns the sort direction on the group key.
getSortDirection() - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
Returns the sort direction.
getSorts() - Method in interface org.eclipse.birt.data.engine.api.IBaseTransform
Returns the sort criteria as an ordered list of ISortDefinition objects.
getSorts() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Returns the sort criteria as an ordered list of SortDefinition objects.
getSortStrength() - Method in interface org.eclipse.birt.data.engine.api.ISortDefinition
Returns the Strength of sort.
getSortStrength() - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
getSourceQuery() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
Return the source query of current query.
getSourceQuery() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
getStartingGroupLevel() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the 1-based index of the outermost group in which the current row is the first row.
getStartingRow() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Gets the starting row that will be retrieved by this query
getStartingRow() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
getString(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column as the String data type.
getSubqueries() - Method in interface org.eclipse.birt.data.engine.api.IBaseTransform
Returns an unordered collection of subqueries that are alternative views of the result set for this transform.
getSubqueries() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
Returns an unordered collection of subqueries that are alternative views of the result set for this transform.
getTargetGroupInstances() - Method in interface org.eclipse.birt.data.engine.api.IQueryExecutionHints
Return a list of IGroupInstanceInfo instances that is needed in target ResultSet.
getTargetGroupInstances() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryExecutionHints
Return a list of IGroupInstanceInfo instances that is needed in target ResultSet.
getText() - Method in interface org.eclipse.birt.data.engine.api.IScriptExpression
 
getText() - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptExpression
 
getTmpdir() - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
get Dte temporary dir.
getType() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated. Gets the type of the Aggregation.
getType() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Gets the type of the Aggregation.
getType() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns the parameter data type.
getType() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
getValue() - Method in class org.eclipse.birt.data.engine.api.aggregation.Accumulator
This method is called after the finish() method to obtain the aggregate value in last pass of this aggregation.
getValue(String) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Returns the value of a bound column.
GROUP_INFO_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
GROUP_OVERALL - Static variable in interface org.eclipse.birt.data.engine.api.IBaseExpression
Deprecated.  
GroupDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IGroupDefinition.
GroupDefinition(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Constructs a group with the given name
GroupDefinition() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
Deprecated.  
GroupInstanceInfo - Class in org.eclipse.birt.data.engine.api.querydefn
This is an implementation to IGroupInstanceInfo.
GroupInstanceInfo(int, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.GroupInstanceInfo
 
groups - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 

H

handle - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
handleAfterClose(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSetEventHandler
 
handleAfterClose(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSourceEventHandler
 
handleAfterOpen(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSetEventHandler
 
handleAfterOpen(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSourceEventHandler
 
handleBeforeClose(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSetEventHandler
 
handleBeforeClose(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSourceEventHandler
 
handleBeforeOpen(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSetEventHandler
 
handleBeforeOpen(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSourceEventHandler
 
handleClose(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSetEventHandler
 
handleClose(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSourceEventHandler
 
handleDescribe(IDataSetInstanceHandle, IScriptDataSetMetaDataDefinition) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSetEventHandler
Method for Script Data Set to return dynamically generated data set metadata.
handleFetch(IDataSetInstanceHandle, IDataRow) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSetEventHandler
Called by data engine to obtain the next data row.
handleOnFetch(IDataSetInstanceHandle, IDataRow) - Method in interface org.eclipse.birt.data.engine.api.script.IBaseDataSetEventHandler
 
handleOpen(IDataSetInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSetEventHandler
 
handleOpen(IDataSourceInstanceHandle) - Method in interface org.eclipse.birt.data.engine.api.script.IScriptDataSourceEventHandler
 
hasDetail - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
hashCode() - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
hasInStream(String, String, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
hasOutStream(String, String, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
Determins whether one particular stream exists
HOUR_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Hour.

I

IAggregation - Interface in org.eclipse.birt.data.engine.api.aggregation
Deprecated. use IAggrFunction instead
IAggregationFactory - Interface in org.eclipse.birt.data.engine.api.aggregation
 
IAggrFunction - Interface in org.eclipse.birt.data.engine.api.aggregation
Each instance of IAggrFunction defines an aggregation function which can be used in BIRT.
IBaseDataSetDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of any data set to be used by the Data Engine.
IBaseDataSetEventHandler - Interface in org.eclipse.birt.data.engine.api.script
Handler for data set events
IBaseDataSourceDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of any data source (connection) to be used by the Data Engine.
IBaseDataSourceEventHandler - Interface in org.eclipse.birt.data.engine.api.script
Handler for Data Source events.
IBaseExpression - Interface in org.eclipse.birt.data.engine.api
Base type to represent a generic data expression used in a report design.
IBasePreparedQuery - Interface in org.eclipse.birt.data.engine.api
General Interface of prepared query.
IBaseQueryDefinition - Interface in org.eclipse.birt.data.engine.api
/** Represents attributes common to a data engine query and a subquery.
IBaseQueryResults - Interface in org.eclipse.birt.data.engine.api
The new IBaseQueryResults is an interface which will be extends by IQueryResults and ICubeQueryResults interfaces.
IBaseTransform - Interface in org.eclipse.birt.data.engine.api
Base class to define set of transforms that are common to queries, and groups within queries.
IBinding - Interface in org.eclipse.birt.data.engine.api
 
IColumnDefinition - Interface in org.eclipse.birt.data.engine.api
Describes a column that appears in the data row of a data set.
IComputedColumn - Interface in org.eclipse.birt.data.engine.api
Describes a computed column defined for a data set, or a report query.
IConditionalExpression - Interface in org.eclipse.birt.data.engine.api
Describes a conditional expression that produces a Boolean type result.
IDataEngineFactory - Interface in org.eclipse.birt.data.engine.api
Factory class to create an instance of DataEngine
IDataQueryDefinition - Interface in org.eclipse.birt.data.engine.api
General interface for Query definition.
IDataRow - Interface in org.eclipse.birt.data.engine.api.script
Represents a data row in an open data set.
IDataSetInstanceHandle - Interface in org.eclipse.birt.data.engine.api.script
A runtime instance of a data set.
IDataSourceInstanceHandle - Interface in org.eclipse.birt.data.engine.api.script
A runtime instance of a data source.
IExpressionCollection - Interface in org.eclipse.birt.data.engine.api
Describes an Array Collection of IBaseExpression, it will return an result Array.
IFilterDefinition - Interface in org.eclipse.birt.data.engine.api
Describes a data row filter defined in a data set or a report query.
IGroupDefinition - Interface in org.eclipse.birt.data.engine.api
Provides information about a grouping level within a query or subquery.
IGroupInstanceInfo - Interface in org.eclipse.birt.data.engine.api
This class provides information that can identify a unique group instance of a ResultSet.
IInputParameterBinding - Interface in org.eclipse.birt.data.engine.api
Describes on input parameter binding, which associates one input parameter (identified by either parameter name or position) to a JavaScript expression
IJavascriptContext - Interface in org.eclipse.birt.data.engine.api.script
Represents a Data Engine runtime object (e.g., data source or data set) which emits events that can be handled by Javascript code.
IJoinCondition - Interface in org.eclipse.birt.data.engine.api
This interface describes a specified conditional expression which returns a Boolean value, and used for Joint Data Set only.
IJointDataSetDesign - Interface in org.eclipse.birt.data.engine.api
This interface describes the static design of a Joint Data Set.
IN_MEMORY_CUBE_SIZE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
The size of cube to be saved in memory rather than in disk.
INamedObject - Interface in org.eclipse.birt.data.engine.api
 
INCREMENTAL_CACHE_CONFIG - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
data set incremental cache file URL.
INNER_JOIN - Static variable in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
The integer value stands for an inner join operator.
InputParameterBinding - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IInputParameterBinding interface.
InputParameterBinding(String, IBaseExpression) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
Constructs a binding based on parameter name
InputParameterBinding(int, IBaseExpression) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
Constructs a binding based on parameter position
interval - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
intervalRange - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
intervalStart - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
IOdaDataSetDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of a generic ODA (Open Data AccesS) Data Set.
IOdaDataSourceDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of an ODA (Open Data Access) Data Source.
IParameterDefinition - Interface in org.eclipse.birt.data.engine.api
Describes the metadata of a data set parameter.
IParameterDefn - Interface in org.eclipse.birt.data.engine.api.aggregation
 
IParameterMetaData - Interface in org.eclipse.birt.data.engine.api
Describes the metadata of a parameter in an IPreparedQuery.
IPreparedQuery - Interface in org.eclipse.birt.data.engine.api
A prepared data engine query ready for execution.
IQueryDefinition - Interface in org.eclipse.birt.data.engine.api
Defines a data engine query: a set of data transforms that provides data for a list-like element in the report.
IQueryExecutionHints - Interface in org.eclipse.birt.data.engine.api
This class provides hints info for a Data Engine Query to execution.
IQueryResults - Interface in org.eclipse.birt.data.engine.api
A handle used to retrieve a data engine query's results.
IResultIterator - Interface in org.eclipse.birt.data.engine.api
An iterator on a result set from a prepared and executed query.
IResultMetaData - Interface in org.eclipse.birt.data.engine.api
Describes the metadata of a detail row in an IResultIterator.
isBeforeFirst() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Retrieves whether the cursor is before the first row in this IResultIterator object.
isComputedColumn(int) - Method in interface org.eclipse.birt.data.engine.api.IResultMetaData
Indicates whether the specified projected column is defined as a computed column.
IScriptDataSetDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of a scripted Data Set.
IScriptDataSetEventHandler - Interface in org.eclipse.birt.data.engine.api.script
Event handler for a Script Data Set
IScriptDataSetMetaDataDefinition - Interface in org.eclipse.birt.data.engine.api.script
Interface for event handler to define a script data set's metadata.
IScriptDataSourceDesign - Interface in org.eclipse.birt.data.engine.api
Describes the static design of a scripted Data Source.
IScriptDataSourceEventHandler - Interface in org.eclipse.birt.data.engine.api.script
Event handler for a script data source
IScriptExpression - Interface in org.eclipse.birt.data.engine.api
Describes a Javascript expression used in the report design.
isDataField() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
to indicate whether this parameter reference to a column or binding of BIRT.
isDataOrderSensitive() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
To indicate whether the data series is order sensitive for the aggregation value.
isEmpty() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Judges if the IResultSetIterator is empty or not
isFirst() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Retrieves whether the cursor is on the first row of this IResultIterator object.
IShutdownListener - Interface in org.eclipse.birt.data.engine.api
 
isInputMode() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns whether this parameter is an input parameter.
isInputMode() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns whether this parameter is an input parameter.
isInputMode() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
isInputOptional() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Specifies whether this parameter is optional.
isInputOptional() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
isNullable() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Specifies whether null values are allowed for this parameter.
isNullable() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns whether a null value is allowed for this parameter.
isNullable() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
isOptional() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
to indicate whether this parameter is optional.
isOptional() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns whether this parameter is optional.
ISortDefinition - Interface in org.eclipse.birt.data.engine.api
Describes one sort (key, direction) pair in a sort sequence.
isOutputMode() - Method in interface org.eclipse.birt.data.engine.api.IParameterDefinition
Returns whether this parameter is an output parameter.
isOutputMode() - Method in interface org.eclipse.birt.data.engine.api.IParameterMetaData
Returns whether this parameter is an output parameter.
isOutputMode() - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
 
ISubqueryDefinition - Interface in org.eclipse.birt.data.engine.api
Provides definition of subquery: a supplemental use of rows returned by a data set or a group.

J

JoinCondition - Class in org.eclipse.birt.data.engine.api.querydefn
An implementation of IJoinConditionExpression.
JoinCondition(IScriptExpression, IScriptExpression, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.JoinCondition
Constructor.
JointDataSetDesign - Class in org.eclipse.birt.data.engine.api.querydefn
This is an implementation of IJointDataSetDesign
JointDataSetDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
Constructor
JointDataSetDesign(String, String, String, int, List) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
Constructor.

K

keyColumn - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
keyColumn - Variable in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
keyExpr - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
keyExpr - Variable in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 

L

LEFT_OUTER_JOIN - Static variable in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
The integer value stands for a left outer join operator.

M

maxRowCount - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
MEMORY_BUFFER_SIZE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
Indicate the size of data cached for each result set.We only accept positive integer as input, the unit of which would be MB.
MEMORY_DATA_SET_CACHE - Static variable in class org.eclipse.birt.data.engine.api.DataEngine
Indicates whether memory data set cache function need to be used: Positive integer: Enable memory data set cache.
META_INDEX_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
META_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
MINUTE_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Minute.
MODE_GENERATION - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
three defined mode
MODE_PRESENTATION - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
MODE_UPDATE - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
this is a special mode, that a query which is running on a report document also needs to be stored into the same report document.
MONTH_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Month.
moveTo(int) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Moves iterator to the row with given absolute index.

N

name - Variable in class org.eclipse.birt.data.engine.api.querydefn.ComputedColumn
 
name - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
name - Variable in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
 
NAMING_RELATION_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
needAutoBinding() - Method in interface org.eclipse.birt.data.engine.api.IQueryDefinition
When user knows which columns are in data set and user likes to get the column value without explicitly binding a name to a data set row expression, this flag can be set as true to indicate it.
needAutoBinding() - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
needDistinctValue() - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
When user wants to retrieve the distinct row, this flag needs to be set as true.
needDistinctValue() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
newAccumulator() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated. Creates a new instance of the accumulator for this aggregation.
newAccumulator() - Method in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
Creates a new instance of the accumulator for this aggregation.
newDataEngine(DataEngineContext) - Static method in class org.eclipse.birt.data.engine.api.DataEngine
Creates a new instance of DataEngine, using the specified DataEngineContext as its running environment
newDataEngine(PlatformConfig, DataEngineContext) - Static method in class org.eclipse.birt.data.engine.api.DataEngine
 
newDataEngine(Scriptable) - Static method in class org.eclipse.birt.data.engine.api.DataEngine
Deprecated. use newDataEngine( DataEngineContext context ) instead
newDataEngine(Scriptable, File) - Static method in class org.eclipse.birt.data.engine.api.DataEngine
Deprecated. Use newDataEngine(Scriptable) instead. Home Dir is no longer used.
newInstance(int, Scriptable, IDocArchiveReader, IDocArchiveWriter, ClassLoader) - Static method in class org.eclipse.birt.data.engine.api.DataEngineContext
Deprecated.  
newInstance(int, Scriptable, IDocArchiveReader, IDocArchiveWriter) - Static method in class org.eclipse.birt.data.engine.api.DataEngineContext
Deprecated.  
newInstance(int, ScriptContext, IDocArchiveReader, IDocArchiveWriter, ClassLoader) - Static method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
next() - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Moves down one element from its current position of the iterator.
NO_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
No grouping interval unit specified.
NO_SORT - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
 
NOT_SEARCHABLE - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
NUMERIC_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is the numerical value.

O

OdaDataSetDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IOdaDataSetDesign interface.
OdaDataSetDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Constructs an instance with the given name
OdaDataSetDesign(String, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Constructs an instance with the given name and data source name
OdaDataSourceDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IOdaDataSourceDesign interface.
OdaDataSourceDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Constructs a data source with the given name
ON_EACH_ROW - Static variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
The expression is evaluated on each row.
onRow(Object[]) - Method in class org.eclipse.birt.data.engine.api.aggregation.Accumulator
This method is called on every data row to supply arguments to the aggregation.
op1 - Variable in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
op2 - Variable in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
OP_BETWEEN - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Between operator.
OP_BOTTOM_N - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Bottom(N) aggregate operator.
OP_BOTTOM_PERCENT - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The BottomNPercent aggregate operator.
OP_EQ - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Equals operator.
OP_EQ - Static variable in interface org.eclipse.birt.data.engine.api.IJoinCondition
The integer value stands for an equality operator.
OP_FALSE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The isFalse operator.
OP_GE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The GreaterThanOrEqualTo operator.
OP_GT - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The GreaterThan operator.
OP_IN - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
IN, NOT_IN operator.
OP_LE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The LessThanOrEqualTo operator.
OP_LIKE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Like operator.
OP_LT - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The LessThan operator.
OP_MATCH - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Match operator.
OP_NE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The NotEquals operator.
OP_NONE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
No operator defined for this conditonal expression
OP_NOT_BETWEEN - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The NotBetween operator.
OP_NOT_IN - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
 
OP_NOT_LIKE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
 
OP_NOT_MATCH - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
 
OP_NOT_NULL - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The isNotNull operator.
OP_NULL - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The isNull operator.
OP_TOP_N - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The Top(N) aggregate operator.
OP_TOP_PERCENT - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The TopNPercent aggregate operator.
OP_TRUE - Static variable in interface org.eclipse.birt.data.engine.api.IConditionalExpression
The isTrue operator.
operator - Variable in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
org.eclipse.birt.data.engine.api - package org.eclipse.birt.data.engine.api
This package contains the main public API classes and interfaces of the BIRT Data Engine (DtE).
org.eclipse.birt.data.engine.api.aggregation - package org.eclipse.birt.data.engine.api.aggregation
Data Engine aggregation API package.
org.eclipse.birt.data.engine.api.querydefn - package org.eclipse.birt.data.engine.api.querydefn
This package is part of the Data Engine public API, and contains default implementation of request interfaces in org.eclipse.birt.data.engine.api.
org.eclipse.birt.data.engine.api.script - package org.eclipse.birt.data.engine.api.script
This package defines BIRT Data Engine's public interfaces and classes to support Scripting.
ORIGINAL_QUERY_DEFN_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 

P

ParameterDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IParameterDefinition interface.
ParameterDefinition() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Constructs an empty parameter definition
ParameterDefinition(String, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Constructs a name-based parameter definition with specified data type
ParameterDefinition(int, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Constructs a position-based parameter definition with specified data type
ParameterDefinition(String, int, boolean, boolean) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Constructs a name-based parameter definition with specified data type, and input/output mode
ParameterDefinition(int, int, boolean, boolean) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Constructs a position-based parameter definition with specified data type, and input/output mode
parentQuery - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
PLS_GROUPLEVEL_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
position - Variable in class org.eclipse.birt.data.engine.api.querydefn.InputParameterBinding
 
prepare(IQueryDefinition) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Verifies the elements of a report query spec and provides a hint to the query to prepare and optimize an execution plan.
prepare(IQueryDefinition, Map) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Verifies the elements of a report query spec, and provides a hint and application context object(s) to the query to prepare and optimize an execution plan.
prepare(ICubeQueryDefinition, Map) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Prepare the cube query definition, return an IPreparedCubeQuery instance
prepare(ISubCubeQueryDefinition, Map) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Prepare the sub cube query definition, return an IPreparedCubeQuery instance
projectedColumns - Variable in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 

Q

QUARTER_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Quarter.
QUERY_DEFN_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
QueryDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IQueryDefinition interface
QueryDefinition() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Constructs an empty query definition
QueryDefinition(BaseQueryDefinition) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Constructs a query that is nested within another query.
QueryExecutionHints - Class in org.eclipse.birt.data.engine.api.querydefn
This is an implementation of IQueryExecutionHints.
QueryExecutionHints() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.QueryExecutionHints
 
QUERYID_INFO_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 

R

registerQueries(IDataQueryDefinition[]) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Optimize query execution by analyze a list of query definitions.
removeListener(IShutdownListener) - Method in class org.eclipse.birt.data.engine.api.DataEngine
Remove a shut down listener.
RIGHT_OUTER_JOIN - Static variable in interface org.eclipse.birt.data.engine.api.IJointDataSetDesign
The integer value stands for a right outer join operator.
ROW_INDEX_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
rowExpressions - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
RUNNING_AGGR - Static variable in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated.  
RUNNING_AGGR - Static variable in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
 

S

ScriptDataSetDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IScriptDataSetDesign interface.
ScriptDataSetDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Constructs a script data set with the specified name
ScriptDataSetDesign(String, String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Constructs a script data set with the specified name and data source name
ScriptDataSourceDesign - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of IScriptDataSourceDesign interface.
ScriptDataSourceDesign(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSourceDesign
Constructs a script data source with specified name
ScriptExpression - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the IScriptExpression interface
ScriptExpression(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ScriptExpression
Constructs a Javascript expression
ScriptExpression(String, int) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.ScriptExpression
Constructs a Javascript expression
SEARCHABLE_IF_INDEXED - Static variable in interface org.eclipse.birt.data.engine.api.IColumnDefinition
 
SECOND_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Second.
setAfterCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the afterClose script for the data set
setAfterCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Specifies the afterClose script of the data source.
setAfterOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the afterOpen script for the data set
setAfterOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Sets the afterOpen script of the data source.
setAggrFunction(String) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setAggrFunction(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setAlias(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
 
setApplyOnGroupFlag(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.SubqueryDefinition
Set the flag of whether this subquery is applied to the group or only one row of parent query.
setAutoBinding(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
setBeforeCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the beforeClose script for the data set
setBeforeCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Sets the beforeClose script of the data source.
setBeforeOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the beforeOpen script for the data set
setBeforeOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Sets the beforeOpen script of the data source.
setCacheOption(int, int) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
This method is used to set the cache option for current data engine instance.
setCacheQueryResults(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
setCacheRowCount(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Deprecated.  
setClassLoader(ClassLoader) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
Set the classloader.
setCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Specifies the close script for closing the data set.
setCloseScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSourceDesign
Specifies the close script for opening the data source (connection).
setColumn(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
setColumnPosition(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Assigns the indexed position to a Column definition.
setColumnProjection(String[]) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
Provides a column projection hint to the data engine.
setColumnValue(int, Object) - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Sets the column data by index.
setColumnValue(String, Object) - Method in interface org.eclipse.birt.data.engine.api.script.IDataRow
Sets the column data by column name.
setDataSetName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
setDataSource(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Specifies the data source (connection) name.
setDataType(int) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setDataType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
Sets the data type of the expression
setDataType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setDataType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
 
setDataType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
Sets the data type of the expression.
setDefaultInputValue(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the parameter's default input value.
setDescribeScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Specifies the describe script for providing the data set metadata
setDisplayName(String) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setDisplayName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setDistinctValue(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
setDistinctValue(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Sets the distinct value flag.
setEventHandler(IBaseDataSetEventHandler) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the event handler for this data set
setEventHandler(IBaseDataSourceEventHandler) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSourceDesign
Sets the event handler for this data source
setExportable(boolean) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setExportable(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setExportHint(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
 
setExpression(IBaseExpression) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setExpression(IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setExpression(IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.FilterDefinition
Sets a new expression for the filter.
setExpression(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
setExtensionID(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Specifies the extension ID for this type of data set
setExtensionID(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSourceDesign
Sets the data source extension id as defined by ODA driver
setExtensionProperty(String, String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Set the value of an extension property
setExtensionProperty(String, String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSourceInstanceHandle
Set the extension property value
setFetchScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Specifies the fetch script for fetching each data row.
setFilter(IBaseExpression) - Method in interface org.eclipse.birt.data.engine.api.IBinding
 
setFilter(IBaseExpression) - Method in class org.eclipse.birt.data.engine.api.querydefn.Binding
 
setGroupName(String) - Method in interface org.eclipse.birt.data.engine.api.IBaseExpression
Deprecated.  
setGroupName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
setGroupName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ConditionalExpression
 
setHandle(Object) - Method in interface org.eclipse.birt.data.engine.api.IBaseExpression
Associates the expression with the provided handle.
setHandle(Object) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
setID(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseExpression
 
setInputMode(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the input mode of the parameter.
setInputOptional(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets whether the parameter's input value is optional.
setInputParameterValue(String, Object) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Sets the value of the named data set input parameter.
setInterval(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setIntervalRange(double) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setIntervalStart(Object) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setJoinType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
setKeyColumn(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setKeyExpression(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setLeftDataSetDesignName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
setLocale(Locale) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
 
setMaxRows(int) - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
set the maximum number of detail rows that can be retrieved by this query
setMaxRows(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Sets the maximum number of detail rows that can be retrieved by this report query
setName(String) - Method in interface org.eclipse.birt.data.engine.api.INamedObject
set the name of current object.
setName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
setName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the name of the parameter
setNativeDataType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
Set the column native data type.
setNativeName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the parameter's native name as known to the underlying ODA driver.
setNativeType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the parameter native data type
setNullable(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets whether the parameter's value can be null.
setOnFetchScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
Sets the onFetch script for the data set
setOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSetDesign
Specifies the open script for opening the data set.
setOpenScript(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptDataSourceDesign
Specifies the open script for opening the data source (connection).
setOutputMode(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the output mode of the parameter.
setOutputParameterValue(String, Object) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Sets the value of the named data set output parameter.
setPosition(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the parameter position
setPrimaryResultSetName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Specifies the name of the primary result set.
setPrimaryResultSetNumber(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Set the primary result set number.
setQueryExecutionHints(IQueryExecutionHints) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Set the query execution hints.
setQueryResultsID(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
setQueryText(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.OdaDataSetDesign
Specifies the static query text.
setQueryText(String) - Method in interface org.eclipse.birt.data.engine.api.script.IDataSetInstanceHandle
Sets the query text of the data set.
setRightDataSetDesignName(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.JointDataSetDesign
 
setRowFetchLimit(int) - Method in interface org.eclipse.birt.data.engine.api.IBaseDataSetDesign
Set up the max number of rows that the data set represent by this IBaseDataSetDesign instance can fetch from data source.
setRowFetchLimit(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
 
setSearchHint(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ColumnDefinition
 
setSortBeforeGrouping(boolean) - Method in interface org.eclipse.birt.data.engine.api.IQueryExecutionHints
Set whether to sort before grouping.
setSortBeforeGrouping(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryExecutionHints
 
setSortDirection(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
setSortDirection(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
setSortStrength(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
Set the collator sort strength of the destine sort.
setSourceQuery(IBaseQueryDefinition) - Method in class org.eclipse.birt.data.engine.api.querydefn.QueryDefinition
 
setStartingRow(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Sets the starting row that will be retrieved by this query
setText(String) - Method in class org.eclipse.birt.data.engine.api.querydefn.ScriptExpression
Sets the Javascript expression text
setTmpdir(String) - Method in class org.eclipse.birt.data.engine.api.DataEngineContext
set Dte temporary dir.
setType(int) - Method in class org.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
Sets the parameter data type
setUsesDetails(boolean) - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
shutdown() - Method in class org.eclipse.birt.data.engine.api.DataEngine
Shuts down this instance of data engine, and releases all associated resources.
skipToEnd(int) - Method in interface org.eclipse.birt.data.engine.api.IResultIterator
Advances the iterator, skipping rows to the last row in the current group at the specified group level.
SORT_ASC - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
 
SORT_ASC - Static variable in interface org.eclipse.birt.data.engine.api.ISortDefinition
Sorts in ascending order of sort key values
SORT_DESC - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
 
SORT_DESC - Static variable in interface org.eclipse.birt.data.engine.api.ISortDefinition
Sorts in descending order of sort key values
SortDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the ISortDefinition interface.
SortDefinition() - Constructor for class org.eclipse.birt.data.engine.api.querydefn.SortDefinition
 
sortDirection - Variable in class org.eclipse.birt.data.engine.api.querydefn.GroupDefinition
 
sorts - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
start() - Method in class org.eclipse.birt.data.engine.api.aggregation.Accumulator
This method is called before the the first onRow() call.
startingRow - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
 
STRING_PREFIX_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is the length of the string prefix.
subqueries - Variable in class org.eclipse.birt.data.engine.api.querydefn.BaseTransform
 
SUBQUERY_INFO_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
SUBQUERY_PARENTINDEX_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
 
SubqueryDefinition - Class in org.eclipse.birt.data.engine.api.querydefn
Default implementation of the ISubqueryDefinition interface.
SubqueryDefinition(String) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.SubqueryDefinition
Deprecated.  
SubqueryDefinition(String, IBaseQueryDefinition) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.SubqueryDefinition
Constructs a SubqueryDefn.
SubqueryLocator - Class in org.eclipse.birt.data.engine.api.querydefn
A sub class of SubqueryDefinition.
SubqueryLocator(int, String, IBaseQueryDefinition) - Constructor for class org.eclipse.birt.data.engine.api.querydefn.SubqueryLocator
Constructs a SubqueryLocator.
SUMMARY_AGGR - Static variable in interface org.eclipse.birt.data.engine.api.aggregation.IAggregation
Deprecated.  
SUMMARY_AGGR - Static variable in interface org.eclipse.birt.data.engine.api.aggregation.IAggrFunction
 
supportDataType(int) - Method in interface org.eclipse.birt.data.engine.api.aggregation.IParameterDefn
check whether this parameter support specified data type.

U

usesDetails() - Method in interface org.eclipse.birt.data.engine.api.IBaseQueryDefinition
Indicates if the report will use the detail rows.
usesDetails() - Method in class org.eclipse.birt.data.engine.api.querydefn.BaseQueryDefinition
Indicates if the report will use the detail rows.

V

VERSION_INFO_STREAM - Static variable in class org.eclipse.birt.data.engine.api.DataEngineContext
stream id for internal use, don't use it externally

W

WEEK_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Week.

Y

YEAR_INTERVAL - Static variable in interface org.eclipse.birt.data.engine.api.IGroupDefinition
Grouping interval unit is Year.

A B C D E F G H I J K L M N O P Q R S U V W Y

Copyright © 2008 Actuate Corp. All rights reserved.