org.openlowcode.tools.structure

Class SimpleDataElt

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.tools.structure.DataElt

org.openlowcode.tools.structure.SimpleDataElt

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

BooleanDataElt, ChoiceDataElt, DateDataElt, DecimalDataElt, FaultyTextDataElt, IntegerDataElt, LargeBinaryDataElt, MultipleChoiceDataElt, ObjectIdDataElt, ObjectMasterIdDataElt, TextDataElt, TimePeriodDataElt

public abstract class SimpleDataElt
extends DataElt

a data element that stores a unique value

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
SimpleDataElt(java.lang.String name, SimpleDataEltType type)
SimpleDataElt(java.lang.String name, SimpleDataEltType type, java.lang.String propertyname) Creates a simple data element

Method Summary

Modifier and Type	Method and Description
void	addPayload(MessageReader reader) for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)
abstract SimpleDataElt	cloneElt() makes a deep copy of the element
abstract java.lang.String	defaultTextRepresentation()
abstract void	forceContent(java.lang.String constraintvalue)
protected static SimpleDataElementCreator	getEltCreator(MessageReader reader)
protected abstract java.lang.Object	getMessageArrayValue()
protected abstract MessageFieldSpec	getMessageFieldSpec()
java.lang.String	getPropertyname()
void	setPropertyname(java.lang.String propertyname) sets the property name for the field (this is linked to how Open Lowcode stores data object
java.lang.String	toString()
abstract void	writePayload(MessageWriter writer) writes the payload for network transport
void	WriteSpecToMessage(MessageWriter writer)
void	writeToMessage(MessageWriter writer) writes the element for network transmission
void	writeToMessage(MessageWriter writer, java.util.HashMap<java.lang.String,NamedInterface> hiddenfields)

Methods inherited from class org.openlowcode.tools.structure.DataElt

getType, readFromCML, writeReferenceToCML

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDataElt

public SimpleDataElt(java.lang.String name,
                     SimpleDataEltType type,
                     java.lang.String propertyname)

Creates a simple data element

Parameters:

name - name of the property

type - type of the element

propertyname - name of the property

SimpleDataElt

public SimpleDataElt(java.lang.String name,
                     SimpleDataEltType type)

Parameters:

name - name of the element

type - type of the element

Method Detail

getPropertyname

public java.lang.String getPropertyname()

Returns:

the name of the property the element is part of

setPropertyname

public void setPropertyname(java.lang.String propertyname)

sets the property name for the field (this is linked to how Open Lowcode stores data object

Parameters:

propertyname - name of the property

cloneElt

public abstract SimpleDataElt cloneElt()

makes a deep copy of the element

Returns:

the deep copy

writePayload

public abstract void writePayload(MessageWriter writer)
                           throws java.io.IOException

writes the payload for network transport

Parameters:

writer - writer

Throws:

java.io.IOException - if anything wrongs happens in the message sending

defaultTextRepresentation

public abstract java.lang.String defaultTextRepresentation()

Returns:

a simple text representation for audit and log purposes

writeToMessage

public void writeToMessage(MessageWriter writer)
                    throws java.io.IOException

writes the element for network transmission

Parameters:

writer - the message writer

Throws:

java.io.IOException - in case anything goes wrong in the network transmission

WriteSpecToMessage

public void WriteSpecToMessage(MessageWriter writer)
                        throws java.io.IOException

Throws:

java.io.IOException

writeToMessage

public void writeToMessage(MessageWriter writer,
                           java.util.HashMap<java.lang.String,NamedInterface> hiddenfields)
                    throws java.io.IOException

Specified by:

writeToMessage in class DataElt

hiddenfields - if the data is made of Data Objects, it is possible to hide fields

Throws:

java.io.IOException

forceContent

public abstract void forceContent(java.lang.String constraintvalue)

Parameters:

constraintvalue - force the content in payload. May not be implemented for all the types

getMessageFieldSpec

protected abstract MessageFieldSpec getMessageFieldSpec()

Returns:

gets the Message Field Spec

getMessageArrayValue

protected abstract java.lang.Object getMessageArrayValue()

Returns:

the vale of an object in the message array

getEltCreator

protected static SimpleDataElementCreator getEltCreator(MessageReader reader)
                                                 throws OLcRemoteException,
                                                        java.io.IOException

Throws:

OLcRemoteException

java.io.IOException

addPayload

public void addPayload(MessageReader reader)
                throws OLcRemoteException,
                       java.io.IOException

Description copied from class: DataElt

for each element, should read and add content for all elements between the "TYP" field (excluded) and the "DELT" structure end (also excluded)

Specified by:

addPayload in class DataElt

Parameters:

reader - reader

Throws:

OLcRemoteException - if anything happened to the other party

java.io.IOException - if any communication error happens

toString

public java.lang.String toString()

Overrides:

toString in class DataElt