Class KeyValParam

java.lang.Object
de.bsvrz.ars.ars.persistence.KeyValParam

public class KeyValParam extends Object
Diese Klasse definiert die Parameter im Container-Header. Dazu gehören Schluesselname, max. Länge des Wertes, Wertebereich und Default-Wert. Es gibt Text- und Zahl-Parameter. Verwaltet werden diese Parameter von der Klasse ContainerHdr.
  • Constructor Details

    • KeyValParam

      public KeyValParam()
  • Method Details

    • createStringParam

      public static KeyValParam createStringParam(String key, String defaultValue, int valueLength)
      Erzeugt einen neuen Container-Header-Parameter (Text).
      Parameters:
      key - Schluessel des Parameters
      defaultValue - Vorgabe-Wert
      valueLength - Länge des Werts
      Returns:
      Text-Parameter
    • createStringParam

      public static KeyValParam createStringParam(String key, String defaultValue, int valueLength, String[] allowedValues)
      Erzeugt einen neuen Container-Header-Parameter.
      Parameters:
      key - Schluessel des Parameters
      defaultValue - Vorgabe-Wert
      valueLength - Länge des Werts
      allowedValues - Erlaubte Werte
      Returns:
      Wert-Parameter
    • createNumParam

      public static KeyValParam createNumParam(String key, long defaultValue, int valueLength, long minVal, long maxVal, int byteLength)
      Erzeugt einen neuen Container-Header-Parameter.
      Parameters:
      key - Schluessel des Parameters
      defaultValue - Vorgabe-Wert
      valueLength - Länge des Werts
      minVal - minimaler Wert
      maxVal - maximaler Wert
      byteLength - Vorgesehene Länge in bytes
      Returns:
      KeyValParam
    • checkVal

      public void checkVal(long val) throws PersistenceException
      Prüft, ob ein Wert gesetzt werden könnte, wirft andernfalls eine PersistenceException.
      Parameters:
      val - zu prüfender Wert
      Throws:
      PersistenceException - Exception, falls Wert ungültig ist.
    • checkVal

      public void checkVal(String val) throws PersistenceException
      Prüft, ob ein Wert gesetzt werden könnte, wirft andernfalls eine PersistenceException.
      Parameters:
      val - zu prüfender Wert
      Throws:
      PersistenceException - Exception, falls Wert ungültig ist.
    • getKey

      public String getKey()
      Liefert den Schluessel des Container-Header-Parameter.
      Returns:
      Schluessel
    • formatVal

      public String formatVal(long val)
      Ergaenzt den angegebenen Wert um fuehrende Nullen bis zur max. Länge des Werts dieses Parameters. Bei negativen Zahlen wird das "-"-Zeichen links vor den Nullen eingefuegt.
      Parameters:
      val - Wert
      Returns:
      Wert mit fuehrenden Nullen
    • formatVal

      public String formatVal(String val)
      Ergaenzt den angegebenen Wert um Leerzeichen bis zur max. Länge des Werts dieses Parameters.
      Parameters:
      val - Wert
      Returns:
      Wert mit angehaengten Leerzeichen oder fuehrenden Nullen
    • getDefaultVal

      public String getDefaultVal()
      Liefert des Default-Wert für diesen Parameter.
      Returns:
      Default-Wert
    • getValLen

      public int getValLen()
      Liefert die Lanege des Werts (Anzahl an Zeichen).
      Returns:
      Länge des Werts
    • isNumeric

      public boolean isNumeric()
    • getByteLength

      public int getByteLength()
    • toString

      public String toString()
      Overrides:
      toString in class Object