Layer (FirstSpirit Access-API)

```
public interface Layer
```
Since:

4.0.17

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEF_MAX_POOL_SIZE`
`static int`	`DEF_MAX_STRING_LENGTH`
`static int`	`DEF_MIN_POOL_SIZE`
`static long`	`DEF_POOL_CHECK_INTERVAL`
`static long`	`DEF_POOL_TIMEOUT`
`static String`	`PROP_CATALOG`
`static String`	`PROP_CHECK_STATEMENT`
`static String`	`PROP_CONNECTION_TIMEOUT`
`static String`	`PROP_CREATE_PAUSE_ON_ERROR`
`static String`	`PROP_CREATE_RETRY_ON_ERROR`
`static String`	`PROP_DRIVER`
`static String`	`PROP_ISOLATION` Property for transaction isolation, supported values are READ_COMMITTED, REPEATABLE_READ, and SERIALIZABLE.
`static String`	`PROP_JNDI`
`static String`	`PROP_LAYERCLASS`
`static String`	`PROP_MAX_POOL_SIZE`
`static String`	`PROP_MAX_STRING_LENGTH`
`static String`	`PROP_MIN_POOL_SIZE`
`static String`	`PROP_PASSWORD`
`static String`	`PROP_POOL_CHECK_INTERVAL`
`static String`	`PROP_POOL_TIMEOUT`
`static String`	`PROP_SCHEMA`
`static String`	`PROP_URL`
`static String`	`PROP_USER`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,String>`	`convertConfiguration(ConnectionConfiguration config)`
`ConnectionConfiguration`	`convertConfiguration(Map<String,String> properties)`
`de.espirit.or.CounterGenerator`	`createIdGenerator(String schemaName, boolean useLowerCase, de.espirit.or.ConnectionManager connectionManager)` Create a new id generator for this layer.
`de.espirit.or.SchemaSynchronizer`	`createSchemaSynchronizer()`
`CaseMode`	`getCaseMode()`
`CaseMode`	`getCaseModeForDbName()` Case mode for database name.
`String`	`getCatalog()` Return the catalog (database) assigned with this layer.
`Map<String,String>`	`getDefaultParameters(String name)` Return a map of jdbc parameters to default values for this layer based on `name`.
`String`	`getId()`
`int`	`getJdbcTypeCode(Column column)`
`String`	`getProperty(String name)`
`String`	`getSchema()` Return the database schema assigned with this Multiproject-Layer layer.
`de.espirit.or.SQLBuilder`	`getSQLBuilder()`
`char`	`getStringDelimiter()` The character to delimit string constants in sql expressions.
`void`	`init(Map<String,String> props)`
`String`	`testLayerParameters(ConnectionConfiguration config, ClassLoader classLoader)`

- Field Detail
  - PROP_LAYERCLASS
```
static final String PROP_LAYERCLASS
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_USER
```
static final String PROP_USER
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_PASSWORD
```
static final String PROP_PASSWORD
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_CHECK_STATEMENT
```
static final String PROP_CHECK_STATEMENT
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_MIN_POOL_SIZE
```
static final String PROP_MIN_POOL_SIZE
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_MAX_POOL_SIZE
```
static final String PROP_MAX_POOL_SIZE
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_POOL_CHECK_INTERVAL
```
static final String PROP_POOL_CHECK_INTERVAL
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_POOL_TIMEOUT
```
static final String PROP_POOL_TIMEOUT
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_CONNECTION_TIMEOUT
```
static final String PROP_CONNECTION_TIMEOUT
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_DRIVER
```
static final String PROP_DRIVER
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_SCHEMA
```
static final String PROP_SCHEMA
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_CREATE_RETRY_ON_ERROR
```
static final String PROP_CREATE_RETRY_ON_ERROR
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_CREATE_PAUSE_ON_ERROR
```
static final String PROP_CREATE_PAUSE_ON_ERROR
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_URL
```
static final String PROP_URL
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_JNDI
```
static final String PROP_JNDI
```
    Since:
    
    4.0.17
    
    See Also:
    Constant Field Values
  - PROP_MAX_STRING_LENGTH
```
static final String PROP_MAX_STRING_LENGTH
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - PROP_CATALOG
```
static final String PROP_CATALOG
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - DEF_MAX_STRING_LENGTH
```
static final int DEF_MAX_STRING_LENGTH
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - DEF_MAX_POOL_SIZE
```
static final int DEF_MAX_POOL_SIZE
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - DEF_MIN_POOL_SIZE
```
static final int DEF_MIN_POOL_SIZE
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - DEF_POOL_CHECK_INTERVAL
```
static final long DEF_POOL_CHECK_INTERVAL
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - DEF_POOL_TIMEOUT
```
static final long DEF_POOL_TIMEOUT
```
    Since:
    
    4.0.19
    
    See Also:
    Constant Field Values
  - PROP_ISOLATION
```
static final String PROP_ISOLATION
```
    Property for transaction isolation, supported values are READ_COMMITTED, REPEATABLE_READ, and SERIALIZABLE. Default is SERIALIZABLE.
    
    Since:
    
    5.0.100
    
    See Also:
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Since:
    
    4.0.17
  - init
```
void init(Map<String,String> props)
```
    Since:
    
    4.0.17
  - createSchemaSynchronizer
```
de.espirit.or.SchemaSynchronizer createSchemaSynchronizer()
```
    Since:
    
    4.0.17
  - getSQLBuilder
```
de.espirit.or.SQLBuilder getSQLBuilder()
```
    Since:
    
    4.0.17
  - getCatalog
```
String getCatalog()
```
    Return the catalog (database) assigned with this layer.
    
    Since:
    
    4.0.17
  - getSchema
```
String getSchema()
```
    Return the database schema assigned with this Multiproject-Layer layer.
    
    Since:
    
    4.0.17
  - getCaseMode
```
@NotNull
CaseMode getCaseMode()
```
    Since:
    
    4.1.11
  - getCaseModeForDbName
```
@NotNull
CaseMode getCaseModeForDbName()
```
    Case mode for database name.
    
    Returns:
    Case mode for database name.
    Since:
    
    5.0.100
  - createIdGenerator
```
de.espirit.or.CounterGenerator createIdGenerator(String schemaName,
                                               boolean useLowerCase,
                                               de.espirit.or.ConnectionManager connectionManager)
```
    Create a new id generator for this layer.
    
    Since:
    
    4.0.17
  - getDefaultParameters
```
Map<String,String> getDefaultParameters(@NotNull
                                      String name)
```
    Return a map of jdbc parameters to default values for this layer based on name.
    
    Parameters:
    name - the name of this layer instance.
    Since:
    
    4.0.17
  - testLayerParameters
```
@Nullable
String testLayerParameters(ConnectionConfiguration config,
                                  ClassLoader classLoader)
```
    Since:
    
    4.1.9
  - convertConfiguration
```
Map<String,String> convertConfiguration(ConnectionConfiguration config)
```
    Since:
    
    4.0.17
  - convertConfiguration
```
ConnectionConfiguration convertConfiguration(Map<String,String> properties)
```
    Since:
    
    4.0.17
  - getJdbcTypeCode
```
int getJdbcTypeCode(Column column)
```
    Since:
    
    4.0.120
  - getProperty
```
String getProperty(String name)
```
    Since:
    
    4.1.1
  - getStringDelimiter
```
char getStringDelimiter()
```
    The character to delimit string constants in sql expressions.
    
    Returns:
    The character used to delimit strings, usually a tic '.
    Since:
    
    4.2.209

Interface Layer

Field Summary

Method Summary

Field Detail

PROP_LAYERCLASS

PROP_USER

PROP_PASSWORD

PROP_CHECK_STATEMENT

PROP_MIN_POOL_SIZE

PROP_MAX_POOL_SIZE

PROP_POOL_CHECK_INTERVAL

PROP_POOL_TIMEOUT

PROP_CONNECTION_TIMEOUT

PROP_DRIVER

PROP_SCHEMA

PROP_CREATE_RETRY_ON_ERROR

PROP_CREATE_PAUSE_ON_ERROR

PROP_URL

PROP_JNDI

PROP_MAX_STRING_LENGTH

PROP_CATALOG

DEF_MAX_STRING_LENGTH

DEF_MAX_POOL_SIZE

DEF_MIN_POOL_SIZE

DEF_POOL_CHECK_INTERVAL

DEF_POOL_TIMEOUT

PROP_ISOLATION

Method Detail

getId

init

createSchemaSynchronizer

getSQLBuilder

getCatalog

getSchema

getCaseMode

getCaseModeForDbName

createIdGenerator

getDefaultParameters

testLayerParameters

convertConfiguration

convertConfiguration

getJdbcTypeCode

getProperty

getStringDelimiter