org.kapott.hbci.protocol

Class Message

java.lang.Object

org.kapott.hbci.protocol.SyntaxElement

org.kapott.hbci.protocol.Message

public final class Message
extends SyntaxElement

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CHECK_SEQ
static boolean	DONT_CHECK_SEQ
static boolean	DONT_CHECK_VALIDS

Fields inherited from class org.kapott.hbci.protocol.SyntaxElement

ALLOW_OVERWRITE, DONT_ALLOW_OVERWRITE, DONT_TRY_TO_CREATE, TRY_TO_CREATE

Constructor Summary

Constructors

Constructor and Description
Message(String type, Document document)
Message(String type, String res, Document document, boolean checkSeq, boolean checkValids)

Method Summary

Modifier and Type	Method and Description
void	autoSetMsgSize()
void	complete()
protected 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
String	get(String key)
Map<String,String>	getData()
Document	getDocument()
void	getElementPaths(Map<String,String> p, int[] segref, int[] degref, int[] deref)
protected String	getElementTypeName() gibt einen string mit den typnamen (msg,seg,deg,de,...) des elementes zurueck
protected char	getInDelim() liefert das delimiter-zeichen zurueck, dass innerhalb dieses syntaxelementes benutzt wird, um die einzelnen child-elemente voneinander zu trennen
String	getValueOfDE(String path)
void	init(String type, Document document)
void	init(String type, String res, Document document, boolean checkSeq, boolean checkValids)
boolean	isCrypted()
protected MultipleSyntaxElements	parseNewChildContainer(Node segref, 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.
void	rawSet(String path, String value)
void	set(String path, String value)
String	toString(int dummy)

Methods inherited from class org.kapott.hbci.protocol.SyntaxElement

checkSegSeq, createAndAppendNewChildContainer, enumerateSegs, extractValues, getChildContainers, getElement, getName, getParent, getPath, getPosInMsg, getSyntaxDef, getType, getValueOfDE, init, init, isValid, parseAndAppendNewChildContainer, propagateValue, setName, setParent, setPath, setType, setValid, storeValidValueInDE, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHECK_SEQ

public static final boolean CHECK_SEQ

See Also:

Constant Field Values

DONT_CHECK_SEQ

public static final boolean DONT_CHECK_SEQ

See Also:

Constant Field Values

DONT_CHECK_VALIDS

public static final boolean DONT_CHECK_VALIDS

See Also:

Constant Field Values

Constructor Detail

Message

public Message(String type,
               Document document)

Message

public Message(String type,
               String res,
               Document document,
               boolean checkSeq,
               boolean checkValids)

Method Detail

init

public void init(String type,
                 Document document)

createNewChildContainer

protected MultipleSyntaxElements createNewChildContainer(Node ref,
                                                         Document document)

Description copied from class: SyntaxElement

erzeugt einen neuen Child-Container, welcher durch den xml-knoten 'ref' identifiziert wird; wird beim erzeugen von elementen benutzt

Specified by:

createNewChildContainer in class SyntaxElement

getElementTypeName

protected String getElementTypeName()

Description copied from class: SyntaxElement

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

Specified by:

getElementTypeName in class SyntaxElement

autoSetMsgSize

public void autoSetMsgSize()

complete

public void complete()

toString

public String toString(int dummy)

Overrides:

toString in class SyntaxElement

init

public void init(String type,
                 String res,
                 Document document,
                 boolean checkSeq,
                 boolean checkValids)

getInDelim

protected char getInDelim()

Description copied from class: SyntaxElement

liefert das delimiter-zeichen zurueck, dass innerhalb dieses syntaxelementes benutzt wird, um die einzelnen child-elemente voneinander zu trennen

Specified by:

getInDelim in class SyntaxElement

parseNewChildContainer

protected MultipleSyntaxElements parseNewChildContainer(Node segref,
                                                        char predelim0,
                                                        char predelim1,
                                                        StringBuilder res,
                                                        int fullResLen,
                                                        Document document,
                                                        Map<String,String> predefs,
                                                        Map<String,String> valids)

Description copied from class: SyntaxElement

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

Specified by:

parseNewChildContainer in class SyntaxElement

getValueOfDE

public String getValueOfDE(String path)

Overrides:

getValueOfDE in class SyntaxElement

Returns:

den wert eines bestimmten DE; funktioniert analog zu 'propagateValue'

getData

public Map<String,String> getData()

getElementPaths

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

Overrides:

getElementPaths in class SyntaxElement

isCrypted

public boolean isCrypted()

getDocument

public Document getDocument()

set

public void set(String path,
                String value)

Parameters:

path - The path to the document element for which the value is to be set. For more information about paths, see SyntaxElement::SyntaxElement()

value - The new value for the specified element. Sets a certain property that is later used in message generation.

rawSet

public void rawSet(String path,
                   String value)

get

public String get(String key)