Datensatzklasse PersistenceDirectoryLayoutInstance

java.lang.Object
java.lang.Record
de.bsvrz.ars.ars.persistence.layout.PersistenceDirectoryLayoutInstance
Datensatzkomponenten:
layout - Verzeichnis-Layout
basePath - Dateisystem-Pfad, unter dem die Archivdaten liegen. Dies ist z. B. das konkrete Wochenverzeichnis.
simulationVariant - Simulationsvariante der Daten in diesem Verzeichnis

public record PersistenceDirectoryLayoutInstance(PersistenceDirectoryLayout layout, Path basePath, int simulationVariant) extends Record
Konkrete instanz eines PersistenceDirectoryLayout, welches sich an einer bestimmten Position im Dateisystem befindet.
  • Konstruktordetails

    • PersistenceDirectoryLayoutInstance

      public PersistenceDirectoryLayoutInstance(PersistenceDirectoryLayout layout, Path basePath, int simulationVariant)
      Erstellt eine Instanz einer Datensatzklasse PersistenceDirectoryLayoutInstance.
      Parameter:
      layout - Wert für die Datensatzkomponente layout
      basePath - Wert für die Datensatzkomponente basePath
      simulationVariant - Wert für die Datensatzkomponente simulationVariant
  • Methodendetails

    • getContainerDirectory

      public IdContainerFileDir getContainerDirectory(BaseIndex<?> index) throws IndexException
      Ermittelt von einer Index-Datei im Dateisystem die Datenidentifikation
      Parameter:
      index - Index
      Gibt zurück:
      Datenidentifikation und Datenart
      Löst aus:
      IndexException - Fehler bei Abfrage
    • getContainerDirectory

      public IdContainerFileDir getContainerDirectory(Path containerDirectory) throws PersistenceException
      Ermittelt von einem Pfad im Dateisystem die Datenidentifikation und Datenart
      Parameter:
      containerDirectory - Containerdateien-Verzeichnis
      Gibt zurück:
      Datenidentifikation und Datenart
      Löst aus:
      PersistenceException - Fehler bei Abfrage
    • getPath

      @NotNull @Contract(pure=true) public Path getPath(ContainerDirectory containerDirectory)
      Gibt zu einem ContainerDirectory das zugehörige Verzeichnis zurück.
      Parameter:
      containerDirectory - Datenidentifikation und Archivdatenart, die das Containerverzeichnis identifizieren
      Gibt zurück:
      Verzeichnis
    • getPath

      public Path getPath(IdDataIdentification dataIdentification)
      Gibt zu einer Datenidentifikation das Dateisystemverzeichnis zurück
      Parameter:
      dataIdentification - Datenidentifikation
      Gibt zurück:
      Verzeichnis
    • getPathType

      public PathType getPathType(ArrayList<String> pathStack)
      Identifiziert den Typ des angegebenen Verzeichnisses
      Parameter:
      pathStack - Stack wo man sich im Verzeichnisbaum befindet, siehe toStack(Path)
      Gibt zurück:
      Typ des angegebenen Pfads
    • getPath

      public IdDataIdentification getPath(ArrayList<String> pathStack)
      Identifiziert die Datenidentifiaktion des angegebenen Verzeichnisses
      Parameter:
      pathStack - Stack wo man sich im Verzeichnisbaum befindet, siehe toStack(Path)
      Gibt zurück:
      Typ des angegebenen Pfads
    • detectFromPath

      @NotNull public static PersistenceDirectoryLayoutInstance detectFromPath(Path path) throws PersistenceException
      Versucht, von einem Verzeichnis zu ermitteln, welches persistenzverzeichnislayout in diesem Verzeichnis genutzt wird und gibt dies als PersistenceDirectoryLayoutInstance zurück.
      Parameter:
      path - Verzeichnis
      Gibt zurück:
      Instanz (nie null)
      Löst aus:
      PersistenceException - wenn die Instanz nicht ermittelt werden konnte
    • toString

      public final String toString()
      Gibt eine Zeichenfolgendarstellung dieser Datensatzklasse zurück. Die Darstellung enthält den Namen der Klasse, gefolgt vom Namen und Wert jeder der Datensatzkomponenten.
      Angegeben von:
      toString in Klasse Record
      Gibt zurück:
      eine Zeichenfolgendarstellung dieses Objekts
    • hashCode

      public final int hashCode()
      Gibt einen Hashcodewert für diese Objekt zurück. Der Wert wird vom Hashcode jeder der Datensatzkomponenten abgeleitet.
      Angegeben von:
      hashCode in Klasse Record
      Gibt zurück:
      ein Hashcodewert für dieses Objekt
    • equals

      public final boolean equals(Object o)
      Gibt an, ob ein anderes Objekt diesem gleich ("equal to") ist. Die Objekte sind gleich, wenn das andere Objekt der gleichen Klasse angehört und alle Datensatzkomponenten gleich sind. Referenzkomponenten werden verglichen mit Objects::equals(Object,Object); primitive Komponenten werden verglichen mit "==".
      Angegeben von:
      equals in Klasse Record
      Parameter:
      o - das Objekt, mit dem verglichen wird
      Gibt zurück:
      true, wenn dieses Objekt gleich dem Argument o ist, andernfalls false.
    • layout

      public PersistenceDirectoryLayout layout()
      Gibt den Wert für die Datensatzkomponente layout zurück.
      Gibt zurück:
      Wert der Datensatzkomponente layout
    • basePath

      public Path basePath()
      Gibt den Wert für die Datensatzkomponente basePath zurück.
      Gibt zurück:
      Wert der Datensatzkomponente basePath
    • simulationVariant

      public int simulationVariant()
      Gibt den Wert für die Datensatzkomponente simulationVariant zurück.
      Gibt zurück:
      Wert der Datensatzkomponente simulationVariant