Package de.espirit.or.schema

Interface Schema

public interface Schema
Interface representing the or schema model.
Since:
5.0.100

  • Method Details

    • getCaseMode

      @NotNull @NotNull CaseMode getCaseMode()
      Get the case mode of the underlying database: lower, upper, or mixed case.
      Returns:
      The case mode of the underlying database.
      Since:
      4.1.11

    • getName

      String getName()
      Return the name of this schema.
      Since:
      4.0.17

    • setName

      void setName(String name)
      Set the name of this schema to name. Also sets the internal database name of this schema.
      Parameters:
      name - The name of this schema
      Since:
      3.0.313

    • isTemporal

      boolean isTemporal()
      A schema in FirstSprit can be temporal or non-temporal. While a non-temporal schema is used in scenarios where only the current state of the data is relevant (e.g. site settings), a temporal schema supports the concept of versioned entities. This allows for retrieving the historical state of an entity at a specific point in time.
      Returns:
      true if this schema is a temporal schema, false otherwise.
      Since:
      4.0.17

    • createEntityType

      @NotNull @NotNull EntityType createEntityType(String name) throws SchemaException
      Create a new entity type with the given name
      Throws:
      SchemaException
      Since:
      4.0.17

    • getEntityType

      @Nullable @Nullable EntityType getEntityType(String name)
      Return the entity type with the given name if one was defined in this schema else null
      Since:
      4.0.17

    • removeEntityType

      void removeEntityType(EntityType entityType)
      Delete the entityType from this schema.
      Since:
      4.0.17

    • getEntityTypes

      @NotNull @NotNull Collection<? extends EntityType> getEntityTypes()
      Return all entity types contained in this schema.
      Since:
      4.0.17