DataSource (webcentral-platform-core DEVELOP-23.2-20170615.132754 API)

All Known Subinterfaces:

ObjectDataSource<T>

All Known Implementing Classes:

DataSourceGroupingImpl, DataSourceImpl, ObjectDataSourceImpl
```
public interface DataSource
```
The DataSource is a programming interface to Web Central data access layer. Web Central data access layer implements declarative object-relational mapping, secure data access, and transparent data localization using metadata defined in the ARCHIBUS data dictionary.
When the DataSource is used to read or write data, it transparently performs ARCHIBUS-specific processing:
Applies ARCHIBUS security: checks whether the current user has read/write permissions for fields;
Applies current user VPA restrictions (if they are applicable to the query table/fields);
For tables with localized fields, chooses field according to the current user locale;
Converts data values from database-specific formats to Java objects and back;
Generates SQL queries using database-specific SQL dialect.
Handles transactions and exceptions, maps database-specific exceptions to ARCHIBUS user-friendly exceptions.
Optionally formats data values for the current user locale.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DataSource.RecordHandler` Callback interface that can be passed as a parameter to getRecords() and getAllRecords().

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DATA_TYPE_BOOLEAN` Constant for unformatted (verbatim) parameter type.
`static java.lang.String`	`DATA_TYPE_CURRENCY` Constant for currency type.
`static java.lang.String`	`DATA_TYPE_DATE` Constant for date field/parameter type.
`static java.lang.String`	`DATA_TYPE_DOUBLE` Constant for numeric field/parameter type.
`static java.lang.String`	`DATA_TYPE_INTEGER` Constant for integer field/parameter type.
`static java.lang.String`	`DATA_TYPE_MEMO` Constant for memo field/parameter type.
`static java.lang.String`	`DATA_TYPE_NUMBER` Constant for numeric field/parameter type.
`static java.lang.String`	`DATA_TYPE_TEXT` Constant for text field/parameter type.
`static java.lang.String`	`DATA_TYPE_TIME` Constant for time field/parameter type.
`static java.lang.String`	`DATA_TYPE_VERBATIM` Constant for unformatted (verbatim) parameter type.
`static java.lang.String`	`DB_ROLE_DATA` Constant for "data" database role.
`static java.lang.String`	`DB_ROLE_SCHEMA` Constant for "schema" database role.
`static java.lang.String`	`DB_ROLE_SECURITY` Constant for "security" database role.
`static java.lang.String`	`ROLE_MAIN` Constant for "main" table role.
`static java.lang.String`	`ROLE_STANDARD` Constant for "standard" table role.
`static java.lang.String`	`SORT_ASC` Constant for ascending sort order.
`static java.lang.String`	`SORT_DESC` Constant for descending sort order.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DataSource`	`addCalculatedField(com.archibus.datasource.VirtualFieldDef calculatedField)` Adds a calculated field to the data source.
`DataSource`	`addField(java.lang.String name)` Adds specified main table field to the data source query.
`DataSource`	`addField(java.lang.String[] names)` Adds specified main table fields to the data source query.
`DataSource`	`addField(java.lang.String table, java.lang.String name)` Adds specified field to the data source query.
`DataSource`	`addField(java.lang.String table, java.lang.String[] names)` Adds specified fields to the data source query.
`DataSource`	`addParameter(java.lang.String name, double value, java.lang.String dataType)`
`DataSource`	`addParameter(java.lang.String name, int value, java.lang.String dataType)`
`DataSource`	`addParameter(java.lang.String name, java.lang.Object value, java.lang.String dataType)`
`DataSource`	`addParameter(java.lang.String name, java.lang.String value, java.lang.String dataType)` Adds a query parameter.
`DataSource`	`addQuery(java.lang.String sql)` Adds a generic dialect SQL query to the data source.
`DataSource`	`addQuery(java.lang.String sql, java.lang.String dialect)` Adds an SQL query to the data source.
`DataSource`	`addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction.Clause c)` Adds a restriction clause.
`DataSource`	`addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction r)` Adds a restriction.
`DataSource`	`addSort(java.lang.String name)` Adds a main table sort field to the data source query, in SORT_ASC mode.
`DataSource`	`addSort(java.lang.String table, java.lang.String name)` Adds a sort field to the data source query, in SORT_ASC mode.
`DataSource`	`addSort(java.lang.String table, java.lang.String name, java.lang.String order)` Adds a sort field to the data source query.
`DataSource`	`addTable(java.lang.String name)` Adds specified table to the data source query, as a "main" table.
`DataSource`	`addTable(java.lang.String name, java.lang.String role)` Adds specified table in specified role to the data source query.
`DataSource`	`addVirtualField(java.lang.String table, java.lang.String name, java.lang.String dataType)` Adds a virtual field to the data source.
`DataSource`	`addVirtualField(java.lang.String table, java.lang.String name, java.lang.String dataType, int size, int decimals)` Adds a virtual field to the data source.
`DataSource`	`addVirtualField(java.lang.String table, java.lang.String name, java.lang.String dataType, int size, int decimals, java.lang.String title)`
`DataSource`	`clearRestrictions()` Clears all restrictions defined in AXVW.
`void`	`commit()` Commit current database transaction.
`com.archibus.datasource.data.DataRecord`	`createNewRecord()` Creates new DataRecord with default values for all fields defined in the data source.
`org.json.JSONArray`	`createPrimaryKeyIds()` Creates primary key column definitions in JSON format from the data source.
`com.archibus.datasource.data.DataRecord`	`createRecord()` Creates new DataRecord with default values for all fields defined in the data source.
`com.archibus.datasource.data.DataRecord`	`createRecordFromContext()` Creates new DataRecord with default values for all fields defined in the data source.
`com.archibus.db.ViewField.Immutable`	`createVirtualViewField(java.lang.String table, java.lang.String name, java.lang.String fieldJavaType, java.text.NumberFormat format)` Creates and returns virtual view field for specified Java field type.
`void`	`deleteRecord(com.archibus.datasource.data.DataRecord record)` Deletes existing record.
`void`	`deleteRecord(java.util.Map fieldValues)` Deletes record specified by field values.
`void`	`enableIdLookup(boolean value)` Sets the idLookupEnabled property.
`void`	`executeUpdate()` Executes SQL update query, set using addQuery().
`void`	`executeUpdateRequired()` Executes SQL update query, set using addQuery().
`com.archibus.db.ViewField.Immutable`	`findField(java.lang.String fullName)` Returns a field definition for specified full field name.
`com.archibus.db.ViewField.Immutable`	`findVirtualField(java.lang.String fullName)` Loop through the virtual fields for the current data source and Returns a field definition for specified full field name.
`java.lang.String`	`formatJoin(java.lang.String fieldName)` Generates a join between the table of specified field and its validating table, if any.
`java.lang.String`	`formatSqlForPersistentRestrictions()` Generates SQL WHERE clause from VPAs for current user/role applicable to the main table in current DataSource.
`java.lang.String`	`formatSqlForPersistentRestrictionsForTable(java.lang.String tableName)` Generates SQL WHERE clause from VPAs for current user/role applicable to the specified table in current DataSource.
`java.lang.String`	`formatSqlForPersistentRestrictionsForTableAndRole(java.lang.String tableName, java.lang.String roleName)` Generates SQL WHERE clause from VPAs applicable to the specified table in current DataSource.
`java.lang.String`	`formatSqlForRestriction(java.lang.String id)` Generates SQL WHERE clause from a named restriction.
`java.lang.String`	`formatSqlQuery(java.lang.String restriction, boolean doNotWrap)` Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
`java.lang.String`	`formatSqlQuery(java.lang.String restriction, java.util.List sortValues, java.util.List filterValues, boolean isOrderbyAllowed, boolean doNotWrap)` Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
`java.lang.String`	`formatSqlQueryForField(java.lang.String restriction, java.util.List sortValues, java.util.List filterValues, boolean isOrderbyAllowed, boolean doNotWrap, java.lang.String fieldName)` Formats and returns an SQL query that selects a single specified field.
`java.util.List<com.archibus.db.ViewField.Immutable>`	`getAllFields()` Returns a list of field definitions for visible and/or virtual fields.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getAllRecords()` Retrieves records that contains values for all fields defined in the data source, using no record limit.
`com.archibus.datasource.VirtualFieldDef`	`getCalculatedFieldDef(java.lang.String tableName, java.lang.String fieldName)` Returns specified virtual field definition.
`com.archibus.model.view.datasource.AbstractDataSourceDef`	`getDataSourceDef()`
`java.util.List<EventHandlerBase.DbField>`	`getDbFieldsForNewRecord()` Returns a list of DB field definitions for default new record.
`java.util.Map<java.lang.String,EventHandlerBase.DbField>`	`getDbFieldsForPrimaryKeysAsMap()` Returns a map of DB field definitions for key fields.
`java.util.List<EventHandlerBase.DbField>`	`getDbFieldsForVisibleFields()` Returns a list of DB field definitions for all fields defined in the data source.
`com.archibus.datasource.data.DataRecord`	`getDefaultRecord(java.lang.String restriction)` Returns DataRecord with default values for all fields defined in the data source.
`java.util.List<java.lang.String>`	`getFieldNames()`
`java.lang.String`	`getId()`
`com.archibus.schema.TableDef.ThreadSafe`	`getMainTableDef()` Returns main table definition.
`java.lang.String`	`getMainTableName()` Returns main table name.
`java.util.Map<java.lang.String,DataSourceImpl.Parameter>`	`getParameters()` Returns all parameters.
`java.util.List<java.lang.String>`	`getPrimaryKeyFieldNamesForTable(java.lang.String tableName)` Returns a collection of the main table's primary key field names.
`java.util.List<com.archibus.db.ViewField.Immutable>`	`getPrimaryKeyFields()` Returns a list of primary key fields.
`com.archibus.datasource.SqlExpressions`	`getQueries()` Returns all custom queries.
`com.archibus.datasource.data.DataRecord`	`getRecord()` Retrieves a single record that contains values for all fields defined in the data source.
`com.archibus.datasource.data.DataRecord`	`getRecord(java.lang.String restriction)` Retrieves a single record that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords()` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords(com.archibus.model.view.datasource.AbstractRestrictionDef restriction)` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions)` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions, int maxRecords)` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords(java.lang.String restriction)` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.data.DataRecord>`	`getRecords(java.lang.String restriction, int maxRecords)` Retrieves records that contains values for all fields defined in the data source.
`java.util.List<com.archibus.datasource.restriction.Restrictions.Restriction>`	`getRestrictions()` Returns a list of restriction definitions.
`java.util.Map<java.lang.String,java.lang.Object>`	`getRestrictionValues()` Returns restrictions values passed in from the client.
`java.util.List<DataSourceImpl.SortField>`	`getSortFields()` Returns a list of sort field definitions.
`java.util.List<DataSourceImpl.TableAndRole>`	`getTablesAndRoles()` Returns a list of table names and roles.
`java.lang.String`	`getTitle()`
`java.lang.String`	`getViewName()`
`com.archibus.datasource.VirtualFieldDef`	`getVirtualFieldDef(java.lang.String tableName, java.lang.String fieldName)` Returns specified virtual field definition.
`java.util.List<com.archibus.db.ViewField.Immutable>`	`getVirtualFields()` Returns a list of virtual fields.
`java.util.List<com.archibus.db.ViewField.Immutable>`	`getVisibleFields()` Returns a list of visible fields.
`java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable>`	`getVisibleFieldsByName()` Returns a map of visible fields.
`boolean`	`hasCustomQuery()` Returns true if the data source uses custom SQL qeury.
`boolean`	`hasMoreRecords()` Returns true if preceding call to retrieveRecords() did not read all records due to record limit.
`boolean`	`hasVirtualFields()` Returns true if the data source defines virtual fields for custom SQL qeury.
`boolean`	`isDistinct()` Gets the distinct attribute
`boolean`	`isIdLookupEnabled()` Whether this data source can use lookup fields.
`boolean`	`isOracle()` Returns true if the current database server is Oracle.
`boolean`	`isSqlServer()` Returns true if the current database server is SQL Server.
`boolean`	`isSybase()` Returns true if the current database server is Sybase.
`java.util.List<com.archibus.db.RestrictionSqlBase.Immutable>`	`parseClientRestrictions(java.lang.String restrictionString)` Creates parsed or SQL restriction from the string input parameter.
`void`	`queryRecords(DataSource.RecordHandler recordHandler)` Executes SQL query and calls specified callback for each retrieved record.
`void`	`queryRecords(java.lang.String restriction, DataSource.RecordHandler recordHandler)` Executes SQL query and calls specified callback for each retrieved record.
`void`	`rollback()` Rollback current database transaction.
`com.archibus.datasource.data.DataRecord`	`saveRecord(com.archibus.datasource.data.DataRecord record)` Saves new or updates existing record.
`DataSource`	`setApplyVpaRestrictions(boolean applyVpaRestrictions)` The applyVpaRestrictions property enables or disables VPA restrictions for all read queries, whether the Data Source uses custom SQL or not.
`DataSource`	`setAutoCommit(boolean autoCommit)` Sets the autoCommit flag.
`DataSource`	`setContext()` Sets data source context and initializes context-dependent data source state based on the current thread context.
`DataSource`	`setContext(com.archibus.config.ContextCacheable.Immutable context)` Sets data source context and initializes context-dependent data source state.
`DataSource`	`setContext(EventHandlerContext eventHandlerContext)` Sets data source context and initializes context-dependent data source state.
`DataSource`	`setDatabaseRole(java.lang.String role)` Set database role for this DataSource to access.
`void`	`setDataSourceDef(com.archibus.model.view.datasource.AbstractDataSourceDef dataSourceDef)`
`DataSource`	`setDistinct(boolean isDistinct)` Sets isDistinct flag.
`void`	`setId(java.lang.String id)`
`DataSource`	`setMaxRecords(int maxRecords)` Sets the max number of records that can be retrieved by consequent calls to retrieveRecords().
`DataSource`	`setParameter(java.lang.String name, java.lang.Object value)` Sets new value for specified parameter.
`void`	`setTitle(java.lang.String title)`
`DataSource`	`setUseHierarchicalSecurityRestriction(boolean useHierarchicalSecurityRestriction)` Sets the useHierarchicalSecurityRestriction property.
`void`	`setViewName(java.lang.String viewName)`
`void`	`updateRecord(com.archibus.datasource.data.DataRecord record)` Updates existing record specified by the primary key values.

- Field Detail
  - DATA_TYPE_BOOLEAN
```
static final java.lang.String DATA_TYPE_BOOLEAN
```
    Constant for unformatted (verbatim) parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_CURRENCY
```
static final java.lang.String DATA_TYPE_CURRENCY
```
    Constant for currency type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_DATE
```
static final java.lang.String DATA_TYPE_DATE
```
    Constant for date field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_DOUBLE
```
static final java.lang.String DATA_TYPE_DOUBLE
```
    Constant for numeric field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_INTEGER
```
static final java.lang.String DATA_TYPE_INTEGER
```
    Constant for integer field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_MEMO
```
static final java.lang.String DATA_TYPE_MEMO
```
    Constant for memo field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_NUMBER
```
static final java.lang.String DATA_TYPE_NUMBER
```
    Constant for numeric field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_TEXT
```
static final java.lang.String DATA_TYPE_TEXT
```
    Constant for text field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_TIME
```
static final java.lang.String DATA_TYPE_TIME
```
    Constant for time field/parameter type.
    
    See Also:
    
    Constant Field Values
  - DATA_TYPE_VERBATIM
```
static final java.lang.String DATA_TYPE_VERBATIM
```
    Constant for unformatted (verbatim) parameter type.
    
    See Also:
    
    Constant Field Values
  - DB_ROLE_DATA
```
static final java.lang.String DB_ROLE_DATA
```
    Constant for "data" database role. Can be used as an argument for setDatabaseRole() method. The "data" is the default database role that should be used to access most ARCHIBUS data.
  - DB_ROLE_SCHEMA
```
static final java.lang.String DB_ROLE_SCHEMA
```
    Constant for "schema" database role. Can be used as an argument for setDatabaseRole() method.
  - DB_ROLE_SECURITY
```
static final java.lang.String DB_ROLE_SECURITY
```
    Constant for "security" database role. Can be used as an argument for setDatabaseRole() method.
  - ROLE_MAIN
```
static final java.lang.String ROLE_MAIN
```
    Constant for "main" table role. Can be used as a "role" argument for addTable() method.
    
    See Also:
    
    Constant Field Values
  - ROLE_STANDARD
```
static final java.lang.String ROLE_STANDARD
```
    Constant for "standard" table role. Can be used as a "role" argument for addTable() method.
    
    See Also:
    
    Constant Field Values
  - SORT_ASC
```
static final java.lang.String SORT_ASC
```
    Constant for ascending sort order. Can be used as an "order" argument for addSort() method.
    
    See Also:
    
    Constant Field Values
  - SORT_DESC
```
static final java.lang.String SORT_DESC
```
    Constant for descending sort order. Can be used as an "order" argument for addSort() method.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addCalculatedField
```
DataSource addCalculatedField(com.archibus.datasource.VirtualFieldDef calculatedField)
```
    Adds a calculated field to the data source. Calculated fields are virtual fields that are based on SQL expressions.
    
    Parameters:
    
    calculatedField - The calculated field definition.
    
    Returns:
    
    This data source.
  - addField
```
DataSource addField(java.lang.String name)
```
    Adds specified main table field to the data source query.
    
    Parameters:
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addField
```
DataSource addField(java.lang.String table,
                    java.lang.String name)
```
    Adds specified field to the data source query.
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addField
```
DataSource addField(java.lang.String table,
                    java.lang.String[] names)
```
    Adds specified fields to the data source query.
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    names - Array of field names.
    
    Returns:
    
    This data source.
  - addField
```
DataSource addField(java.lang.String[] names)
```
    Adds specified main table fields to the data source query.
    
    Parameters:
    
    names - Array of field names.
    
    Returns:
    
    This data source.
  - addParameter
```
DataSource addParameter(java.lang.String name,
                        double value,
                        java.lang.String dataType)
```
  - addParameter
```
DataSource addParameter(java.lang.String name,
                        int value,
                        java.lang.String dataType)
```
  - addParameter
```
DataSource addParameter(java.lang.String name,
                        java.lang.Object value,
                        java.lang.String dataType)
```
  - addParameter
```
DataSource addParameter(java.lang.String name,
                        java.lang.String value,
                        java.lang.String dataType)
```
    Adds a query parameter.
    
    Parameters:
    
    name - Parameter name.
    
    value - Parameter value.
    
    dataType - Parameter type, used to parse the value into an object.
    
    Returns:
    
    This data source.
  - addQuery
```
DataSource addQuery(java.lang.String sql)
```
    Adds a generic dialect SQL query to the data source.
    
    Parameters:
    
    sql - The SQL.
    
    Returns:
    
    This data source.
  - addQuery
```
DataSource addQuery(java.lang.String sql,
                    java.lang.String dialect)
```
    Adds an SQL query to the data source.
    
    Parameters:
    
    sql - The SQL.
    
    dialect - SQL dialect: generic|sybase|oracle|sqlserver
    
    Returns:
    
    This data source.
  - addRestriction
```
DataSource addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction r)
```
    Adds a restriction.
    
    Parameters:
    
    r - Restriction.
    
    Returns:
    
    This data source.
  - addRestriction
```
DataSource addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction.Clause c)
```
    Adds a restriction clause.
    
    Parameters:
    
    c - Restriction clause.
    
    Returns:
    
    This data source.
  - addSort
```
DataSource addSort(java.lang.String name)
```
    Adds a main table sort field to the data source query, in SORT_ASC mode.
    
    Parameters:
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addSort
```
DataSource addSort(java.lang.String table,
                   java.lang.String name)
```
    Adds a sort field to the data source query, in SORT_ASC mode.
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addSort
```
DataSource addSort(java.lang.String table,
                   java.lang.String name,
                   java.lang.String order)
```
    Adds a sort field to the data source query.
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    order - Sort order: asc|desc.
    
    Returns:
    
    This data source.
  - addTable
```
DataSource addTable(java.lang.String name)
```
    Adds specified table to the data source query, as a "main" table.
    
    Parameters:
    
    name - Table name, i.e. "wr".
    
    Returns:
    
    This data source.
  - addTable
```
DataSource addTable(java.lang.String name,
                    java.lang.String role)
```
    Adds specified table in specified role to the data source query.
    
    Parameters:
    
    name - Table name, i.e. "wr".
    
    role - Table role, i.e. "standard".
    
    Returns:
    
    This data source.
  - addVirtualField
```
DataSource addVirtualField(java.lang.String table,
                           java.lang.String name,
                           java.lang.String dataType)
```
    Adds a virtual field to the data source. Virtual fields are used to provide formatting for calculated columns in custom SQL queries.
    
    Parameters:
    
    table - Table name, matching the SQL query table alias.
    
    name - Virtual field name, matching the calculated SQL column name.
    
    dataType - Virtual field type: text|number|date|time|memo|verbatim.
    
    Returns:
    
    This data source.
  - addVirtualField
```
DataSource addVirtualField(java.lang.String table,
                           java.lang.String name,
                           java.lang.String dataType,
                           int size,
                           int decimals)
```
    Adds a virtual field to the data source. Virtual fields are used to provide formatting for calculated columns in custom SQL queries.
    
    Parameters:
    
    table - Table name, matching the SQL query table alias.
    
    name - Virtual field name, matching the calculated SQL column name.
    
    dataType - Virtual field type: text|number|date|time|memo|verbatim.
    
    size - For numeric field, the number of integer digits.
    
    decimals - For numeric field, the number of fraction digits.
    
    Returns:
    
    This data source.
  - addVirtualField
```
DataSource addVirtualField(java.lang.String table,
                           java.lang.String name,
                           java.lang.String dataType,
                           int size,
                           int decimals,
                           java.lang.String title)
```
  - clearRestrictions
```
DataSource clearRestrictions()
```
    Clears all restrictions defined in AXVW.
    
    Returns:
    
    This data source.
  - commit
```
void commit()
```
    Commit current database transaction.
  - createNewRecord
```
com.archibus.datasource.data.DataRecord createNewRecord()
```
    Creates new DataRecord with default values for all fields defined in the data source.
    
    Returns:
    
    DataRecord
  - createPrimaryKeyIds
```
org.json.JSONArray createPrimaryKeyIds()
```
    Creates primary key column definitions in JSON format from the data source. For example, data record = {wr.wr_id='9500001', wr_requestor='afm'}, result = ['wr.wr_id'].
    
    Returns:
    
    JSONArray containing ID attributes of the primary key values in data records.
  - createRecord
```
com.archibus.datasource.data.DataRecord createRecord()
```
    Creates new DataRecord with default values for all fields defined in the data source.
    
    Returns:
    
    DataRecord
  - createRecordFromContext
```
com.archibus.datasource.data.DataRecord createRecordFromContext()
```
    Creates new DataRecord with default values for all fields defined in the data source. Copies all input values set in the EventHandlerContext to the record.
    
    Returns:
    
    DataRecord
  - createVirtualViewField
```
com.archibus.db.ViewField.Immutable createVirtualViewField(java.lang.String table,
                                                           java.lang.String name,
                                                           java.lang.String fieldJavaType,
                                                           java.text.NumberFormat format)
```
    Creates and returns virtual view field for specified Java field type.
    
    Parameters:
    
    table - Virtual field table name.
    
    name - Virtual field name.
    
    fieldJavaType - Java class name, such as "java.lang.Double" or "java.sql.Date".
    
    format - NumberFormat instance for numeric felds, or null for other fields.
    
    Returns:
    
    ViewField.Immutable.
  - deleteRecord
```
void deleteRecord(com.archibus.datasource.data.DataRecord record)
```
    Deletes existing record.
    
    Parameters:
    
    record - DataRecord containing record to be deleted.
  - deleteRecord
```
void deleteRecord(java.util.Map fieldValues)
```
    Deletes record specified by field values.
    
    Parameters:
    
    fieldValues - map containing record values.
  - enableIdLookup
```
void enableIdLookup(boolean value)
```
    Sets the idLookupEnabled property.
    
    Parameters:
    
    value - The property value.
  - executeUpdate
```
void executeUpdate()
```
    Executes SQL update query, set using addQuery().
  - executeUpdateRequired
```
void executeUpdateRequired()
```
    Executes SQL update query, set using addQuery(). If no records were updated, throws an exception.
  - findField
```
com.archibus.db.ViewField.Immutable findField(java.lang.String fullName)
```
    Returns a field definition for specified full field name.
    
    Parameters:
    
    fullName - Full field name, i.e. "wr.status".
    
    Returns:
    
    ViewField.Immutable
  - findVirtualField
```
com.archibus.db.ViewField.Immutable findVirtualField(java.lang.String fullName)
```
    Loop through the virtual fields for the current data source and Returns a field definition for specified full field name.
    
    Parameters:
    
    fullName - Full field name, i.e. "wr.status".
    
    Returns:
    
    ViewField.Immutable
  - formatJoin
```
java.lang.String formatJoin(java.lang.String fieldName)
```
    Generates a join between the table of specified field and its validating table, if any.
    Example: for rm.dp_id produce (LEFT OUTER JOIN dp ON rm.dp_id = dp.dp_id)
    
    Parameters:
    
    fieldName - The field name.
    
    Returns:
    
    The join SQL.
  - formatSqlForPersistentRestrictions
```
java.lang.String formatSqlForPersistentRestrictions()
```
    Generates SQL WHERE clause from VPAs for current user/role applicable to the main table in current DataSource.
    
    Returns:
    
    generated SQL WHERE clause, or empty string if there is no DataSource or there are no applicable VPAs.
  - formatSqlForPersistentRestrictionsForTable
```
java.lang.String formatSqlForPersistentRestrictionsForTable(java.lang.String tableName)
```
    Generates SQL WHERE clause from VPAs for current user/role applicable to the specified table in current DataSource.
    
    Parameters:
    
    tableName - of main or standard table in the current DataSource for which to generate SQL.
    
    Returns:
    
    generated SQL WHERE clause, or empty string if there is no DataSource or there are no applicable VPAs.
  - formatSqlForPersistentRestrictionsForTableAndRole
```
java.lang.String formatSqlForPersistentRestrictionsForTableAndRole(java.lang.String tableName,
                                                                   java.lang.String roleName)
```
    Generates SQL WHERE clause from VPAs applicable to the specified table in current DataSource. The role will be used by "forVpaGroups" VPAs (if current user/role has such restrictions), to generate "EXISTS (SELECT ...)" to restrict table using mapping tables; otherwise it will be ignored.
    
    Parameters:
    
    tableName - of main or standard table in the current DataSource for which to generate SQL.
    
    roleName - of user role. Can be null.
    
    Returns:
    
    generated SQL WHERE clause, or empty string if there is no DataSource or there are no applicable VPAs.
  - formatSqlForRestriction
```
java.lang.String formatSqlForRestriction(java.lang.String id)
```
    Generates SQL WHERE clause from a named restriction.
    
    Parameters:
    
    id - The restriction ID.
    
    Returns:
    
    generated SQL WHERE clause, or empty string if the restriction is disabled.
  - formatSqlQuery
```
java.lang.String formatSqlQuery(java.lang.String restriction,
                                boolean doNotWrap)
```
    Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
    
    Parameters:
    
    restriction - String containing client-side restriction in JSON format.
    
    doNotWrap - True if the data source should not wrap the custom SQL query.
    
    Returns:
    
    The SQL.
  - formatSqlQuery
```
java.lang.String formatSqlQuery(java.lang.String restriction,
                                java.util.List sortValues,
                                java.util.List filterValues,
                                boolean isOrderbyAllowed,
                                boolean doNotWrap)
```
    Formats and returns an SQL query based on: previously added tables, fields, sort fields, restrictions, and custom SQL queries; current user VPA restriction; client-side restriction.
    
    Parameters:
    
    restriction - String containing client-side restriction in JSON format.
    
    sortValues - The list sort values.
    
    filterValues - The list of filter values.
    
    isOrderbyAllowed - True if the data source can apply the ORDER BY clause.
    
    doNotWrap - True if the data source should not wrap the custom SQL query.
    
    Returns:
    
    The SQL.
  - formatSqlQueryForField
```
java.lang.String formatSqlQueryForField(java.lang.String restriction,
                                        java.util.List sortValues,
                                        java.util.List filterValues,
                                        boolean isOrderbyAllowed,
                                        boolean doNotWrap,
                                        java.lang.String fieldName)
```
    Formats and returns an SQL query that selects a single specified field.
    
    Parameters:
    
    restriction - String containing client-side restriction in JSON format.
    
    sortValues - The list sort values.
    
    filterValues - The list of filter values.
    
    isOrderbyAllowed - True if the data source can apply the ORDER BY clause.
    
    doNotWrap - True if the data source should not wrap the custom SQL query.
    
    fieldName - The field name.
    
    Returns:
    
    The SQL.
  - getAllFields
```
java.util.List<com.archibus.db.ViewField.Immutable> getAllFields()
```
    Returns a list of field definitions for visible and/or virtual fields.
    
    Returns:
    
    The field definitions.
  - getAllRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getAllRecords()
```
    Retrieves records that contains values for all fields defined in the data source, using no record limit. WARNING: when record limit is not set, retrieving all records can take extremely long time and even lead to out-of-memory errors on very large database tables.
    
    Returns:
    
    list of records.
  - getCalculatedFieldDef
```
com.archibus.datasource.VirtualFieldDef getCalculatedFieldDef(java.lang.String tableName,
                                                              java.lang.String fieldName)
```
    Returns specified virtual field definition.
    
    Parameters:
    
    tableName - The table name.
    
    fieldName - The field name.
    
    Returns:
    
    The field definition.
  - getDataSourceDef
```
com.archibus.model.view.datasource.AbstractDataSourceDef getDataSourceDef()
```
    Returns:
    
    the dataSourceDef
  - getDbFieldsForNewRecord
```
java.util.List<EventHandlerBase.DbField> getDbFieldsForNewRecord()
```
    Returns a list of DB field definitions for default new record.
    
    Returns:
    
    The field definitions.
  - getDbFieldsForPrimaryKeysAsMap
```
java.util.Map<java.lang.String,EventHandlerBase.DbField> getDbFieldsForPrimaryKeysAsMap()
```
    Returns a map of DB field definitions for key fields.
    
    Returns:
    
    The field definitions.
  - getDbFieldsForVisibleFields
```
java.util.List<EventHandlerBase.DbField> getDbFieldsForVisibleFields()
```
    Returns a list of DB field definitions for all fields defined in the data source. The list order matches the SELECT clause of the data source SQL query. If the SQL query is generated, the list includes all fields defined in the dataSource element. If the SQL query is custom, the list included all fields defined in the panel element.
    
    Returns:
    
    The field definitions.
  - getDefaultRecord
```
com.archibus.datasource.data.DataRecord getDefaultRecord(java.lang.String restriction)
```
    Returns DataRecord with default values for all fields defined in the data source.
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    Returns:
    
    DataRecord
  - getFieldNames
```
java.util.List<java.lang.String> getFieldNames()
```
    Returns:
    
    the fieldNames
  - getId
```
java.lang.String getId()
```
    Returns:
    
    the id
  - getMainTableDef
```
com.archibus.schema.TableDef.ThreadSafe getMainTableDef()
```
    Returns main table definition.
    
    Returns:
    
    The table definition.
  - getMainTableName
```
java.lang.String getMainTableName()
```
    Returns main table name.
    
    Returns:
    
    The table name.
  - getParameters
```
java.util.Map<java.lang.String,DataSourceImpl.Parameter> getParameters()
```
    Returns all parameters.
    
    Returns:
    
    Parameter values.
  - getPrimaryKeyFieldNamesForTable
```
java.util.List<java.lang.String> getPrimaryKeyFieldNamesForTable(java.lang.String tableName)
```
    Returns a collection of the main table's primary key field names.
    
    Parameters:
    
    tableName - The table name.
    
    Returns:
    
    The field names.
  - getPrimaryKeyFields
```
java.util.List<com.archibus.db.ViewField.Immutable> getPrimaryKeyFields()
```
    Returns a list of primary key fields. The list includes all primary key fields of the main table.
    
    Returns:
    
    list of primary key fields.
  - getQueries
```
com.archibus.datasource.SqlExpressions getQueries()
```
    Returns all custom queries.
    
    Returns:
    
    The queries.
  - getRecord
```
com.archibus.datasource.data.DataRecord getRecord()
```
    Retrieves a single record that contains values for all fields defined in the data source.
    
    Returns:
    
    DataRecord, or null if no record can be found.
  - getRecord
```
com.archibus.datasource.data.DataRecord getRecord(java.lang.String restriction)
```
    Retrieves a single record that contains values for all fields defined in the data source.
    
    Parameters:
    
    restriction - The client-side restriction.
    
    Returns:
    
    DataRecord, or null if no record can be found.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords()
```
    Retrieves records that contains values for all fields defined in the data source. If a record limit for DataSource has not been set using setMaxRecords() method, applies global record limit defined in afm-config.xml.
    
    Returns:
    
    list of records.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords(com.archibus.model.view.datasource.AbstractRestrictionDef restriction)
```
    Retrieves records that contains values for all fields defined in the data source. If a record limit for DataSource has not been set using setMaxRecords() method, applies global record limit defined in afm-config.xml.
    
    Parameters:
    
    restriction - The restriction definition.
    
    Returns:
    
    list of records.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions)
```
    Retrieves records that contains values for all fields defined in the data source. If a record limit for DataSource has not been set using setMaxRecords() method, applies global record limit defined in afm-config.xml.
    
    Parameters:
    
    restrictions - The list of restrictions defined using the DB package types.
    
    Returns:
    
    list of records.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions,
                                                                   int maxRecords)
```
    Retrieves records that contains values for all fields defined in the data source.
    
    Parameters:
    
    restrictions - The list of restrictions defined using the DB package types.
    
    maxRecords - The record limit, or 0 if there is no record limit.
    
    Returns:
    
    list of records.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.lang.String restriction)
```
    Retrieves records that contains values for all fields defined in the data source. If a record limit for DataSource has not been set using setMaxRecords() method, applies global record limit defined in afm-config.xml.
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    Returns:
    
    list of records.
  - getRecords
```
java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.lang.String restriction,
                                                                   int maxRecords)
```
    Retrieves records that contains values for all fields defined in the data source.
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    maxRecords - The record limit, or 0 if there is no record limit.
    
    Returns:
    
    list of records.
  - getRestrictions
```
java.util.List<com.archibus.datasource.restriction.Restrictions.Restriction> getRestrictions()
```
    Returns a list of restriction definitions.
    
    Returns:
    
    list of restriction definitions.
  - getRestrictionValues
```
java.util.Map<java.lang.String,java.lang.Object> getRestrictionValues()
```
    Returns restrictions values passed in from the client.
    
    Returns:
    
    The values.
  - getSortFields
```
java.util.List<DataSourceImpl.SortField> getSortFields()
```
    Returns a list of sort field definitions.
    
    Returns:
    
    list of restriction definitions.
  - getTablesAndRoles
```
java.util.List<DataSourceImpl.TableAndRole> getTablesAndRoles()
```
    Returns a list of table names and roles.
    
    Returns:
    
    list of table names and roles.
  - getTitle
```
java.lang.String getTitle()
```
    Returns:
    
    the title
  - getViewName
```
java.lang.String getViewName()
```
    Returns:
    
    the view name
  - getVirtualFieldDef
```
com.archibus.datasource.VirtualFieldDef getVirtualFieldDef(java.lang.String tableName,
                                                           java.lang.String fieldName)
```
    Returns specified virtual field definition.
    
    Parameters:
    
    tableName - The table name.
    
    fieldName - The field name.
    
    Returns:
    
    The field definition.
  - getVirtualFields
```
java.util.List<com.archibus.db.ViewField.Immutable> getVirtualFields()
```
    Returns a list of virtual fields.
    
    Returns:
    
    list of primary key fields.
  - getVisibleFields
```
java.util.List<com.archibus.db.ViewField.Immutable> getVisibleFields()
```
    Returns a list of visible fields. The list includes all fields that are specified by calling addField().
    
    Returns:
    
    list of visible fields.
  - getVisibleFieldsByName
```
java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable> getVisibleFieldsByName()
```
    Returns a map of visible fields. The list includes all fields that are specified by calling addField().
    
    Returns:
    
    map of visible fields.
  - hasCustomQuery
```
boolean hasCustomQuery()
```
    Returns true if the data source uses custom SQL qeury.
    
    Returns:
    
    The result.
  - hasMoreRecords
```
boolean hasMoreRecords()
```
    Returns true if preceding call to retrieveRecords() did not read all records due to record limit.
    
    Returns:
    
    The result.
  - hasVirtualFields
```
boolean hasVirtualFields()
```
    Returns true if the data source defines virtual fields for custom SQL qeury.
    
    Returns:
    
    The result.
  - isDistinct
```
boolean isDistinct()
```
    Gets the distinct attribute
    
    Returns:
    
    The distinct value
  - isIdLookupEnabled
```
boolean isIdLookupEnabled()
```
    Whether this data source can use lookup fields.
    
    Returns:
    
    True if the data source can use lookup fields.
  - isOracle
```
boolean isOracle()
```
    Returns true if the current database server is Oracle.
    
    Returns:
    
    The result.
  - isSqlServer
```
boolean isSqlServer()
```
    Returns true if the current database server is SQL Server.
    
    Returns:
    
    The result.
  - isSybase
```
boolean isSybase()
```
    Returns true if the current database server is Sybase.
    
    Returns:
    
    The result.
  - parseClientRestrictions
```
java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> parseClientRestrictions(java.lang.String restrictionString)
```
    Creates parsed or SQL restriction from the string input parameter.
    
    Parameters:
    
    restrictionString - can contain: - single XML record; - single JSON record; - multiple JSON records; - literal SQL expression;
    
    Returns:
    
    The list of restrictions.
  - queryRecords
```
void queryRecords(DataSource.RecordHandler recordHandler)
```
    Executes SQL query and calls specified callback for each retrieved record.
    
    Parameters:
    
    recordHandler - The callback.
  - queryRecords
```
void queryRecords(java.lang.String restriction,
                  DataSource.RecordHandler recordHandler)
```
    Executes SQL query and calls specified callback for each retrieved record.
    
    Parameters:
    
    restriction - The client-side restriction.
    
    recordHandler - The callback.
  - rollback
```
void rollback()
```
    Rollback current database transaction.
  - saveRecord
```
com.archibus.datasource.data.DataRecord saveRecord(com.archibus.datasource.data.DataRecord record)
```
    Saves new or updates existing record. Returns the last saved record if the table PK is autonumbered.
    
    Parameters:
    
    record - DataRecord containing record values to be saved and old values.
    
    Returns:
    
    DataRecord containing saved field values, or null if the table PK is not autonumbered.
  - setApplyVpaRestrictions
```
DataSource setApplyVpaRestrictions(boolean applyVpaRestrictions)
```
    The applyVpaRestrictions property enables or disables VPA restrictions for all read queries, whether the Data Source uses custom SQL or not. By default, this property is true.
    
    Parameters:
    
    applyVpaRestrictions - The property value.
    
    Returns:
    
    This data source.
  - setAutoCommit
```
DataSource setAutoCommit(boolean autoCommit)
```
    Sets the autoCommit flag. If autoCommit is set, the DataSource commits changes after each data access call. Otherwise the WFR container commits changes after the WFR execution is finished.
    
    Parameters:
    
    autoCommit - The flag value.
    
    Returns:
    
    This data source.
  - setContext
```
DataSource setContext()
```
    Sets data source context and initializes context-dependent data source state based on the current thread context. Can be called from event handlers, or any Java code that is called by event handlers, including scheduled rules and long-running jobs.
    
    Returns:
    
    This data source.
  - setContext
```
DataSource setContext(com.archibus.config.ContextCacheable.Immutable context)
```
    Sets data source context and initializes context-dependent data source state. This method is for use in presentation-layer classes (JSP tag handlers). In event handlers use the setContext(EventHandlerContext) method.
    
    Parameters:
    
    context - Web Central context object, typically a UserSession.
    
    Returns:
    
    This data source.
  - setContext
```
DataSource setContext(EventHandlerContext eventHandlerContext)
```
    Sets data source context and initializes context-dependent data source state.
    
    Parameters:
    
    eventHandlerContext - WFR event handler context.
    
    Returns:
    
    This data source.
  - setDatabaseRole
```
DataSource setDatabaseRole(java.lang.String role)
```
    Set database role for this DataSource to access. If this method is not called, the "data" role is used. This is appropriate for most workflow rules.
    
    Parameters:
    
    role - The database role.
    
    Returns:
    
    This data source.
  - setDataSourceDef
```
void setDataSourceDef(com.archibus.model.view.datasource.AbstractDataSourceDef dataSourceDef)
```
    Parameters:
    
    dataSourceDef - the dataSourceDef to set
  - setDistinct
```
DataSource setDistinct(boolean isDistinct)
```
    Sets isDistinct flag.
    
    Parameters:
    
    isDistinct - The flag value.
    
    Returns:
    
    This data source.
  - setId
```
void setId(java.lang.String id)
```
    Parameters:
    
    id - the id to set
  - setMaxRecords
```
DataSource setMaxRecords(int maxRecords)
```
    Sets the max number of records that can be retrieved by consequent calls to retrieveRecords().
    
    Parameters:
    
    maxRecords - Positive number, or 0 to read all available records without limit.
    
    Returns:
    
    This data source.
  - setParameter
```
DataSource setParameter(java.lang.String name,
                        java.lang.Object value)
```
    Sets new value for specified parameter.
    
    Parameters:
    
    name - Parameter name.
    
    value - Parameter value.
    
    Returns:
    
    This data source.
  - setTitle
```
void setTitle(java.lang.String title)
```
    Parameters:
    
    title - the title to set
  - setUseHierarchicalSecurityRestriction
```
DataSource setUseHierarchicalSecurityRestriction(boolean useHierarchicalSecurityRestriction)
```
    Sets the useHierarchicalSecurityRestriction property.
    
    Parameters:
    
    useHierarchicalSecurityRestriction - The property value.
    
    Returns:
    
    This data source.
  - setViewName
```
void setViewName(java.lang.String viewName)
```
    Parameters:
    
    viewName - the view name to set
  - updateRecord
```
void updateRecord(com.archibus.datasource.data.DataRecord record)
```
    Updates existing record specified by the primary key values.
    
    Parameters:
    
    record - DataRecord containing record values to be saved.

Interface DataSource

Nested Class Summary

Field Summary

Method Summary

Field Detail

DATA_TYPE_BOOLEAN

DATA_TYPE_CURRENCY

DATA_TYPE_DATE

DATA_TYPE_DOUBLE

DATA_TYPE_INTEGER

DATA_TYPE_MEMO

DATA_TYPE_NUMBER

DATA_TYPE_TEXT

DATA_TYPE_TIME

DATA_TYPE_VERBATIM

DB_ROLE_DATA

DB_ROLE_SCHEMA

DB_ROLE_SECURITY

ROLE_MAIN

ROLE_STANDARD

SORT_ASC

SORT_DESC

Method Detail

addCalculatedField

addField

addField

addField

addField

addParameter

addParameter

addParameter

addParameter

addQuery

addQuery

addRestriction

addRestriction

addSort

addSort

addSort

addTable

addTable

addVirtualField

addVirtualField

addVirtualField

clearRestrictions

commit

createNewRecord

createPrimaryKeyIds

createRecord

createRecordFromContext

createVirtualViewField

deleteRecord

deleteRecord

enableIdLookup

executeUpdate

executeUpdateRequired

findField

findVirtualField

formatJoin

formatSqlForPersistentRestrictions

formatSqlForPersistentRestrictionsForTable

formatSqlForPersistentRestrictionsForTableAndRole

formatSqlForRestriction

formatSqlQuery

formatSqlQuery

formatSqlQueryForField

getAllFields

getAllRecords

getCalculatedFieldDef

getDataSourceDef

getDbFieldsForNewRecord

getDbFieldsForPrimaryKeysAsMap

getDbFieldsForVisibleFields

getDefaultRecord

getFieldNames

getId

getMainTableDef

getMainTableName

getParameters

getPrimaryKeyFieldNamesForTable