de.bsvrz.ars.ars.persistence
Class KeyValParam

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

public class KeyValParam
extends Object

Diese Klasse definiert die Parameter im Container-Header. Dazu gehören Schluesselname, max. Laenge des Wertes, Wertebereich und Default-Wert. Es gibt Text- und Zahl-Parameter. Verwaltet werden diese Parameter von der Klasse ContainerHdr.

Author:
beck et al. projects GmbH, Thomas Schaefer, Alexander Schmidt

Field Summary
private  String[] allowedStringValues
           
private  String defaultValue
           
private  String key
           
private  long maxVal
           
private  long minVal
           
private  String paramType
           
private static String TYPE_NUM
           
private static String TYPE_STRING
           
private  int valueLength
           
 
Constructor Summary
KeyValParam()
           
 
Method Summary
 void checkVal(long val)
           
 void checkVal(String val)
           
static KeyValParam createNumParam(String key, long defaultValue, int valueLength, long minVal, long maxVal)
          Erzeugt einen neuen Container-Header-Parameter.
static KeyValParam createStringParam(String key, String defaultValue, int valueLength)
          Erzeugt einen neuen Container-Header-Parameter (Text).
static KeyValParam createStringParam(String key, String defaultValue, int valueLength, String[] allowedValues)
          Erzeugt einen neuen Container-Header-Parameter.
 String formatVal(long val)
          Ergaenzt den angegebenen Wert um fuehrende Nullen bis zur max.
 String formatVal(String val)
          Ergaenzt den angegebenen Wert um Leerzeichen bis zur max.
 String getDefaultVal()
          Liefert des Default-Wert fuer diesen Parameter.
 String getKey()
          Liefert den Schluessel des Container-Header-Parameter.
 int getValLen()
          Liefert die Lanege des Werts (Anzahl an Zeichen).
 boolean isNumeric()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_STRING

private static String TYPE_STRING

TYPE_NUM

private static String TYPE_NUM

key

private String key

defaultValue

private String defaultValue

allowedStringValues

private String[] allowedStringValues

valueLength

private int valueLength

minVal

private long minVal

maxVal

private long maxVal

paramType

private String paramType
Constructor Detail

KeyValParam

public KeyValParam()
Method Detail

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 - Laenge des Werts

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 - Laenge des Werts
allowedValues - Erlaubte Werte

createNumParam

public static KeyValParam createNumParam(String key,
                                         long defaultValue,
                                         int valueLength,
                                         long minVal,
                                         long maxVal)
Erzeugt einen neuen Container-Header-Parameter.

Parameters:
key - Schluessel des Parameters
defaultValue - Vorgabe-Wert
valueLength - Laenge des Werts
minVal - minimaler Wert
maxVal - maximaler Wert

checkVal

public void checkVal(long val)
              throws PersistenceException
Throws:
PersistenceException

checkVal

public void checkVal(String val)
              throws PersistenceException
Throws:
PersistenceException

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. Laenge 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. Laenge des Werts dieses Parameters.

Parameters:
val - Wert
Returns:
Wert mit angehaengten Leerzeichen oder fuehrenden Nullen

getDefaultVal

public String getDefaultVal()
Liefert des Default-Wert fuer diesen Parameter.

Returns:
Default-Wert

getValLen

public int getValLen()
Liefert die Lanege des Werts (Anzahl an Zeichen).

Returns:
Laenge des Werts

isNumeric

public boolean isNumeric()

toString

public String toString()
Overrides:
toString in class Object