Package org.kapott.hbci.protocol

Class SyntaxElement

    • Constructor Detail

      • SyntaxElement

        protected SyntaxElement​(String type,
                        String name,
                        String path,
                        int idx,
                        Document document)
        es wird ein syntaxelement mit der id 'name' initialisiert; der pfad bis zu diesem element wird in 'path' uebergeben; 'idx' ist die nummer dieses elementes innerhalb der syntaxelementliste fuer dieses element (falls ein bestimmtes syntaxelement mehr als einmal auftreten kann)

      • SyntaxElement

        protected SyntaxElement​(String type,
                        String name,
                        String path,
                        char predelim,
                        int idx,
                        StringBuilder res,
                        int fullResLen,
                        Document document,
                        Map<String,​String> predefs,
                        Map<String,​String> valids)
        beim parsen: initialisiert ein neues syntaxelement mit der id 'name'; in 'path' wird der pfad bis zu dieser stelle uebergeben 'predelim' gibt das delimiter-zeichen an, das beim parsen vor diesem document- element stehen muesste 'idx' ist die nummer des syntaxelementes innerhalb der uebergeordneten liste (die liste repraesentiert das evtl. mehrmalige auftreten eines syntaxelementes, siehe class syntaxelementlist) 'res' ist der zu parsende String 'predefs' soll eine menge von pfad-wert-paaren enthalten, die fuer einige syntaxelemente den wert angeben, den diese elemente zwingend haben muessen (z.b. ein bestimmter segmentcode o.ae.)

    • Method Detail

      • getElementTypeName

        protected abstract String getElementTypeName()
        gibt einen string mit den typnamen (msg,seg,deg,de,...) des elementes zurueck

      • getInDelim

        protected abstract char getInDelim()
        liefert das delimiter-zeichen zurueck, dass innerhalb dieses syntaxelementes benutzt wird, um die einzelnen child-elemente voneinander zu trennen

      • createNewChildContainer

        protected abstract MultipleSyntaxElements createNewChildContainer​(Node ref,
                                                                  Document document)
        erzeugt einen neuen Child-Container, welcher durch den xml-knoten 'ref' identifiziert wird; wird beim erzeugen von elementen benutzt

      • parseNewChildContainer

        protected abstract MultipleSyntaxElements parseNewChildContainer​(Node ref,
                                                                 char predelim0,
                                                                 char predelim1,
                                                                 StringBuilder res,
                                                                 int fullResLen,
                                                                 Document document,
                                                                 Map<String,​String> predefs,
                                                                 Map<String,​String> valids)
        beim parsen: haengt an die 'childElements' ein neues Element an. der xml-knoten 'ref' gibt an, um welches element es sich dabei handelt; aus 'res' (der zu parsende String) wird der wert fuer das element ermittelt (falls es sich um ein de handelt); in 'predefined' ist der wert des elementes zu finden, der laut syntaxdefinition ('document') an dieser stelle auftauchen mueste (optional; z.b. fuer segmentcodes); 'predelim*' geben die delimiter an, die direkt vor dem zu erzeugenden syntaxelement auftauchen muessten

      • storeValidValueInDE

        protected boolean storeValidValueInDE​(String destPath,
                                      String value)

      • enumerateSegs

        public int enumerateSegs​(int startValue,
                         boolean allowOverwrite)
        loop through all child-elements; the segments found there will be sequentially enumerated starting with num startValue; if startValue is zero, the segments will not be enumerated, but all given the number 0
        Parameters:
        startValue - value to be used for the first segment found
        Returns:
        next sequence number usable for enumeration

      • extractValues

        public void extractValues​(Map<String,​String> values)
        fuellt die hashtable 'values' mit den werten der de-syntaxelemente; dazu wird in allen anderen typen von syntaxelementen die liste der child-elemente durchlaufen und deren 'fillValues' methode aufgerufen

      • getChildContainers

        public List<MultipleSyntaxElements> getChildContainers()
        Returns:
        the ArrayList containing all child-elements (the elements of the ArrayList are instances of the SyntaxElementArray class

      • propagateValue

        public boolean propagateValue​(String destPath,
                              String value,
                              boolean tryToCreate,
                              boolean allowOverwrite)
        setzt den wert eines de; in allen syntaxelementen ausser DE wird dazu die liste der child-elemente durchlaufen; jedem dieser child-elemente wird der wert zum setzen uebergeben; genau _eines_ dieser elemente wird sich dafuer zustaendig fuehlen (das DE mit 'path'='destPath') und den wert uebernehmen

      • getValueOfDE

        public String getValueOfDE​(String path)
        Returns:
        den wert eines bestimmten DE; funktioniert analog zu 'propagateValue'

      • getValueOfDE

        public String getValueOfDE​(String path,
                           int zero)

      • getElement

        public SyntaxElement getElement​(String path)
        Parameters:
        path - path to the element to be returned
        Returns:
        the element identified by path

      • getPath

        public final String getPath()
        Returns:
        the path to this element

      • setPath

        protected void setPath​(String path)

      • getName

        public String getName()
        Returns:
        the name of this element (i.e. the last component of path)

      • setName

        protected void setName​(String name)

      • getType

        public String getType()

      • setType

        protected void setType​(String type)

      • getSyntaxDef

        public final Node getSyntaxDef​(String type,
                               Document document)
        Parameters:
        type - the name of the syntaxelement to be returned
        document - the structure containing the current syntaxdefinition
        Returns:
        a XML-node with the definition of the requested syntaxelement

      • isValid

        public boolean isValid()

      • setValid

        protected final void setValid​(boolean valid)

      • checkSegSeq

        public int checkSegSeq​(int value)

      • toString

        public String toString​(int zero)

      • validate

        public void validate()
        ueberpreuft, ob das syntaxelement alle restriktionen einhaelt; ist das nicht der fall, so wird eine Exception ausgeloest. die meisten syntaxelemente koennen sich nicht selbst ueberpruefen, sondern rufen statt dessen die validate-funktion der child-elemente auf

      • getElementPaths

        public void getElementPaths​(Map<String,​String> p,
                            int[] segref,
                            int[] degref,
                            int[] deref)

      • getPosInMsg

        public int getPosInMsg()