Package acdp

Interface Information.DatabaseInfo

Enclosing interface:
Information
public static interface Information.DatabaseInfo
The database info comprises some useful information about the database, including all values from the database layout.
Author:
Beat Hörmann

  • Method Details

    • mainFile

      Path mainFile()
      Returns the main file of this database.
      Returns:
      The main file of this database, never null.

    • name

      String name()
      Returns the name of this database. (The Database.name() method returns the same value.)

      This property is registered in the database layout.

      Returns:
      The name of this database, never null and never an empty string.

    • version

      String version()
      Returns the version of this database.

      This property is registered in the database layout.

      Returns:
      The version of this database or null if no version is defined for this database, never an empty string.

    • type

      Information.DatabaseInfo.DBType type()
      Returns the information whether this database is an RO or WR database.
      Returns:
      The type of this database, never null.

    • isWritable

      boolean isWritable()
      Returns the information whether this database is writable or read-only. A database is writable if and only if the database is a WR database and if it is not write protected.
      Returns:
      The boolean value true if this database is writable, false if it is read-only.

    • consistencyNumber

      int consistencyNumber()
      Returns the consistency number of this database.

      This property is registered in the database layout.

      Returns:
      The consistency number of this database.

    • cipherChallenge

      String cipherChallenge()
      The cipher challenge. The cipher challenge is used to ensure that this database's cipher correctly works with respect to the encrypted persisted data.

      This property is registered in the database layout.

      Returns:
      The cipher challenge or null if and only if this database does not apply encryption.

    • appliesEncryption

      boolean appliesEncryption()
      Returns the information whether this database applies encryption.
      Returns:
      The boolean value true if and only if this database applies encryption.

    • recFile

      Path recFile()
      The recorder file of this database. The recorder file is used by a WR database to roll back a unit.

      This property is registered in the database layout.

      Returns:
      The recorder file or null if and only if this database is an RO database.

    • forceWriteCommit

      boolean forceWriteCommit()
      Indicates if changes to this database are forced being materialized when a unit is committed to guarantee durability (the "D" in "ACID") even in the case of a system crash. If the returned value is true then data changes are materialized when a unit is committed and changes to the recorder file are immediately materialized. Otherwise, changes to this database, as well as changes to the recorder file are forced being materialized not until this database is closed. Depending on the storage device, changes may be earlier materialized in parts or as a whole.
      Returns:
      The boolean value true if changes to this database are forced being materialized as part of committing a unit, false if changes to this database and to the recorder file are forced being materialized not until this database is closed.

    • getTableInfos

      Information.TableInfo[] getTableInfos()
      Returns the table information of all tables in this database.

      The order in which the table information objects appear in the returned array is equal to the order in which the tables appear in the database layout.

      Returns:
      The table information of all tables in this database, never null and never empty.