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

java.lang.Object
- com.archibus.datasource.DataSourceImpl

All Implemented Interfaces:

DataSource

Direct Known Subclasses:

DataSourceGroupingImpl, ObjectDataSourceImpl
```
public class DataSourceImpl
extends java.lang.Object
implements 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	Class and Description
`static class`	`DataSourceImpl.Parameter` Defines an SQL query parameter.
`static class`	`DataSourceImpl.SortField` Represents a sort field.
`static class`	`DataSourceImpl.TableAndRole` Represents database table and its role in the data source.

Nested classes/interfaces inherited from interface com.archibus.datasource.DataSource
DataSource.RecordHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`applyVpaRestrictions` The applyVpaRestrictions property enables or disables VPA restrictions for all read queries, whether the Data Source uses custom SQL or not.
`protected org.apache.log4j.Category`	`basicRulesLog` Optional logger that is passed in the EventHandlerContext when basic rules are executed.
`protected java.util.List<com.archibus.datasource.VirtualFieldDef>`	`calculatedFieldDefs` List of calculated field definitions.
`static java.lang.String`	`CASCADE_HANDLER` Spring bean name.
`protected com.archibus.datasource.CascadeHandler`	`cascadeHandler` Optional: cascading update/delete handler.
`protected com.archibus.datasource.SqlExpressions`	`customSqlQueries` Map contains custom SQL queries for database dialects.
`protected com.archibus.config.Database.Immutable`	`database` Database instance
`protected java.lang.String`	`databaseRole` Database role.
`protected com.archibus.model.view.datasource.AbstractDataSourceDef`	`dataSourceDef` If the data source has been loaded from the view file, this property refers to the data source definition.
`protected boolean`	`doNotWrapCustomSql` If true, custom SQL queries are not wrapped inside SELECT * FROM (customQuery) AS tableName
`protected EventHandlerContext`	`eventHandlerContext` EventHandlerContext, not null if the DataSource is used by a workflow rule.
`protected com.archibus.utility.expr.ExpressionContext`	`expressionContext` Context for evaluating expressions.
`protected java.util.List<java.lang.String>`	`fieldNames` Full names of all fields, for main and standard tables.
`protected java.util.List<java.lang.String>`	`fieldNamesForNewRecord` List of field names that have default values for new record.
`protected boolean`	`hasMoreRecords` Whether preceding call to retrieveRecords() did not read all records due to record limit.
`protected boolean`	`isAutoCommit` If autoCommit is set, the DataSource commits changes after each data access call.
`protected boolean`	`isDistinct` True if generated SQL query should include SELECT DISTINCT.
`protected java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable>`	`keyFieldsByFullName` Map that contains PK and FK fields keyed by their full names.
`protected java.util.Locale`	`locale` Current user locale
`protected org.apache.log4j.Category`	`log` Logger for this class and subclasses.
`protected com.archibus.schema.TableDef.ThreadSafe`	`mainTableDef` Main table definition.
`protected java.lang.String`	`mainTableName` Name of the main table
`protected int`	`maxRecords` How many records can be retrieved via retrieveRecords().
`protected java.util.Map<java.lang.String,DataSourceImpl.Parameter>`	`parameters` Map of named parameter definitions.
`protected boolean`	`parametersChanged` This flag is set to true by the setParameter() method to indicate that SQL restrictions and SQL queries have to be re-evaluated before next data access call.
`protected com.archibus.config.ContextCacheable.Immutable`	`parentContext` Web Central context.
`protected java.util.List<com.archibus.db.RestrictionBaseImpl>`	`persistentRestrictions` AXVW and VPA restrictions.
`protected java.util.ArrayList<com.archibus.db.ViewField.Immutable>`	`primaryKeyFields` List of primary key field definitions.
`protected com.archibus.config.Project.Immutable`	`project` Project instance
`protected com.archibus.datasource.DataSourceQueryImpl`	`query` SQL query implementation for the main table.
`protected java.util.List<com.archibus.datasource.restriction.Restrictions.Restriction>`	`restrictions` List of restrictions defined in the view.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`restrictionValues` Map contains names and values of fields from the applied client-side restriction.
`static java.lang.String`	`SCRIPT_INJECTION_HANDLER` Spring bean name.
`protected com.archibus.datasource.SqlInjectionHandler`	`scriptInjectionHandler` Optional: Script injection handler.
`protected java.util.List<DataSourceImpl.SortField>`	`sortFields` List of sort order fields.
`static java.lang.String`	`SQL_INJECTION_HANDLER` Spring bean name.
`protected com.archibus.datasource.SqlInjectionHandler`	`sqlInjectionHandler` Optional: SQL injection handler.
`protected java.util.List<com.archibus.datasource.DataSourceQueryImpl>`	`standardQueries` SQL query implementations for standard tables.
`protected java.util.List<DataSourceImpl.TableAndRole>`	`tablesAndRoles` List containing names and roles of all tables.
`protected boolean`	`useHierarchicalSecurityRestriction` True if generated SQL query should include per-user hierarchical security restriction.
`protected java.util.List<com.archibus.datasource.VirtualFieldDef>`	`virtualFieldDefs` List of virtual field definitions.
`protected java.util.List<com.archibus.db.ViewField.Immutable>`	`virtualFields` List of virtual fields.
`protected java.util.ArrayList<com.archibus.db.ViewField.Immutable>`	`visibleFields` List of visible field definitions.
`protected java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable>`	`visibleFieldsByName` Map that contains visible fields keyed by their full names.

Fields inherited from interface com.archibus.datasource.DataSource
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

Constructor Summary

Constructors
Constructor and Description

DataSourceImpl()
Constructor.

DataSourceImpl(DataSourceImpl anotherDataSource)
Copy constructor.

Constructors
Constructor and Description
`DataSourceImpl()` Constructor.
`DataSourceImpl(DataSourceImpl anotherDataSource)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`void`	`addPersistentRestrictions(java.util.List restrictionElements)` Adds view and/or VPA restrictions to the data source.
`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.
`void`	`addRestrictionsToQuery()` Adds all (view and VPA) restrictions to the query def.
`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)`
`protected void`	`checkAutoCommit()` If autoCommit is set, commit pending database changes.
`void`	`checkSetContext()` If the parent Context has not been set, finds and sets it.
`DataSource`	`clearRestrictions()` Clears all restrictions defined in AXVW.
`void`	`commit()` Commit current database transaction.
`protected void`	`copyProperties(DataSourceImpl copy)` Copies configuration properties into another DataSource.
`DataSource`	`createCopy()` Creates a copy of this data source.
`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.
`java.lang.String`	`createSqlForLastAddedPK(java.util.Map fieldValues)` Generates SQL query that can be used to retrieve the primary key of the last saved record.
`com.archibus.db.ViewField.Immutable`	`createVirtualField(java.lang.String fieldName, boolean localized)` Creates virtual field definition.
`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.
`java.lang.String`	`evaluateExpressions(java.lang.String value, boolean literalizeUserName)` Evaluates #{...} expressions and returns resolved string.
`protected void`	`evaluateSqlExpressions()` Evaluates expressions in custom SQL queries, calculated fields, and restrictions.
`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`	`findKeyField(java.lang.String fullName)` Returns a field definition for specified full field name.
`DataSourceImpl.TableAndRole`	`findTable(java.lang.String tableName)` Returns the table and role for specific table, or null if the table is not defined in the data source.
`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.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions, java.util.List sortValues, java.util.List filterValues, boolean isOrderbyAllowed, boolean doNotWrap)` Formats and returns an SQL query based on: view tables and fields; view restrictions; view SQL queries; current user VPA restriction; additional restrictions.
`java.lang.String`	`formatSqlQuery(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions, java.util.List sortValues, java.util.List filterValues, boolean isOrderbyAllowed, boolean doNotWrap, java.lang.String fieldName)` Formats and returns an SQL query.
`java.lang.String`	`formatSqlQuery(java.lang.String restrictionString, 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 restrictionString, 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 restrictionString, 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 table, java.lang.String name)` Returns specified virtual field definition.
`com.archibus.config.ContextCacheable.Immutable`	`getContext()` Returns parent context.
`java.lang.String`	`getDatabaseRole()` Returns database role.
`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.List<EventHandlerBase.DbField>`	`getDbFieldsForPrimaryKeys()` Returns the list of fields for primary keys of the main table.
`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.
`static java.util.List<java.lang.String>`	`getPKeyFieldNamesForTable(java.lang.String tableName, com.archibus.config.Project.Immutable project)` Returns a canonical list of primary key field names for a specified table.
`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.
`protected com.archibus.datasource.DataSourceQueryImpl`	`getQueryInstance(com.archibus.config.Database.Immutable database)` Returns new query instance.
`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 restrictionDef)` 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.
`com.archibus.model.view.datasource.ClauseDef.RelativeOperation`	`getRestrictionRelativeOperation()` Returns relative operation used to combine multiple client restrictions.
`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 table, java.lang.String name)` 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.
`DataSource`	`setDoNotWrapCustomSql(boolean value)` Sets the doNotWrapCustomSql property.
`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`	`setRestrictionRelativeOperation(com.archibus.model.view.datasource.ClauseDef.RelativeOperation restrictionRelativeOperation)` Sets relative operation used to combine multiple client restrictions.
`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.
`protected boolean`	`useCascadeHandler()`
`boolean`	`useVirtualFields()` Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CASCADE_HANDLER
```
public static final java.lang.String CASCADE_HANDLER
```
    Spring bean name.
    
    See Also:
    
    Constant Field Values
  - SQL_INJECTION_HANDLER
```
public static final java.lang.String SQL_INJECTION_HANDLER
```
    Spring bean name.
    
    See Also:
    
    Constant Field Values
  - SCRIPT_INJECTION_HANDLER
```
public static final java.lang.String SCRIPT_INJECTION_HANDLER
```
    Spring bean name.
    
    See Also:
    
    Constant Field Values
  - databaseRole
```
protected java.lang.String databaseRole
```
    Database role.
  - mainTableName
```
protected java.lang.String mainTableName
```
    Name of the main table
  - tablesAndRoles
```
protected final java.util.List<DataSourceImpl.TableAndRole> tablesAndRoles
```
    List containing names and roles of all tables.
  - fieldNames
```
protected final java.util.List<java.lang.String> fieldNames
```
    Full names of all fields, for main and standard tables.
  - sortFields
```
protected final java.util.List<DataSourceImpl.SortField> sortFields
```
    List of sort order fields.
  - virtualFieldDefs
```
protected final java.util.List<com.archibus.datasource.VirtualFieldDef> virtualFieldDefs
```
    List of virtual field definitions.
  - calculatedFieldDefs
```
protected final java.util.List<com.archibus.datasource.VirtualFieldDef> calculatedFieldDefs
```
    List of calculated field definitions.
  - customSqlQueries
```
protected com.archibus.datasource.SqlExpressions customSqlQueries
```
    Map contains custom SQL queries for database dialects. It does not have to contain all dialects.
  - isDistinct
```
protected boolean isDistinct
```
    True if generated SQL query should include SELECT DISTINCT.
  - useHierarchicalSecurityRestriction
```
protected boolean useHierarchicalSecurityRestriction
```
    True if generated SQL query should include per-user hierarchical security restriction.
  - isAutoCommit
```
protected boolean isAutoCommit
```
    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
```
protected final java.util.Map<java.lang.String,DataSourceImpl.Parameter> parameters
```
    Map of named parameter definitions.
  - restrictions
```
protected final java.util.List<com.archibus.datasource.restriction.Restrictions.Restriction> restrictions
```
    List of restrictions defined in the view.
  - maxRecords
```
protected int maxRecords
```
    How many records can be retrieved via retrieveRecords(). 0 by default, but will be set by setContext(EventHandlerContext).
  - doNotWrapCustomSql
```
protected boolean doNotWrapCustomSql
```
    If true, custom SQL queries are not wrapped inside SELECT * FROM (customQuery) AS tableName
  - applyVpaRestrictions
```
protected 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.
  - dataSourceDef
```
protected com.archibus.model.view.datasource.AbstractDataSourceDef dataSourceDef
```
    If the data source has been loaded from the view file, this property refers to the data source definition.
  - hasMoreRecords
```
protected boolean hasMoreRecords
```
    Whether preceding call to retrieveRecords() did not read all records due to record limit.
  - mainTableDef
```
protected com.archibus.schema.TableDef.ThreadSafe mainTableDef
```
    Main table definition.
  - visibleFields
```
protected java.util.ArrayList<com.archibus.db.ViewField.Immutable> visibleFields
```
    List of visible field definitions. List
  - visibleFieldsByName
```
protected final java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable> visibleFieldsByName
```
    Map that contains visible fields keyed by their full names. Map
  - virtualFields
```
protected final java.util.List<com.archibus.db.ViewField.Immutable> virtualFields
```
    List of virtual fields. List
  - primaryKeyFields
```
protected java.util.ArrayList<com.archibus.db.ViewField.Immutable> primaryKeyFields
```
    List of primary key field definitions. List
  - keyFieldsByFullName
```
protected final java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable> keyFieldsByFullName
```
    Map that contains PK and FK fields keyed by their full names. Map
  - restrictionValues
```
protected java.util.Map<java.lang.String,java.lang.Object> restrictionValues
```
    Map contains names and values of fields from the applied client-side restriction.
  - query
```
protected com.archibus.datasource.DataSourceQueryImpl query
```
    SQL query implementation for the main table. Used to generate the data source SQL query.
  - standardQueries
```
protected java.util.List<com.archibus.datasource.DataSourceQueryImpl> standardQueries
```
    SQL query implementations for standard tables. Used to generate VPA restrictions for standard tables.
  - parentContext
```
protected com.archibus.config.ContextCacheable.Immutable parentContext
```
    Web Central context.
  - eventHandlerContext
```
protected EventHandlerContext eventHandlerContext
```
    EventHandlerContext, not null if the DataSource is used by a workflow rule.
  - expressionContext
```
protected com.archibus.utility.expr.ExpressionContext expressionContext
```
    Context for evaluating expressions. Set with the parent context.
  - project
```
protected com.archibus.config.Project.Immutable project
```
    Project instance
  - database
```
protected com.archibus.config.Database.Immutable database
```
    Database instance
  - locale
```
protected java.util.Locale locale
```
    Current user locale
  - persistentRestrictions
```
protected final java.util.List<com.archibus.db.RestrictionBaseImpl> persistentRestrictions
```
    AXVW and VPA restrictions.
  - fieldNamesForNewRecord
```
protected java.util.List<java.lang.String> fieldNamesForNewRecord
```
    List of field names that have default values for new record.
  - parametersChanged
```
protected boolean parametersChanged
```
    This flag is set to true by the setParameter() method to indicate that SQL restrictions and SQL queries have to be re-evaluated before next data access call.
  - log
```
protected org.apache.log4j.Category log
```
    Logger for this class and subclasses.
  - basicRulesLog
```
protected org.apache.log4j.Category basicRulesLog
```
    Optional logger that is passed in the EventHandlerContext when basic rules are executed.
  - cascadeHandler
```
protected com.archibus.datasource.CascadeHandler cascadeHandler
```
    Optional: cascading update/delete handler.
  - sqlInjectionHandler
```
protected com.archibus.datasource.SqlInjectionHandler sqlInjectionHandler
```
    Optional: SQL injection handler.
  - scriptInjectionHandler
```
protected com.archibus.datasource.SqlInjectionHandler scriptInjectionHandler
```
    Optional: Script injection handler.
- Constructor Detail
  - DataSourceImpl
```
public DataSourceImpl()
```
    Constructor.
  - DataSourceImpl
```
public DataSourceImpl(DataSourceImpl anotherDataSource)
```
    Copy constructor. Only copies configuration properties, not per-request properties.
    
    Parameters:
    
    anotherDataSource - The data source to copy.
- Method Detail
  - createCopy
```
public DataSource createCopy()
```
    Creates a copy of this data source. Only copies configuration properties, not per-request properties.
    
    Returns:
    
    The copy.
  - getDataSourceDef
```
public com.archibus.model.view.datasource.AbstractDataSourceDef getDataSourceDef()
```
    Specified by:
    
    getDataSourceDef in interface DataSource
    
    Returns:
    
    the dataSourceDef
  - setDataSourceDef
```
public void setDataSourceDef(com.archibus.model.view.datasource.AbstractDataSourceDef dataSourceDef)
```
    Specified by:
    
    setDataSourceDef in interface DataSource
    
    Parameters:
    
    dataSourceDef - the dataSourceDef to set
  - getTitle
```
public java.lang.String getTitle()
```
    Specified by:
    
    getTitle in interface DataSource
    
    Returns:
    
    the title
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Specified by:
    
    setTitle in interface DataSource
    
    Parameters:
    
    title - the title to set
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface DataSource
    
    Returns:
    
    the id
  - setId
```
public void setId(java.lang.String id)
```
    Specified by:
    
    setId in interface DataSource
    
    Parameters:
    
    id - the id to set
  - getViewName
```
public java.lang.String getViewName()
```
    Specified by:
    
    getViewName in interface DataSource
    
    Returns:
    
    the view name
  - setViewName
```
public void setViewName(java.lang.String viewName)
```
    Specified by:
    
    setViewName in interface DataSource
    
    Parameters:
    
    viewName - the view name to set
  - setDatabaseRole
```
public DataSource setDatabaseRole(java.lang.String role)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    setDatabaseRole in interface DataSource
    
    Parameters:
    
    role - The database role.
    
    Returns:
    
    This data source.
  - addTable
```
public DataSource addTable(java.lang.String name)
```
    Description copied from interface: DataSource
    
    Adds specified table to the data source query, as a "main" table.
    
    Specified by:
    
    addTable in interface DataSource
    
    Parameters:
    
    name - Table name, i.e. "wr".
    
    Returns:
    
    This data source.
  - addTable
```
public DataSource addTable(java.lang.String name,
                           java.lang.String role)
```
    Description copied from interface: DataSource
    
    Adds specified table in specified role to the data source query.
    
    Specified by:
    
    addTable in interface DataSource
    
    Parameters:
    
    name - Table name, i.e. "wr".
    
    role - Table role, i.e. "standard".
    
    Returns:
    
    This data source.
  - addField
```
public DataSource addField(java.lang.String name)
```
    Description copied from interface: DataSource
    
    Adds specified main table field to the data source query.
    
    Specified by:
    
    addField in interface DataSource
    
    Parameters:
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addField
```
public DataSource addField(java.lang.String[] names)
```
    Description copied from interface: DataSource
    
    Adds specified main table fields to the data source query.
    
    Specified by:
    
    addField in interface DataSource
    
    Parameters:
    
    names - Array of field names.
    
    Returns:
    
    This data source.
  - addField
```
public DataSource addField(java.lang.String table,
                           java.lang.String name)
```
    Description copied from interface: DataSource
    
    Adds specified field to the data source query.
    
    Specified by:
    
    addField in interface DataSource
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addField
```
public DataSource addField(java.lang.String table,
                           java.lang.String[] names)
```
    Description copied from interface: DataSource
    
    Adds specified fields to the data source query.
    
    Specified by:
    
    addField in interface DataSource
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    names - Array of field names.
    
    Returns:
    
    This data source.
  - getFieldNames
```
public java.util.List<java.lang.String> getFieldNames()
```
    Specified by:
    
    getFieldNames in interface DataSource
    
    Returns:
    
    the fieldNames
  - addSort
```
public DataSource addSort(java.lang.String name)
```
    Description copied from interface: DataSource
    
    Adds a main table sort field to the data source query, in SORT_ASC mode.
    
    Specified by:
    
    addSort in interface DataSource
    
    Parameters:
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addSort
```
public DataSource addSort(java.lang.String table,
                          java.lang.String name)
```
    Description copied from interface: DataSource
    
    Adds a sort field to the data source query, in SORT_ASC mode.
    
    Specified by:
    
    addSort in interface DataSource
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    Returns:
    
    This data source.
  - addSort
```
public DataSource addSort(java.lang.String table,
                          java.lang.String name,
                          java.lang.String order)
```
    Description copied from interface: DataSource
    
    Adds a sort field to the data source query.
    
    Specified by:
    
    addSort in interface DataSource
    
    Parameters:
    
    table - Table name, i.e. "wr".
    
    name - Field name, i.e. "status".
    
    order - Sort order: asc|desc.
    
    Returns:
    
    This data source.
  - addVirtualField
```
public DataSource addVirtualField(java.lang.String table,
                                  java.lang.String name,
                                  java.lang.String dataType)
```
    Description copied from interface: DataSource
    
    Adds a virtual field to the data source. Virtual fields are used to provide formatting for calculated columns in custom SQL queries.
    
    Specified by:
    
    addVirtualField in interface DataSource
    
    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
```
public DataSource addVirtualField(java.lang.String table,
                                  java.lang.String name,
                                  java.lang.String dataType,
                                  int size,
                                  int decimals)
```
    Description copied from interface: DataSource
    
    Adds a virtual field to the data source. Virtual fields are used to provide formatting for calculated columns in custom SQL queries.
    
    Specified by:
    
    addVirtualField in interface DataSource
    
    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
```
public DataSource addVirtualField(java.lang.String table,
                                  java.lang.String name,
                                  java.lang.String dataType,
                                  int size,
                                  int decimals,
                                  java.lang.String title)
```
    Specified by:
    
    addVirtualField in interface DataSource
  - addCalculatedField
```
public DataSource addCalculatedField(com.archibus.datasource.VirtualFieldDef calculatedField)
```
    Description copied from interface: DataSource
    
    Adds a calculated field to the data source. Calculated fields are virtual fields that are based on SQL expressions.
    
    Specified by:
    
    addCalculatedField in interface DataSource
    
    Parameters:
    
    calculatedField - The calculated field definition.
    
    Returns:
    
    This data source.
  - addQuery
```
public DataSource addQuery(java.lang.String sql)
```
    Description copied from interface: DataSource
    
    Adds a generic dialect SQL query to the data source.
    
    Specified by:
    
    addQuery in interface DataSource
    
    Parameters:
    
    sql - The SQL.
    
    Returns:
    
    This data source.
  - addQuery
```
public DataSource addQuery(java.lang.String sql,
                           java.lang.String dialect)
```
    Description copied from interface: DataSource
    
    Adds an SQL query to the data source.
    
    Specified by:
    
    addQuery in interface DataSource
    
    Parameters:
    
    sql - The SQL.
    
    dialect - SQL dialect: generic|sybase|oracle|sqlserver
    
    Returns:
    
    This data source.
  - getQueries
```
public com.archibus.datasource.SqlExpressions getQueries()
```
    Description copied from interface: DataSource
    
    Returns all custom queries.
    
    Specified by:
    
    getQueries in interface DataSource
    
    Returns:
    
    The queries.
  - addParameter
```
public DataSource addParameter(java.lang.String name,
                               java.lang.String value,
                               java.lang.String dataType)
```
    Description copied from interface: DataSource
    
    Adds a query parameter.
    
    Specified by:
    
    addParameter in interface DataSource
    
    Parameters:
    
    name - Parameter name.
    
    value - Parameter value.
    
    dataType - Parameter type, used to parse the value into an object.
    
    Returns:
    
    This data source.
  - addParameter
```
public DataSource addParameter(java.lang.String name,
                               java.lang.Object value,
                               java.lang.String dataType)
```
    Specified by:
    
    addParameter in interface DataSource
  - addParameter
```
public DataSource addParameter(java.lang.String name,
                               int value,
                               java.lang.String dataType)
```
    Specified by:
    
    addParameter in interface DataSource
  - addParameter
```
public DataSource addParameter(java.lang.String name,
                               double value,
                               java.lang.String dataType)
```
    Specified by:
    
    addParameter in interface DataSource
  - getParameters
```
public java.util.Map<java.lang.String,DataSourceImpl.Parameter> getParameters()
```
    Description copied from interface: DataSource
    
    Returns all parameters.
    
    Specified by:
    
    getParameters in interface DataSource
    
    Returns:
    
    Parameter values.
  - addRestriction
```
public DataSource addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction r)
```
    Description copied from interface: DataSource
    
    Adds a restriction.
    
    Specified by:
    
    addRestriction in interface DataSource
    
    Parameters:
    
    r - Restriction.
    
    Returns:
    
    This data source.
  - addRestriction
```
public DataSource addRestriction(com.archibus.datasource.restriction.Restrictions.Restriction.Clause c)
```
    Description copied from interface: DataSource
    
    Adds a restriction clause.
    
    Specified by:
    
    addRestriction in interface DataSource
    
    Parameters:
    
    c - Restriction clause.
    
    Returns:
    
    This data source.
  - clearRestrictions
```
public DataSource clearRestrictions()
```
    Description copied from interface: DataSource
    
    Clears all restrictions defined in AXVW.
    
    Specified by:
    
    clearRestrictions in interface DataSource
    
    Returns:
    
    This data source.
  - setDistinct
```
public DataSource setDistinct(boolean isDistinct)
```
    Description copied from interface: DataSource
    
    Sets isDistinct flag.
    
    Specified by:
    
    setDistinct in interface DataSource
    
    Parameters:
    
    isDistinct - The flag value.
    
    Returns:
    
    This data source.
  - isDistinct
```
public boolean isDistinct()
```
    Description copied from interface: DataSource
    
    Gets the distinct attribute
    
    Specified by:
    
    isDistinct in interface DataSource
    
    Returns:
    
    The distinct value
  - setUseHierarchicalSecurityRestriction
```
public DataSource setUseHierarchicalSecurityRestriction(boolean useHierarchicalSecurityRestriction)
```
    Description copied from interface: DataSource
    
    Sets the useHierarchicalSecurityRestriction property.
    
    Specified by:
    
    setUseHierarchicalSecurityRestriction in interface DataSource
    
    Parameters:
    
    useHierarchicalSecurityRestriction - The property value.
    
    Returns:
    
    This data source.
  - setAutoCommit
```
public DataSource setAutoCommit(boolean autoCommit)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    setAutoCommit in interface DataSource
    
    Parameters:
    
    autoCommit - The flag value.
    
    Returns:
    
    This data source.
  - setDoNotWrapCustomSql
```
public DataSource setDoNotWrapCustomSql(boolean value)
```
    Sets the doNotWrapCustomSql property. When set to true, custom SQL queries are not wrapped inside SELECT * FROM (customQuery) AS tableName
    
    Parameters:
    
    value - The property value.
    
    Returns:
    
    This data source.
  - setApplyVpaRestrictions
```
public DataSource setApplyVpaRestrictions(boolean applyVpaRestrictions)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    setApplyVpaRestrictions in interface DataSource
    
    Parameters:
    
    applyVpaRestrictions - The property value.
    
    Returns:
    
    This data source.
  - setParameter
```
public DataSource setParameter(java.lang.String name,
                               java.lang.Object value)
```
    Description copied from interface: DataSource
    
    Sets new value for specified parameter.
    
    Specified by:
    
    setParameter in interface DataSource
    
    Parameters:
    
    name - Parameter name.
    
    value - Parameter value.
    
    Returns:
    
    This data source.
  - setContext
```
public DataSource setContext(com.archibus.config.ContextCacheable.Immutable context)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    setContext in interface DataSource
    
    Parameters:
    
    context - Web Central context object, typically a UserSession.
    
    Returns:
    
    This data source.
  - setContext
```
public DataSource setContext(EventHandlerContext eventHandlerContext)
```
    Sets data source context and initializes context-dependent data source state.
    
    Specified by:
    
    setContext in interface DataSource
    
    Parameters:
    
    eventHandlerContext - Web Central WFR event handler context.
    
    Returns:
    
    This data source.
  - setContext
```
public 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.
    
    Specified by:
    
    setContext in interface DataSource
    
    Returns:
    
    This data source.
  - getContext
```
public com.archibus.config.ContextCacheable.Immutable getContext()
```
    Returns parent context.
    
    Returns:
    
    The context.
  - copyProperties
```
protected void copyProperties(DataSourceImpl copy)
```
    Copies configuration properties into another DataSource.
    
    Parameters:
    
    copy - The data source to copy properties to.
  - getDatabaseRole
```
public java.lang.String getDatabaseRole()
```
    Returns database role.
    
    Returns:
    
    The role.
  - getTablesAndRoles
```
public java.util.List<DataSourceImpl.TableAndRole> getTablesAndRoles()
```
    Description copied from interface: DataSource
    
    Returns a list of table names and roles.
    
    Specified by:
    
    getTablesAndRoles in interface DataSource
    
    Returns:
    
    list of table names and roles.
  - getVisibleFields
```
public java.util.List<com.archibus.db.ViewField.Immutable> getVisibleFields()
```
    Description copied from interface: DataSource
    
    Returns a list of visible fields. The list includes all fields that are specified by calling addField().
    
    Specified by:
    
    getVisibleFields in interface DataSource
    
    Returns:
    
    list of visible fields.
  - getVirtualFields
```
public java.util.List<com.archibus.db.ViewField.Immutable> getVirtualFields()
```
    Description copied from interface: DataSource
    
    Returns a list of virtual fields.
    
    Specified by:
    
    getVirtualFields in interface DataSource
    
    Returns:
    
    list of primary key fields.
  - getVisibleFieldsByName
```
public java.util.Map<java.lang.String,com.archibus.db.ViewField.Immutable> getVisibleFieldsByName()
```
    Description copied from interface: DataSource
    
    Returns a map of visible fields. The list includes all fields that are specified by calling addField().
    
    Specified by:
    
    getVisibleFieldsByName in interface DataSource
    
    Returns:
    
    map of visible fields.
  - getRestrictionValues
```
public java.util.Map<java.lang.String,java.lang.Object> getRestrictionValues()
```
    Description copied from interface: DataSource
    
    Returns restrictions values passed in from the client.
    
    Specified by:
    
    getRestrictionValues in interface DataSource
    
    Returns:
    
    The values.
  - getRestrictions
```
public java.util.List<com.archibus.datasource.restriction.Restrictions.Restriction> getRestrictions()
```
    Description copied from interface: DataSource
    
    Returns a list of restriction definitions.
    
    Specified by:
    
    getRestrictions in interface DataSource
    
    Returns:
    
    list of restriction definitions.
  - getSortFields
```
public java.util.List<DataSourceImpl.SortField> getSortFields()
```
    Description copied from interface: DataSource
    
    Returns a list of sort field definitions.
    
    Specified by:
    
    getSortFields in interface DataSource
    
    Returns:
    
    list of restriction definitions.
  - getMainTableName
```
public java.lang.String getMainTableName()
```
    Description copied from interface: DataSource
    
    Returns main table name.
    
    Specified by:
    
    getMainTableName in interface DataSource
    
    Returns:
    
    The table name.
  - findTable
```
public DataSourceImpl.TableAndRole findTable(java.lang.String tableName)
```
    Returns the table and role for specific table, or null if the table is not defined in the data source.
    
    Parameters:
    
    tableName - The table name.
    
    Returns:
    
    The table and role.
  - getPrimaryKeyFields
```
public java.util.List<com.archibus.db.ViewField.Immutable> getPrimaryKeyFields()
```
    Description copied from interface: DataSource
    
    Returns a list of primary key fields. The list includes all primary key fields of the main table.
    
    Specified by:
    
    getPrimaryKeyFields in interface DataSource
    
    Returns:
    
    list of primary key fields.
  - getPrimaryKeyFieldNamesForTable
```
public java.util.List<java.lang.String> getPrimaryKeyFieldNamesForTable(java.lang.String tableName)
```
    Description copied from interface: DataSource
    
    Returns a collection of the main table's primary key field names.
    
    Specified by:
    
    getPrimaryKeyFieldNamesForTable in interface DataSource
    
    Parameters:
    
    tableName - The table name.
    
    Returns:
    
    The field names.
  - getPKeyFieldNamesForTable
```
public static java.util.List<java.lang.String> getPKeyFieldNamesForTable(java.lang.String tableName,
                                                                         com.archibus.config.Project.Immutable project)
```
    Returns a canonical list of primary key field names for a specified table. Static version of above method
    
    Parameters:
    
    tableName - The table name.
    
    project - The project.
    
    Returns:
    
    Primary key values.
  - findField
```
public com.archibus.db.ViewField.Immutable findField(java.lang.String fullName)
```
    Description copied from interface: DataSource
    
    Returns a field definition for specified full field name.
    
    Specified by:
    
    findField in interface DataSource
    
    Parameters:
    
    fullName - Full field name, i.e. "wr.status".
    
    Returns:
    
    ViewField.Immutable
  - findVirtualField
```
public com.archibus.db.ViewField.Immutable findVirtualField(java.lang.String fullName)
```
    Description copied from interface: DataSource
    
    Loop through the virtual fields for the current data source and Returns a field definition for specified full field name.
    
    Specified by:
    
    findVirtualField in interface DataSource
    
    Parameters:
    
    fullName - Full field name, i.e. "wr.status".
    
    Returns:
    
    ViewField.Immutable
  - findKeyField
```
public com.archibus.db.ViewField.Immutable findKeyField(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
  - getMainTableDef
```
public com.archibus.schema.TableDef.ThreadSafe getMainTableDef()
```
    Description copied from interface: DataSource
    
    Returns main table definition.
    
    Specified by:
    
    getMainTableDef in interface DataSource
    
    Returns:
    
    The table definition.
  - hasCustomQuery
```
public boolean hasCustomQuery()
```
    Description copied from interface: DataSource
    
    Returns true if the data source uses custom SQL qeury.
    
    Specified by:
    
    hasCustomQuery in interface DataSource
    
    Returns:
    
    The result.
  - hasVirtualFields
```
public boolean hasVirtualFields()
```
    Description copied from interface: DataSource
    
    Returns true if the data source defines virtual fields for custom SQL qeury.
    
    Specified by:
    
    hasVirtualFields in interface DataSource
    
    Returns:
    
    The result.
  - isSqlServer
```
public boolean isSqlServer()
```
    Description copied from interface: DataSource
    
    Returns true if the current database server is SQL Server.
    
    Specified by:
    
    isSqlServer in interface DataSource
    
    Returns:
    
    The result.
  - isOracle
```
public boolean isOracle()
```
    Description copied from interface: DataSource
    
    Returns true if the current database server is Oracle.
    
    Specified by:
    
    isOracle in interface DataSource
    
    Returns:
    
    The result.
  - isSybase
```
public boolean isSybase()
```
    Description copied from interface: DataSource
    
    Returns true if the current database server is Sybase.
    
    Specified by:
    
    isSybase in interface DataSource
    
    Returns:
    
    The result.
  - useVirtualFields
```
public boolean useVirtualFields()
```
    Returns true if virtual fields must be used instead of visible fields to handle JDBC resultset.
    
    Returns:
    
    The result.
  - getDbFieldsForVisibleFields
```
public 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.
    
    Specified by:
    
    getDbFieldsForVisibleFields in interface DataSource
    
    Returns:
    
    The list of fields.
  - getAllFields
```
public java.util.List<com.archibus.db.ViewField.Immutable> getAllFields()
```
    Returns a list of field definitions for visible and/or virtual fields.
    
    Specified by:
    
    getAllFields in interface DataSource
    
    Returns:
    
    The field definitions.
  - getVirtualFieldDef
```
public com.archibus.datasource.VirtualFieldDef getVirtualFieldDef(java.lang.String table,
                                                                  java.lang.String name)
```
    Description copied from interface: DataSource
    
    Returns specified virtual field definition.
    
    Specified by:
    
    getVirtualFieldDef in interface DataSource
    
    Parameters:
    
    table - The table name.
    
    name - The field name.
    
    Returns:
    
    The field definition.
  - getCalculatedFieldDef
```
public com.archibus.datasource.VirtualFieldDef getCalculatedFieldDef(java.lang.String table,
                                                                     java.lang.String name)
```
    Description copied from interface: DataSource
    
    Returns specified virtual field definition.
    
    Specified by:
    
    getCalculatedFieldDef in interface DataSource
    
    Parameters:
    
    table - The table name.
    
    name - The field name.
    
    Returns:
    
    The field definition.
  - getDbFieldsForNewRecord
```
public java.util.List<EventHandlerBase.DbField> getDbFieldsForNewRecord()
```
    Description copied from interface: DataSource
    
    Returns a list of DB field definitions for default new record.
    
    Specified by:
    
    getDbFieldsForNewRecord in interface DataSource
    
    Returns:
    
    The field definitions.
  - getDbFieldsForPrimaryKeys
```
public java.util.List<EventHandlerBase.DbField> getDbFieldsForPrimaryKeys()
```
    Returns the list of fields for primary keys of the main table.
    
    Returns:
    
    The list of fields.
  - getDbFieldsForPrimaryKeysAsMap
```
public java.util.Map<java.lang.String,EventHandlerBase.DbField> getDbFieldsForPrimaryKeysAsMap()
```
    Returns a map of DB field definitions for key fields.
    
    Specified by:
    
    getDbFieldsForPrimaryKeysAsMap in interface DataSource
    
    Returns:
    
    The fields.
  - createPrimaryKeyIds
```
public 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'].
    
    Specified by:
    
    createPrimaryKeyIds in interface DataSource
    
    Returns:
    
    JSONArray containing ID attributes of the primary key values in data records.
  - createVirtualViewField
```
public com.archibus.db.ViewField.Immutable createVirtualViewField(java.lang.String table,
                                                                  java.lang.String name,
                                                                  java.lang.String fieldJavaType,
                                                                  java.text.NumberFormat format)
```
    Description copied from interface: DataSource
    
    Creates and returns virtual view field for specified Java field type.
    
    Specified by:
    
    createVirtualViewField in interface DataSource
    
    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.
  - createVirtualField
```
public com.archibus.db.ViewField.Immutable createVirtualField(java.lang.String fieldName,
                                                              boolean localized)
```
    Creates virtual field definition.
    
    Parameters:
    
    fieldName - The field name.
    
    localized - Whether field values should be localized.
    
    Returns:
    
    The field definition.
  - formatSqlQuery
```
public java.lang.String formatSqlQuery(java.lang.String restrictionString,
                                       boolean doNotWrap)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    formatSqlQuery in interface DataSource
    
    Parameters:
    
    restrictionString - 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
```
public java.lang.String formatSqlQuery(java.lang.String restrictionString,
                                       java.util.List sortValues,
                                       java.util.List filterValues,
                                       boolean isOrderbyAllowed,
                                       boolean doNotWrap)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    formatSqlQuery in interface DataSource
    
    Parameters:
    
    restrictionString - 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
```
public java.lang.String formatSqlQueryForField(java.lang.String restrictionString,
                                               java.util.List sortValues,
                                               java.util.List filterValues,
                                               boolean isOrderbyAllowed,
                                               boolean doNotWrap,
                                               java.lang.String fieldName)
```
    Description copied from interface: DataSource
    
    Formats and returns an SQL query that selects a single specified field.
    
    Specified by:
    
    formatSqlQueryForField in interface DataSource
    
    Parameters:
    
    restrictionString - 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.
  - formatSqlQuery
```
public java.lang.String formatSqlQuery(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions,
                                       java.util.List sortValues,
                                       java.util.List filterValues,
                                       boolean isOrderbyAllowed,
                                       boolean doNotWrap)
```
    Formats and returns an SQL query based on:
    - view tables and fields;
    - view restrictions;
    - view SQL queries;
    - current user VPA restriction;
    - additional restrictions.
    Parameters:
    
    restrictions - The list of restriction.
    
    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.
  - formatSqlQuery
```
public java.lang.String formatSqlQuery(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions,
                                       java.util.List sortValues,
                                       java.util.List filterValues,
                                       boolean isOrderbyAllowed,
                                       boolean doNotWrap,
                                       java.lang.String fieldName)
```
    Formats and returns an SQL query.
    
    Parameters:
    
    restrictions - The list of restriction.
    
    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.
  - formatJoin
```
public java.lang.String formatJoin(java.lang.String fieldName)
```
    Generates a join between the table of specified field and its validating table, if any.
    Example: rm.dp_id ==> (LEFT OUTER JOIN dp ON rm.dp_id = dp.dp_id)
    
    Specified by:
    
    formatJoin in interface DataSource
    
    Parameters:
    
    fieldName - The field name.
    
    Returns:
    
    The join SQL.
  - formatSqlForRestriction
```
public java.lang.String formatSqlForRestriction(java.lang.String id)
```
    Description copied from interface: DataSource
    
    Generates SQL WHERE clause from a named restriction.
    
    Specified by:
    
    formatSqlForRestriction in interface DataSource
    
    Parameters:
    
    id - The restriction ID.
    
    Returns:
    
    generated SQL WHERE clause, or empty string if the restriction is disabled.
  - formatSqlForPersistentRestrictions
```
public java.lang.String formatSqlForPersistentRestrictions()
```
    Description copied from interface: DataSource
    
    Generates SQL WHERE clause from VPAs for current user/role applicable to the main table in current DataSource.
    
    Specified by:
    
    formatSqlForPersistentRestrictions in interface DataSource
    
    Returns:
    
    generated SQL WHERE clause, or empty string if there is no DataSource or there are no applicable VPAs.
  - formatSqlForPersistentRestrictionsForTable
```
public java.lang.String formatSqlForPersistentRestrictionsForTable(java.lang.String tableName)
```
    Description copied from interface: DataSource
    
    Generates SQL WHERE clause from VPAs for current user/role applicable to the specified table in current DataSource.
    
    Specified by:
    
    formatSqlForPersistentRestrictionsForTable in interface 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
```
public java.lang.String formatSqlForPersistentRestrictionsForTableAndRole(java.lang.String tableName,
                                                                          java.lang.String roleName)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    formatSqlForPersistentRestrictionsForTableAndRole in interface DataSource
    
    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.
  - evaluateSqlExpressions
```
protected void evaluateSqlExpressions()
```
    Evaluates expressions in custom SQL queries, calculated fields, and restrictions.
  - getQueryInstance
```
protected com.archibus.datasource.DataSourceQueryImpl getQueryInstance(com.archibus.config.Database.Immutable database)
```
    Returns new query instance.
    
    Parameters:
    
    database -
    
    Returns:
  - getRestrictionRelativeOperation
```
public com.archibus.model.view.datasource.ClauseDef.RelativeOperation getRestrictionRelativeOperation()
```
    Returns relative operation used to combine multiple client restrictions.
    
    Returns:
    
    The operation.
  - setRestrictionRelativeOperation
```
public void setRestrictionRelativeOperation(com.archibus.model.view.datasource.ClauseDef.RelativeOperation restrictionRelativeOperation)
```
    Sets relative operation used to combine multiple client restrictions.
    
    Parameters:
    
    restrictionRelativeOperation - The operation.
  - isIdLookupEnabled
```
public boolean isIdLookupEnabled()
```
    Description copied from interface: DataSource
    
    Whether this data source can use lookup fields.
    
    Specified by:
    
    isIdLookupEnabled in interface DataSource
    
    Returns:
    
    True if the data source can use lookup fields.
  - enableIdLookup
```
public void enableIdLookup(boolean value)
```
    Sets the idLookupEnabled property.
    
    Specified by:
    
    enableIdLookup in interface DataSource
    
    Parameters:
    
    value - The property value.
  - addPersistentRestrictions
```
public void addPersistentRestrictions(java.util.List restrictionElements)
```
    Adds view and/or VPA restrictions to the data source.
    
    Parameters:
    
    restrictionElements - The list of XML restrictions.
  - addRestrictionsToQuery
```
public void addRestrictionsToQuery()
```
    Adds all (view and VPA) restrictions to the query def.
  - parseClientRestrictions
```
public java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> parseClientRestrictions(java.lang.String restrictionString)
```
    Creates parsed or SQL restriction from the string input parameter.
    
    Specified by:
    
    parseClientRestrictions in interface DataSource
    
    Parameters:
    
    restrictionString - can contain: - single XML record; - single JSON record; - multiple JSON records; - literal SQL expression;
    
    Returns:
    
    The restrictions.
  - evaluateExpressions
```
public java.lang.String evaluateExpressions(java.lang.String value,
                                            boolean literalizeUserName)
```
    Evaluates #{...} expressions and returns resolved string.
    
    Parameters:
    
    value - The value to evaluate.
    
    literalizeUserName - The user name that can be used in expressions.
    
    Returns:
    
    The evaluated value.
  - getRecord
```
public com.archibus.datasource.data.DataRecord getRecord()
                                                  throws com.archibus.utility.ExceptionBase
```
    Description copied from interface: DataSource
    
    Retrieves a single record that contains values for all fields defined in the data source.
    
    Specified by:
    
    getRecord in interface DataSource
    
    Returns:
    
    DataRecord, or null if no record can be found.
    
    Throws:
    
    com.archibus.utility.ExceptionBase
  - getRecord
```
public com.archibus.datasource.data.DataRecord getRecord(java.lang.String restriction)
                                                  throws com.archibus.utility.ExceptionBase
```
    Description copied from interface: DataSource
    
    Retrieves a single record that contains values for all fields defined in the data source.
    
    Specified by:
    
    getRecord in interface DataSource
    
    Parameters:
    
    restriction - The client-side restriction.
    
    Returns:
    
    DataRecord, or null if no record can be found.
    
    Throws:
    
    com.archibus.utility.ExceptionBase
  - getRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords()
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    getRecords in interface DataSource
    
    Returns:
    
    list of records.
  - getRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.lang.String restriction)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    getRecords in interface DataSource
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    Returns:
    
    list of records.
  - getRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    getRecords in interface DataSource
    
    Parameters:
    
    restrictions - The list of restrictions defined using the DB package types.
    
    Returns:
    
    list of records.
  - getRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.lang.String restriction,
                                                                          int maxRecords)
```
    Description copied from interface: DataSource
    
    Retrieves records that contains values for all fields defined in the data source.
    
    Specified by:
    
    getRecords in interface DataSource
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    maxRecords - The record limit, or 0 if there is no record limit.
    
    Returns:
    
    list of records.
  - getRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords(java.util.List<com.archibus.db.RestrictionSqlBase.Immutable> restrictions,
                                                                          int maxRecords)
```
    Description copied from interface: DataSource
    
    Retrieves records that contains values for all fields defined in the data source.
    
    Specified by:
    
    getRecords in interface DataSource
    
    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
```
public java.util.List<com.archibus.datasource.data.DataRecord> getRecords(com.archibus.model.view.datasource.AbstractRestrictionDef restrictionDef)
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    getRecords in interface DataSource
    
    Parameters:
    
    restrictionDef - The restriction definition.
    
    Returns:
    
    list of records.
  - getAllRecords
```
public java.util.List<com.archibus.datasource.data.DataRecord> getAllRecords()
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    getAllRecords in interface DataSource
    
    Returns:
    
    list of records.
  - queryRecords
```
public void queryRecords(DataSource.RecordHandler recordHandler)
```
    Description copied from interface: DataSource
    
    Executes SQL query and calls specified callback for each retrieved record.
    
    Specified by:
    
    queryRecords in interface DataSource
    
    Parameters:
    
    recordHandler - The callback.
  - queryRecords
```
public void queryRecords(java.lang.String restriction,
                         DataSource.RecordHandler recordHandler)
```
    Description copied from interface: DataSource
    
    Executes SQL query and calls specified callback for each retrieved record.
    
    Specified by:
    
    queryRecords in interface DataSource
    
    Parameters:
    
    restriction - The client-side restriction.
    
    recordHandler - The callback.
  - saveRecord
```
public com.archibus.datasource.data.DataRecord saveRecord(com.archibus.datasource.data.DataRecord record)
```
    Description copied from interface: DataSource
    
    Saves new or updates existing record. Returns the last saved record if the table PK is autonumbered.
    
    Specified by:
    
    saveRecord in interface DataSource
    
    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.
  - updateRecord
```
public void updateRecord(com.archibus.datasource.data.DataRecord record)
```
    Description copied from interface: DataSource
    
    Updates existing record specified by the primary key values.
    
    Specified by:
    
    updateRecord in interface DataSource
    
    Parameters:
    
    record - DataRecord containing record values to be saved.
  - deleteRecord
```
public void deleteRecord(com.archibus.datasource.data.DataRecord record)
```
    Description copied from interface: DataSource
    
    Deletes existing record.
    
    Specified by:
    
    deleteRecord in interface DataSource
    
    Parameters:
    
    record - DataRecord containing record to be deleted.
  - deleteRecord
```
public void deleteRecord(java.util.Map fieldValues)
                  throws com.archibus.utility.ExceptionBase
```
    Description copied from interface: DataSource
    
    Deletes record specified by field values.
    
    Specified by:
    
    deleteRecord in interface DataSource
    
    Parameters:
    
    fieldValues - map containing record values.
    
    Throws:
    
    com.archibus.utility.ExceptionBase
  - createRecord
```
public com.archibus.datasource.data.DataRecord createRecord()
```
    Description copied from interface: DataSource
    
    Creates new DataRecord with default values for all fields defined in the data source.
    
    Specified by:
    
    createRecord in interface DataSource
    
    Returns:
    
    DataRecord
  - createNewRecord
```
public com.archibus.datasource.data.DataRecord createNewRecord()
```
    Description copied from interface: DataSource
    
    Creates new DataRecord with default values for all fields defined in the data source.
    
    Specified by:
    
    createNewRecord in interface DataSource
    
    Returns:
    
    DataRecord
  - createRecordFromContext
```
public com.archibus.datasource.data.DataRecord createRecordFromContext()
```
    Description copied from interface: DataSource
    
    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.
    
    Specified by:
    
    createRecordFromContext in interface DataSource
    
    Returns:
    
    DataRecord
  - getDefaultRecord
```
public com.archibus.datasource.data.DataRecord getDefaultRecord(java.lang.String restriction)
```
    Description copied from interface: DataSource
    
    Returns DataRecord with default values for all fields defined in the data source.
    
    Specified by:
    
    getDefaultRecord in interface DataSource
    
    Parameters:
    
    restriction - Client-supplied restriction string, or null.
    
    Returns:
    
    DataRecord
  - executeUpdate
```
public void executeUpdate()
```
    Description copied from interface: DataSource
    
    Executes SQL update query, set using addQuery().
    
    Specified by:
    
    executeUpdate in interface DataSource
  - executeUpdateRequired
```
public void executeUpdateRequired()
```
    Description copied from interface: DataSource
    
    Executes SQL update query, set using addQuery(). If no records were updated, throws an exception.
    
    Specified by:
    
    executeUpdateRequired in interface DataSource
  - setMaxRecords
```
public DataSource setMaxRecords(int maxRecords)
```
    Description copied from interface: DataSource
    
    Sets the max number of records that can be retrieved by consequent calls to retrieveRecords().
    
    Specified by:
    
    setMaxRecords in interface DataSource
    
    Parameters:
    
    maxRecords - Positive number, or 0 to read all available records without limit.
    
    Returns:
    
    This data source.
  - hasMoreRecords
```
public boolean hasMoreRecords()
```
    Description copied from interface: DataSource
    
    Returns true if preceding call to retrieveRecords() did not read all records due to record limit.
    
    Specified by:
    
    hasMoreRecords in interface DataSource
    
    Returns:
    
    The result.
  - createSqlForLastAddedPK
```
public java.lang.String createSqlForLastAddedPK(java.util.Map fieldValues)
```
    Generates SQL query that can be used to retrieve the primary key of the last saved record.
    
    Parameters:
    
    fieldValues - The PK values.
    
    Returns:
    
    The SQL.
  - checkSetContext
```
public void checkSetContext()
```
    If the parent Context has not been set, finds and sets it.
  - commit
```
public void commit()
```
    Description copied from interface: DataSource
    
    Commit current database transaction.
    
    Specified by:
    
    commit in interface DataSource
  - rollback
```
public void rollback()
```
    Description copied from interface: DataSource
    
    Rollback current database transaction.
    
    Specified by:
    
    rollback in interface DataSource
  - checkAutoCommit
```
protected void checkAutoCommit()
```
    If autoCommit is set, commit pending database changes.
  - useCascadeHandler
```
protected boolean useCascadeHandler()
```
    Returns:
    
    True if cascading handler is attached to the data source.

Class DataSourceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.archibus.datasource.DataSource

Field Summary

Fields inherited from interface com.archibus.datasource.DataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CASCADE_HANDLER

SQL_INJECTION_HANDLER

SCRIPT_INJECTION_HANDLER

databaseRole

mainTableName

tablesAndRoles

fieldNames

sortFields

virtualFieldDefs

calculatedFieldDefs

customSqlQueries

isDistinct

useHierarchicalSecurityRestriction

isAutoCommit

parameters

restrictions

maxRecords

doNotWrapCustomSql

applyVpaRestrictions

dataSourceDef

hasMoreRecords

mainTableDef

visibleFields

visibleFieldsByName

virtualFields

primaryKeyFields

keyFieldsByFullName

restrictionValues

query

standardQueries

parentContext

eventHandlerContext

expressionContext

project

database

locale

persistentRestrictions

fieldNamesForNewRecord

parametersChanged

log

basicRulesLog

cascadeHandler

sqlInjectionHandler

scriptInjectionHandler

Constructor Detail

DataSourceImpl

DataSourceImpl

Method Detail

createCopy

getDataSourceDef

setDataSourceDef

getTitle

setTitle

getId

setId

getViewName

setViewName

setDatabaseRole

addTable

addTable

addField

addField

addField

addField

getFieldNames

addSort

addSort

addSort

addVirtualField

addVirtualField

addVirtualField