HibernateDataSource (SmartClient Enterprise Server API 12.1p (2024-11-05))

java.lang.Object
- com.isomorphic.base.Base
- - com.isomorphic.datasource.DataSource
  - - com.isomorphic.datasource.BasicDataSource
    - - com.isomorphic.hibernate.HibernateDataSource

All Implemented Interfaces:

IToJSON
```
public class HibernateDataSource
extends BasicDataSource
```
A DataSource implementation for the Hibernate ORM system. SmartClient Server can integrate with Hibernate's ORM facilities, making use of new or existing bean mappings, or it can drive Hibernate as a pure storage layer in "beanless" mode. In this latter mode, SmartClient programs can connect to a Hibernate data store for all four CRUD operations, with zero server-side code or Hibernate configuration.
See the client reference documentation for details of configuring and using Hibernate DataSources - search for "hibernateIntegration". For a wider general discussion of data integration options with SmartClient Server, search the client documentation for "serverDataIntegration"

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map`	`additionalFields` Holds list of additional fields requested by specific `DSRequest`.
`protected java.lang.String`	`configName` Holds config name - can be configured with "jpaConfig" parameter.
`static java.lang.Character`	`ESCAPE_CHARACTER` Holds character ('~') used to escape wild cards in 'like' clause.
`protected java.lang.Boolean`	`generateRelatedUpdates` Holds value should related updates be generated.
`static java.lang.String`	`HB_CONFIG_PROPERTY` Name of the Hibernate configuration name property.
`protected java.util.List`	`relatedUpdates` Holds list of generated related updates.

Fields inherited from class com.isomorphic.datasource.DataSource
OP_ADD, OP_CLIENT_EXPORT, OP_CUSTOM, OP_DOWNLOAD_FILE, OP_FETCH, OP_GET_FILE, OP_GET_FILE_VERSION, OP_HAS_FILE, OP_HAS_FILE_VERSION, OP_LIST_FILE_VERSIONS, OP_LIST_FILES, OP_LOAD_SCHEMA, OP_REMOVE, OP_REMOVE_FILE, OP_REMOVE_FILE_VERSION, OP_RENAME_FILE, OP_SAVE_FILE, OP_UNIQUE_NAME, OP_UPDATE, OP_VALIDATE, OP_VIEW_FILE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`commitTransaction(org.hibernate.Transaction trx)` Deprecated. As of SmartClient 8.0. Use `HibernateTransaction.commitTransaction(com.isomorphic.datasource.DSTransaction)` instead
`static java.lang.String`	`escapeValueForFilter(java.lang.Object value, char escapeChar)` Escapes characters "_" and "%" with specified character in value object.
`DSField`	`getField(java.lang.String fieldName)` Returns `DSField` by specified name.
`java.util.List`	`getFieldNames(boolean dropIgnored)` Returns combined list of data source configured and request configured field names.
`static void`	`rollbackTransaction(org.hibernate.Transaction trx)` Deprecated. As of SmartClient 8.0. Use `HibernateTransaction.rollbackTransaction(com.isomorphic.datasource.DSTransaction)` instead
`static org.hibernate.Transaction`	`startTransaction()` Deprecated. As of SmartClient 8.0. Use `HibernateTransaction.startTransaction(com.isomorphic.datasource.DSTransaction)` instead

Methods inherited from class com.isomorphic.datasource.BasicDataSource
getAuditDataSource, getListProperty, getMapProperty, getObjectProperty, getProperty, shouldAutoJoinTransaction, shouldAutoStartTransaction, transformMultipleFields, transformMultipleFields

Methods inherited from class com.isomorphic.datasource.DataSource
add, add, addDynamicDSGenerator, addDynamicDSGenerator, addDynamicDSGenerator, clearDynamicDSGenerators, convertRelativeDates, convertRelativeDates, convertRelativeDates, convertRelativeDates, convertRelativeDates, execute, executeAdd, executeClientExport, executeCustom, executeFetch, executeFileSource, executeRemove, executeUpdate, fetch, fetch, fetchById, fetchById, fetchSingle, fetchSingle, filter, filter, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, getAuditChangedFieldsFieldName, getAuditRevisionFieldName, getAuditTimestampFieldName, getAuditTypeFieldName, getAuditUserFieldName, getDefaultDynamicDSGenerator, getDynamicDSGenerators, getEnumConstantProperty, getEnumOrdinalProperty, getEnumTranslateStrategy, getFieldNames, getFile, getFileAsInputStream, getFileAsString, getFileContentsField, getFileFormatField, getFileNameField, getFileTypeField, getID, getListProperties, getListProperties, getName, getPrimaryKey, getProperties, getProperties, getProperties, getPropertyJavaClass, getRecordXPath, getRelatedDisplayRecord, getRelatedDisplayRecord, getTableName, getTransactionObject, getTransactionObject, hasFile, hasRecord, hasRecord, initialized, isModificationOperation, isServerOnly, listFiles, listFiles, listFiles, listFiles, remove, removeDynamicDSGenerator, removeDynamicDSGenerator, removeDynamicDSGenerator, removeFile, renameFile, saveFile, setEnumConstantProperty, setEnumOrdinalProperty, setEnumTranslateStrategy, setOmitNullMapValuesInResponse, setProperties, transformImportValue, transformImportValue, update, update, validate, validate, validate, validateRecord

Methods inherited from interface com.isomorphic.js.IToJSON
toJSON

- Field Detail
  - ESCAPE_CHARACTER
```
public static final java.lang.Character ESCAPE_CHARACTER
```
    Holds character ('~') used to escape wild cards in 'like' clause. Avoid using backslash '\' or dollar sign '$' because it is often used in databases as DB escape or wild card characters.
  - HB_CONFIG_PROPERTY
```
public static final java.lang.String HB_CONFIG_PROPERTY
```
    Name of the Hibernate configuration name property.
    
    See Also:
    
    Constant Field Values
  - configName
```
protected java.lang.String configName
```
    Holds config name - can be configured with "jpaConfig" parameter. Holds empty string for default configuration.
  - relatedUpdates
```
protected java.util.List relatedUpdates
```
    Holds list of generated related updates. Usage: set this field to empty list before executing setProperties(); subsequent calls to setRelationFieldValue() will add DSResponse objects for every change in related data sources.
  - generateRelatedUpdates
```
protected java.lang.Boolean generateRelatedUpdates
```
    Holds value should related updates be generated. (Re)initialized on every execute() call. true - related updates will be generated; false - related updates will not be generated; null - related updates will be generated only for "add" and "update" operations, related updates will not be generated for "remove" operation.
  - additionalFields
```
protected java.util.Map additionalFields
```
    Holds list of additional fields requested by specific DSRequest.
- Method Detail
  - getFieldNames
```
public java.util.List getFieldNames(boolean dropIgnored)
```
    Returns combined list of data source configured and request configured field names.
    
    Overrides:
    
    getFieldNames in class DataSource
    
    Parameters:
    
    dropIgnored - boolean true - ignored fields are dropped; false - ignored fields are included;
    
    Returns:
    
    List field names.
  - getField
```
public DSField getField(java.lang.String fieldName)
```
    Returns DSField by specified name. First checks data source configured fields. Checks request configured fields if it is not found within data source configured fields. Returns null if fieldName parameter is null or field is not found.
    
    Overrides:
    
    getField in class BasicDataSource
    
    Parameters:
    
    fieldName - the name of the field whose definition you want
    
    Returns:
    
    DSField field.
    
    See Also:
    
    DSField
  - escapeValueForFilter
```
public static java.lang.String escapeValueForFilter(java.lang.Object value,
                                                    char escapeChar)
```
    Escapes characters "_" and "%" with specified character in value object. Specified escape character is escped (doubled) as well. Empty string is returned if value object is null.
    
    Parameters:
    
    value - Object Value which should be escaped.
    
    escapeChar - char ecape character.
    
    Returns:
    
    String Escaped string value.
  - startTransaction
```
public static org.hibernate.Transaction startTransaction()
                                                  throws java.lang.Exception
```
    Deprecated. As of SmartClient 8.0. Use HibernateTransaction.startTransaction(com.isomorphic.datasource.DSTransaction) instead
    
    Start a new transaction. The transaction ends when either HibernateDataSource.commitTransaction(org.hibernate.Transaction) orHibernateDataSource.rollbackTransaction(org.hibernate.Transaction) is called for the transaction.
    
    Returns:
    
    the new transaction
    
    Throws:
    
    java.lang.Exception
  - rollbackTransaction
```
public static void rollbackTransaction(org.hibernate.Transaction trx)
                                throws java.lang.Exception
```
    Deprecated. As of SmartClient 8.0. Use HibernateTransaction.rollbackTransaction(com.isomorphic.datasource.DSTransaction) instead
    
    Rollback and clean up the supplied transaction
    
    Throws:
    
    java.lang.Exception - if problems were found rolling back the transaction
  - commitTransaction
```
public static void commitTransaction(org.hibernate.Transaction trx)
                              throws java.lang.Exception
```
    Deprecated. As of SmartClient 8.0. Use HibernateTransaction.commitTransaction(com.isomorphic.datasource.DSTransaction) instead
    
    Commit and clean up the supplied transaction.
    
    Throws:
    
    java.lang.Exception - if problems were found committing the transaction

Class HibernateDataSource

Field Summary

Fields inherited from class com.isomorphic.datasource.DataSource

Method Summary

Methods inherited from class com.isomorphic.datasource.BasicDataSource

Methods inherited from class com.isomorphic.datasource.DataSource

Methods inherited from interface com.isomorphic.js.IToJSON

Field Detail

ESCAPE_CHARACTER

HB_CONFIG_PROPERTY

configName

relatedUpdates

generateRelatedUpdates

additionalFields

Method Detail

getFieldNames

getField

escapeValueForFilter

startTransaction

rollbackTransaction

commitTransaction