Class DataDescription

java.lang.Object
de.bsvrz.dav.daf.main.DataDescription

public class DataDescription
extends java.lang.Object
Klasse zum Zugriff auf die beschreibenden Eigenschaften eines Datensatzes. Das sind Attributgruppe, Aspekt und Simulationsvariante. Beim Erzeugen von Objekten dieser Klasse durch eine Applikation wird die Simulationsvariante im allgemeinen nicht explizit spezifiziert (Wert NO_SIMULATION_VARIANT_SET) und bei der Kommunikation mit dem Datenverteiler automatisch durch den Defaultwert ersetzt.
  • Field Summary

    Fields
    Modifier and Type Field Description
    static short NO_SIMULATION_VARIANT_SET
    Konstante, die signalisiert, dass die Simulationsvariante nicht explizit vorgegeben wurde, sondern der Defaultwert benutzt werden soll.
  • Constructor Summary

    Constructors
    Constructor Description
    DataDescription​(AttributeGroup attributeGroup, Aspect aspect)
    Erzeugt eine neue Datenbeschreibung mit den übergebenen Werten für die Attributgruppe und den Aspekt.
    DataDescription​(AttributeGroup attributeGroup, Aspect aspect, short simulationVariant)
    Erzeugt eine neue Datenbeschreibung mit den übergebenen Werten für die Attributgruppe, den Aspekt und die Simulationsvariante.
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)
    Vergleicht die Datenbeschreibung mit einer anderen Datenbeschreibung.
    Aspect getAspect()
    Liefert den Aspekt dieser Datenbeschreibung zurück.
    AttributeGroup getAttributeGroup()
    Liefert die Attributgruppe dieser Datenbeschreibung zurück.
    DataDescription getRedirectedDescription​(Aspect aspect)
    Gibt eine Kopie dieses Objektes mit der gegebenen Attributgruppe und der gegebenen Simulationsvariante und dem übergebenen Aspekt.
    short getSimulationVariant()
    Liefert die Simulationsvariante dieser Datenbeschreibung zurück.
    int hashCode()
    Liefert einen Hash-Code für das Objekt.
    void setSimulationVariant​(short simulationVariant)
    Deprecated.
    Sollte nicht mehr verwendet werden, da die Änderung dieses Objekts zu Problemen führen kann, wenn es bereits als Schlüssel in einer Map eingetragen wurde.
    java.lang.String toString()
    Liefert eine textuelle Beschreibung dieses Objekts zurück.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • NO_SIMULATION_VARIANT_SET

      public static final short NO_SIMULATION_VARIANT_SET
      Konstante, die signalisiert, dass die Simulationsvariante nicht explizit vorgegeben wurde, sondern der Defaultwert benutzt werden soll. Der Defaultwert kann beim Start einer Applikation über den Aufrufparameter -simVariante=... vorgegeben werden. Der Defaultwert wird aus den Verbindungsparametern (normalerweise 0) bestimmt und kann damit über Aufrufargumente der Applikation (-simVariante=...) vorgegeben werden. Siehe dazu auch die Schnittstellenbeschreibung DatenverteilerApplikationsfunktionen-Starter.
      See Also:
      Constant Field Values
  • Constructor Details

    • DataDescription

      public DataDescription​(AttributeGroup attributeGroup, Aspect aspect)
      Erzeugt eine neue Datenbeschreibung mit den übergebenen Werten für die Attributgruppe und den Aspekt. Die Simulationsvariante wird auf den Wert NO_SIMULATION_VARIANT_SET gesetzt, was bedeutet, dass der Defaultwert aus den Verbindungsparametern (normalerweise 0) benutzt werden soll und damit über Aufrufargumente der Applikation vorgegeben werden kann. Siehe dazu auch die Schnittstellenbeschreibung DatenverteilerApplikationsfunktionen-Starter.
      Parameters:
      attributeGroup - Attributgruppe der Datenbeschreibung
      aspect - Aspekt der Datenbeschreibung
    • DataDescription

      public DataDescription​(AttributeGroup attributeGroup, Aspect aspect, short simulationVariant)
      Erzeugt eine neue Datenbeschreibung mit den übergebenen Werten für die Attributgruppe, den Aspekt und die Simulationsvariante. Diese Konstruktor-Variante ist zu Testzwecken und für spezielle Applikationen vorgesehen, die die Simulationsvariante explizit vorgeben müssen. Eine Applikation, die man mehrfach mit verschiedenen Simulationsvarianten starten können soll, sollte die Simulationsvariante nicht selbst spezifizieren, sondern den Konstruktor ohne Simulationsvariante benutzen.
      Parameters:
      attributeGroup - Attributgruppe der Datenbeschreibung
      aspect - Aspekt der Datenbeschreibung
      simulationVariant - Simulationsvariante der Datenbeschreibung
  • Method Details

    • equals

      public final boolean equals​(java.lang.Object other)
      Vergleicht die Datenbeschreibung mit einer anderen Datenbeschreibung. Zwei Datenbeschreibungen sind gleich, wenn die Attributgruppen, die Aspekte und die Simulationsvarianten gleich sind.
      Overrides:
      equals in class java.lang.Object
      Parameters:
      other - Andere Datenbeschreibung mit der diese Datenbeschreibung verglichen werden soll.
      Returns:
      true, wenn die Datenbeschreibungen gleich sind, sonst false.
    • hashCode

      public int hashCode()
      Liefert einen Hash-Code für das Objekt. Implementierung hält sich an die Ratschläge in "Bloch, Joshua: Effective Java".
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      int den Hash-Code des Objekts
    • getAttributeGroup

      public final AttributeGroup getAttributeGroup()
      Liefert die Attributgruppe dieser Datenbeschreibung zurück.
      Returns:
      Attributgruppe dieser Datenbeschreibung
    • getAspect

      public final Aspect getAspect()
      Liefert den Aspekt dieser Datenbeschreibung zurück.
      Returns:
      Aspekt dieser Datenbeschreibung
    • getSimulationVariant

      public final short getSimulationVariant()
      Liefert die Simulationsvariante dieser Datenbeschreibung zurück.
      Returns:
      Simulationsvariante dieser Datenbeschreibung oder NO_SIMULATION_VARIANT_SET, wenn die Simulationsvariante nicht explizit spezifiziert ist.
    • setSimulationVariant

      @Deprecated public final void setSimulationVariant​(short simulationVariant)
      Deprecated.
      Sollte nicht mehr verwendet werden, da die Änderung dieses Objekts zu Problemen führen kann, wenn es bereits als Schlüssel in einer Map eingetragen wurde.
      Setzt die Simulationsvariante dieser Datenbeschreibung.
      Parameters:
      simulationVariant - Simulationsvariante dieser Datenbeschreibung
    • getRedirectedDescription

      public final DataDescription getRedirectedDescription​(Aspect aspect)
      Gibt eine Kopie dieses Objektes mit der gegebenen Attributgruppe und der gegebenen Simulationsvariante und dem übergebenen Aspekt.
      Parameters:
      aspect - der zu verwendende Aspekt
      Returns:
      eine Kopie dieses Objekts mit ausgetauschtem Aspekt
    • toString

      public java.lang.String toString()
      Liefert eine textuelle Beschreibung dieses Objekts zurück. Das genaue Format ist nicht festgelegt und kann sich ändern.
      Overrides:
      toString in class java.lang.Object
      Returns:
      Beschreibung dieses Objekts.