Package de.espirit.firstspirit.access.database

Interface Layer

All Superinterfaces:
Comparable<Layer>
public interface Layer extends Comparable<Layer>
FirstSpirit Database Layer.
Since:
3.0.86

  • Field Details

    • JDBC_PARAMETERS

      static final String[] JDBC_PARAMETERS
      JDBC parameters used in the database layer.
      Since:
      4.0

  • Method Details

    • getName

      String getName()
      Returns the name of the database layer.
      Returns:
      the name of the database layer.
      Since:
      3.0.86

    • getParameterNames

      List<String> getParameterNames()
      Returns a list of the layer parameter names.
      Returns:
      the list of parameter names.
      Since:
      3.0.86

    • getParameter

      String getParameter(String name)
      Returns the value of a specific parameter.
      Parameters:
      name - the name of the parameter to get the value from.
      Returns:
      the value of the parameter.
      Since:
      3.0.86

    • setParameter

      void setParameter(String name, String value)
      Setter for layer parameter.
      Parameters:
      name - the name of the new parameter.
      value - the value of the new parameter.
      Since:
      3.0.86

    • clear

      void clear()
      Removes all layer parameters.
      Since:
      3.0.86

    • removeParameter

      void removeParameter(String name)
      Removes the specified layer parameter.
      Parameters:
      name - the name of the parameter to remove.
      Since:
      3.0.86

    • getParameters

      Map<String,String> getParameters()
      Returns a map of all layer parameters.
      Returns:
      a map of all layer parameters.
      Since:
      4.0

    • getLayerByClassName

      Layer getLayerByClassName(String className)
      Return the layer from type className.
      Since:
      4.0

    • getLayerById

      Layer getLayerById(String id)
      Return the layer with the given id see Layer.getId(). Returns null for an unknown id.
      Since:
      4.0

    • getLayerIds

      @Deprecated(forRemoval=true) Object[] getLayerIds()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.230101 - use getAvailableLayerIds() instead
      Return an array of all available layer ids in the system (array elements are of type java.lang.String).
      Since:
      4.0

    • getAvailableLayerIds

      @NotNull default @NotNull List<String> getAvailableLayerIds()
      Returns the ids of all available layers in the system.
      Returns:
      the available layer ids sorted alphabetically or an empty list, but never null.
      Since:
      5.2.230101

    • getSchema

      @Nullable @Nullable String getSchema()
      Return the database schema name defined for this layer. A DBA layer has no database schema name assigned.
      Since:
      4.0
      See Also:

    • isDbaLayer

      boolean isDbaLayer()
      A DBA (database administration) layer is a layer which creates a db-schema in the database for each FirstSpirit schema. A layer which is no DBA layer could be used only once in write mode - violations are configuration failures and can lead to unexpected behaviour.
      Returns:
      true if this schema is a database administration layer.
      Since:
      4.2.34
      See Also: