com.businessobjects.rebean.wi
Class DataProviderFeature

java.lang.Object
  extended by com.businessobjects.rebean.wi.Feature
      extended by com.businessobjects.rebean.wi.DataProviderFeature
All Implemented Interfaces:
java.io.Serializable

public class DataProviderFeature
extends Feature

The DataProviderFeature class defines the set of features provided by an inherited DataProvider object. These features basically defines the properties and permissions of the DataProvider object.

Example:Check whether DUPLICATE_ROW feature is supported by DataProvider or not

 DataProvider dp = wiDoc.getDataProviders().getItem(0);
 out.print(dp.isSupported(DataProviderFeature.DUPLICATE_ROW));
 

Since:
12.0
See Also:
DataProvider.isSupported(Feature), QueryFeature, ConditionOperatorFeature, Serialized Form

Field Summary
static DataProviderFeature CREATE_COMBINED_QUERY
          Capability of DataProvider to add a Query or a QueryContainer into a QueryContainer.
static DataProviderFeature DUPLICATE_ROW
          Capability of a DataProvider (or SQLDataProvider ) returning duplicated row while procesing the query.
static DataProviderFeature EDIT_QUERY
          Capability of DataProvider to create and to change a query.
static DataProviderFeature MISSING_ROW
          Capability of DataProvider (OLAPDataProvider) returning missing rows while procesing query.
static DataProviderFeature REFRESH
          Capability of a DataProvider to refresh the query.
static DataProviderFeature SAMPLING_FREE_RANDOM
          Capability of SQLDataProvider to retrive its rows in random order while processing SQL.
static DataProviderFeature SAMPLING_REPEATABLE_RANDOM
          Capability of SQLDataProvider to retrive its rows using repeatable random order sampling while processing SQL.
static DataProviderFeature VIEW_SQL
          Permission of SQLDataProvider to read SQL statements SQLDataProvider.getSQLContainer().
 
Method Summary
 java.lang.String toString()
          Returns the String value corresponding to DataProviderFeature type
 
Methods inherited from class com.businessobjects.rebean.wi.Feature
implies
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DUPLICATE_ROW

public static final DataProviderFeature DUPLICATE_ROW
Capability of a DataProvider (or SQLDataProvider ) returning duplicated row while procesing the query.

Note if this feature is activated, you can enable or disable duplicate row behavior using SQLDataProvider.setDuplicatedRows(boolean).

See Also:
SQLDataProvider, SQLDataProvider.setDuplicatedRows(boolean)

MISSING_ROW

public static final DataProviderFeature MISSING_ROW
Capability of DataProvider (OLAPDataProvider) returning missing rows while procesing query.

Note if this feature is activated, you can enable or disable missing row behavior using OLAPDataProvider#setMissingRow.


EDIT_QUERY

public static final DataProviderFeature EDIT_QUERY
Capability of DataProvider to create and to change a query.

Note when EDIT_QUERY is allowed, you can use QueryContainer.createQuery(), QueryContainer.createQueryContainer(CombinedQueryOperator), DataProvider.copyCombinedQueries(QueryContainer), QueryNode.remove(QueryNode),

See Also:
DataProvider, QueryContainer

CREATE_COMBINED_QUERY

public static final DataProviderFeature CREATE_COMBINED_QUERY
Capability of DataProvider to add a Query or a QueryContainer into a QueryContainer.

Note when CREATE_COMBINED_QUERY is allowed, you can use QueryContainer.createQuery(), QueryContainer.createQueryContainer(CombinedQueryOperator).

CREATE_COMBINED_QUERY implies EDIT_QUERY.


VIEW_SQL

public static final DataProviderFeature VIEW_SQL
Permission of SQLDataProvider to read SQL statements SQLDataProvider.getSQLContainer().


SAMPLING_FREE_RANDOM

public static final DataProviderFeature SAMPLING_FREE_RANDOM
Capability of SQLDataProvider to retrive its rows in random order while processing SQL.

Note even if this feature is supported, the query should be a simple Query to get rows processed in random order.

See Also:
SQLDataProvider, SamplingMode

SAMPLING_REPEATABLE_RANDOM

public static final DataProviderFeature SAMPLING_REPEATABLE_RANDOM
Capability of SQLDataProvider to retrive its rows using repeatable random order sampling while processing SQL.

Note even if this feature is supported, the query should be a simple Query to get rows processed in repeatable random order.

See Also:
SQLDataProvider, SamplingMode

REFRESH

public static final DataProviderFeature REFRESH
Capability of a DataProvider to refresh the query.

Method Detail

toString

public java.lang.String toString()
Returns the String value corresponding to DataProviderFeature type

Overrides:
toString in class java.lang.Object