org.openlowcode.tools.messages

Class MessageReader

java.lang.Object

org.openlowcode.tools.messages.MessageReader

Direct Known Subclasses:

MessageSimpleReader

public abstract class MessageReader
extends java.lang.Object

The message reader abstract class performs all consistency controls of the message, ensuring it makes sense (e.g. that only structures that were opened are closed, and that they are closed in the correct sequence).

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
MessageReader() creates a message reader that by default will throw an OLcRemoteException if a message error is sent on the server.
MessageReader(boolean throwerror) creates a message reader

Method Summary

Modifier and Type	Method and Description
abstract long	charcountsinceStartMessage()
abstract java.lang.String	endrecord() stops recording and sends back a string of all the message received since the beginning of the recording
MessageArrayLine	getArrayNextLine()
java.lang.String	getCurrentElementPath()
MessageElement	getNextElement() END OF PROCESSING OF ARRAY
boolean	hasArrayNextLine() This convenience method should be called inside the while statement of a loop that reads all lines of the compact array.
boolean	isInMessage()
java.lang.String	returnBufferTrace() Returns the last elements read in order to be used in error handling.
boolean	returnNextBooleanField(java.lang.String name) This method will execute correctly if the next element is a boolean field of the given name, or else,throw a RuntimeException
java.util.Date	returnNextDateField(java.lang.String name) This method will execute correctly if the next element is a date field of the given name, or else,throw a RuntimeException
java.math.BigDecimal	returnNextDecimalField(java.lang.String name)
void	returnNextEndMessage() This method will execute correctly if the next element is a message end, or else,throw a RuntimeException
void	returnNextEndStructure(java.lang.String structuretoclose) This method will execute correctly if the next element is a structure end of the specified name, or else,throw a RuntimeException
int	returnNextIntegerField(java.lang.String name) This method will execute correctly if the next element is an Integer field of the given name, or else,throw a RuntimeException
SFile	returnNextLargeBinary(java.lang.String name) This method will execute correctly if the next element is a LargeBinary field of the given name, or else,throw a RuntimeException
void	returnNextMessageStart() This method will execute correctly if the next element is a message start, or else,throw a RuntimeException
MessageArrayStart	returnNextMessageStartArray(java.lang.String arrayname)
java.lang.String	returnNextStartStructure() This method will execute correctly if the next element is a structure start, or else,throw a RuntimeException
void	returnNextStartStructure(java.lang.String structurename) This method will execute correctly if the next element is a structure start if the given structurename, or else,throw a RuntimeException
java.lang.String	returnNextStringField(java.lang.String name) This method will execute correctly if the next element is a String field of the given name, or else,throw a RuntimeException
abstract void	startrecord() starts recording the message being received.
void	startStructureArray(java.lang.String arrayname) PROCESSING OF STRUCTURE ARRAY
boolean	structureArrayHasNextElement(java.lang.String arrayname)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageReader

public MessageReader()

creates a message reader that by default will throw an OLcRemoteException if a message error is sent on the server. This allows the decoder to have much more compact code.

MessageReader

public MessageReader(boolean throwerror)

creates a message reader

Parameters:

throwerror - true if the reader will throw an error when encountering a MessageError Element,

Method Detail

returnBufferTrace

public java.lang.String returnBufferTrace()

Returns the last elements read in order to be used in error handling.

Returns:

the last elements read as a compact STring.

startStructureArray

public void startStructureArray(java.lang.String arrayname)
                         throws OLcRemoteException,
                                java.io.IOException

PROCESSING OF STRUCTURE ARRAY

Throws:

OLcRemoteException

java.io.IOException

structureArrayHasNextElement

public boolean structureArrayHasNextElement(java.lang.String arrayname)
                                     throws OLcRemoteException,
                                            java.io.IOException

Parameters:

arrayname -

Returns:

Throws:

OLcRemoteException

java.io.IOException

getNextElement

public MessageElement getNextElement()
                              throws OLcRemoteException,
                                     java.io.IOException

END OF PROCESSING OF ARRAY

Throws:

OLcRemoteException

java.io.IOException

returnNextMessageStart

public void returnNextMessageStart()
                            throws OLcRemoteException,
                                   java.io.IOException

This method will execute correctly if the next element is a message start, or else,throw a RuntimeException

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextEndMessage

public void returnNextEndMessage()
                          throws OLcRemoteException,
                                 java.io.IOException

This method will execute correctly if the next element is a message end, or else,throw a RuntimeException

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextStartStructure

public java.lang.String returnNextStartStructure()
                                          throws OLcRemoteException,
                                                 java.io.IOException

This method will execute correctly if the next element is a structure start, or else,throw a RuntimeException

Returns:

the name of the start structure element

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextStartStructure

public void returnNextStartStructure(java.lang.String structurename)
                              throws OLcRemoteException,
                                     java.io.IOException

This method will execute correctly if the next element is a structure start if the given structurename, or else,throw a RuntimeException

Parameters:

structurename - name of the element

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextEndStructure

public void returnNextEndStructure(java.lang.String structuretoclose)
                            throws OLcRemoteException,
                                   java.io.IOException

This method will execute correctly if the next element is a structure end of the specified name, or else,throw a RuntimeException

Parameters:

structuretoclose - name of the element

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextDateField

public java.util.Date returnNextDateField(java.lang.String name)
                                   throws OLcRemoteException,
                                          java.io.IOException

This method will execute correctly if the next element is a date field of the given name, or else,throw a RuntimeException

Parameters:

name - name of the element

Returns:

payload of the field

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextStringField

public java.lang.String returnNextStringField(java.lang.String name)
                                       throws OLcRemoteException,
                                              java.io.IOException

This method will execute correctly if the next element is a String field of the given name, or else,throw a RuntimeException

Parameters:

name - name of the element

Returns:

payload of the field

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextLargeBinary

public SFile returnNextLargeBinary(java.lang.String name)
                            throws OLcRemoteException,
                                   java.io.IOException

This method will execute correctly if the next element is a LargeBinary field of the given name, or else,throw a RuntimeException

Parameters:

name - name of the element

Returns:

payload of the field

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextIntegerField

public int returnNextIntegerField(java.lang.String name)
                           throws OLcRemoteException,
                                  java.io.IOException

This method will execute correctly if the next element is an Integer field of the given name, or else,throw a RuntimeException

Parameters:

name - name of the element

Returns:

payload of the field

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

returnNextBooleanField

public boolean returnNextBooleanField(java.lang.String name)
                               throws OLcRemoteException,
                                      java.io.IOException

This method will execute correctly if the next element is a boolean field of the given name, or else,throw a RuntimeException

Parameters:

name - name of the element

Returns:

payload of the field

Throws:

OLcRemoteException - if an error is received from the other party

java.io.IOException - for any communication issue with the other party

getCurrentElementPath

public java.lang.String getCurrentElementPath()

Returns:

a String represnetation of the path of the current element (the hierarchical of structure names the current element is part of)

isInMessage

public boolean isInMessage()

Returns:

true if a message is currently open, false else

charcountsinceStartMessage

public abstract long charcountsinceStartMessage()

Returns:

the number of characters received since last start message

returnNextDecimalField

public java.math.BigDecimal returnNextDecimalField(java.lang.String name)
                                            throws OLcRemoteException,
                                                   java.io.IOException

Throws:

OLcRemoteException

java.io.IOException

startrecord

public abstract void startrecord()

starts recording the message being received. If recording is ongoing, the current recording is thrown away and new recording starts

endrecord

public abstract java.lang.String endrecord()

stops recording and sends back a string of all the message received since the beginning of the recording

Returns:

returnNextMessageStartArray

public MessageArrayStart returnNextMessageStartArray(java.lang.String arrayname)
                                              throws OLcRemoteException,
                                                     java.io.IOException

Parameters:

arrayname - name of the compact array structure

Returns:

the MessageArrayStart element, or throws an exception if the next element does not correspond

Throws:

OLcRemoteException - if the remote party encounters an error while processing the message

java.io.IOException - if any communication issue is encountered

hasArrayNextLine

public boolean hasArrayNextLine()
                         throws OLcRemoteException,
                                java.io.IOException

This convenience method should be called inside the while statement of a loop that reads all lines of the compact array. It reads the next element, and if this is an arrayline, stores it into a buffer so that it can be retrieved with the getArrayNextLine method

Returns:

true if a MessageArrayLine could be found, false if the array is finished

Throws:

OLcRemoteException - if the remote party encounters an error while processing the message

java.io.IOException - if any communication issue is encountered

getArrayNextLine

public MessageArrayLine getArrayNextLine()

Returns:

the MessageArrayLine stored in a local buffer after hasArrayNextLine has been called.