Package de.espirit.or

Interface Layer

public interface Layer
Definition of a type providing information about a database layer.
Since:
4.0.17

  • Field Details

    • PROP_LAYERCLASS

      static final String PROP_LAYERCLASS
      Property name for storing the layer class.
      Since:
      4.0.17
      See Also:

    • PROP_USER

      static final String PROP_USER
      Property name for storing the user.
      Since:
      4.0.17
      See Also:

    • PROP_PASSWORD

      static final String PROP_PASSWORD
      Property name for storing the user's password.
      Since:
      4.0.17
      See Also:

    • PROP_CHECK_STATEMENT

      static final String PROP_CHECK_STATEMENT
      Property name for storing the check statement.
      Since:
      4.0.17
      See Also:

    • PROP_MIN_POOL_SIZE

      static final String PROP_MIN_POOL_SIZE
      Property name for storing the minimum pool size.
      Since:
      4.0.17
      See Also:

    • PROP_MAX_POOL_SIZE

      static final String PROP_MAX_POOL_SIZE
      Property name for storing the maximum pool size.
      Since:
      4.0.17
      See Also:

    • PROP_POOL_CHECK_INTERVAL

      static final String PROP_POOL_CHECK_INTERVAL
      Property name for storing the interval in which to check the pool constraints.
      Since:
      4.0.17
      See Also:

    • PROP_POOL_TIMEOUT

      static final String PROP_POOL_TIMEOUT
      Property name for storing the timeout for pool access.
      Since:
      4.0.17
      See Also:

    • PROP_CONNECTION_TIMEOUT

      static final String PROP_CONNECTION_TIMEOUT
      Property name for storing the timout for connection response.
      Since:
      4.0.17
      See Also:

    • PROP_DRIVER

      static final String PROP_DRIVER
      Property name for storing the JDBC driver.
      Since:
      4.0.17
      See Also:

    • PROP_SCHEMA

      static final String PROP_SCHEMA
      Property name for storing the JDBC schema name.
      Since:
      4.0.17
      See Also:

    • PROP_CREATE_RETRY_ON_ERROR

      static final String PROP_CREATE_RETRY_ON_ERROR
      Property name for storing the number of retries when a connection error occurred.
      Since:
      4.0.17
      See Also:

    • PROP_CREATE_PAUSE_ON_ERROR

      static final String PROP_CREATE_PAUSE_ON_ERROR
      Property name for storing the time to pause before retry when a connection error occurred.
      Since:
      4.0.17
      See Also:

    • PROP_FETCH_CONNECTION_TIMEOUT

      static final String PROP_FETCH_CONNECTION_TIMEOUT
      Maximum time to wait on a connection becoming available.
      Since:
      5.1.500
      See Also:

    • PROP_URL

      static final String PROP_URL
      Property name for storing the JDBC URL.
      Since:
      4.0.17
      See Also:

    • PROP_JNDI

      static final String PROP_JNDI
      Property name for storing the JDBC JNDI definition.
      Since:
      4.0.17
      See Also:

    • PROP_MAX_STRING_LENGTH

      static final String PROP_MAX_STRING_LENGTH
      Property name for storing the maximum length for strings.
      Since:
      4.0.19
      See Also:

    • PROP_CATALOG

      static final String PROP_CATALOG
      Property name for storing the JDBC catalog name.
      Since:
      4.0.19
      See Also:

    • DEF_MAX_STRING_LENGTH

      static final int DEF_MAX_STRING_LENGTH
      Default maximum length for strings.
      Since:
      4.0.19
      See Also:

    • DEF_MAX_POOL_SIZE

      static final int DEF_MAX_POOL_SIZE
      Default maximum pool size.
      Since:
      4.0.19
      See Also:

    • DEF_MIN_POOL_SIZE

      static final int DEF_MIN_POOL_SIZE
      Default minimum pool size.
      Since:
      4.0.19
      See Also:

    • DEF_POOL_CHECK_INTERVAL

      static final long DEF_POOL_CHECK_INTERVAL
      Default check interval for pool access.
      Since:
      4.0.19
      See Also:

    • DEF_POOL_TIMEOUT

      static final long DEF_POOL_TIMEOUT
      Default timeout for pool access.
      Since:
      4.0.19
      See Also:

    • 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:

  • Method Details

    • getId

      String getId()
      Provides the ID of the layer.
      Returns:
      The ID.
      Since:
      4.0.17

    • init

      void init(Map<String,String> props)
      Initializes the layer with the given properties.
      Parameters:
      props - Some properties.
      Since:
      4.0.17

    • createSchemaSynchronizer

      de.espirit.or.SchemaSynchronizer createSchemaSynchronizer()
      Creates a schema synchronizer.
      Returns:
      A synchronizer.
      Since:
      4.0.17

    • getSQLBuilder

      de.espirit.or.SQLBuilder getSQLBuilder()
      Provides a builder for SQL requests.
      Returns:
      An SQL builder.
      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 @NotNull CaseMode getCaseMode()
      Provides the mode for letter case handling.
      Returns:
      The letter case mode.
      Since:
      4.1.11

    • getCaseModeForDbName

      @NotNull @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 @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 @Nullable String testLayerParameters(ConnectionConfiguration config, ClassLoader classLoader)
      Tests the given configuration for this layer.
      Parameters:
      config - The configuration.
      classLoader - A class loader.
      Returns:
      An error message or null.
      Since:
      4.1.9

    • convertConfiguration

      Map<String,String> convertConfiguration(ConnectionConfiguration config)
      Converts the given configuration to a map of properties.
      Parameters:
      config - The configuration.
      Returns:
      A map of properties.
      Since:
      4.0.17

    • convertConfiguration

      ConnectionConfiguration convertConfiguration(Map<String,String> properties)
      Converts the given properties toa configuration object.
      Parameters:
      properties - A map of properties.
      Returns:
      The configuration.
      Since:
      4.0.17

    • getJdbcTypeCode

      int getJdbcTypeCode(de.espirit.or.schema.Column column)
      Provides the JDBC defined type code for the given column type.
      Parameters:
      column - The column type.
      Returns:
      The JDBC type code.
      Since:
      4.0.120

    • getProperty

      String getProperty(String name)
      Provides the property value stored with the given name.
      Returns:
      The property value or null.
      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

    • getDefaultTransactionIsolationLevel

      @NotNull @NotNull Layer.TransactionIsolationLevel getDefaultTransactionIsolationLevel()
      Get the default isolation level of this layer.
      Returns:
      The default isolation level for this Layer (not null).
      Since:
      5.1.309

    • getDropStatement

      default String getDropStatement()
      Get the specific SQL-Drop-Statement which deletes an existing table or scheme from a database
      Returns:
      The drop-statement as String value
      Since:
      5.2.210903