org.openlowcode.tools.structure

Class ObjectIdDataElt

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.tools.structure.DataElt

org.openlowcode.tools.structure.SimpleDataElt

org.openlowcode.tools.structure.ObjectIdDataElt

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

TObjectIdDataElt

public class ObjectIdDataElt
extends SimpleDataElt

a data element that stores the uniqueid of an object

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ObjectIdDataElt(java.lang.String name) creates an empty objectid data element
ObjectIdDataElt(java.lang.String name, ObjectIdInterface objectid)
ObjectIdDataElt(java.lang.String name, java.lang.String id)
ObjectIdDataElt(java.lang.String name, java.lang.String id, java.lang.String objectid)

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)
ObjectIdDataElt	cloneElt() makes a deep copy of the element
java.lang.String	defaultTextRepresentation()
boolean	equals(java.lang.Object other)
void	forceContent(java.lang.String constraintvalue)
java.lang.String	getId()
protected java.lang.Object	getMessageArrayValue()
protected MessageFieldSpec	getMessageFieldSpec()
java.lang.String	getObjectId()
void	writePayload(MessageWriter writer) writes the payload for network transport

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

getEltCreator, getPropertyname, setPropertyname, toString, WriteSpecToMessage, writeToMessage, writeToMessage

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

getType, readFromCML, writeReferenceToCML

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

changeName, cleanName, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectIdDataElt

public ObjectIdDataElt(java.lang.String name)

creates an empty objectid data element

Parameters:

name - name of the element

ObjectIdDataElt

public ObjectIdDataElt(java.lang.String name,
                       java.lang.String id,
                       java.lang.String objectid)

Parameters:

name - name of the element

id - id of the individual (instance) object

objectid - type of object (id of the class of object)

ObjectIdDataElt

public ObjectIdDataElt(java.lang.String name,
                       java.lang.String id)

Parameters:

name - name of the element

id - if of the invidicual (instance) object

ObjectIdDataElt

public ObjectIdDataElt(java.lang.String name,
                       ObjectIdInterface objectid)

Parameters:

name - name of the element

objectid - a specific object with the interface of the Object Id

Method Detail

getId

public java.lang.String getId()

Returns:

the id of the individual object

getObjectId

public java.lang.String getObjectId()

Returns:

the type of the object

writePayload

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

Description copied from class: SimpleDataElt

writes the payload for network transport

Specified by:

writePayload in class SimpleDataElt

Parameters:

writer - writer

Throws:

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

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)

Overrides:

addPayload in class SimpleDataElt

Parameters:

reader - reader

Throws:

OLcRemoteException - if anything happened to the other party

java.io.IOException - if any communication error happens

defaultTextRepresentation

public java.lang.String defaultTextRepresentation()

Specified by:

defaultTextRepresentation in class SimpleDataElt

Returns:

a simple text representation for audit and log purposes

cloneElt

public ObjectIdDataElt cloneElt()

Description copied from class: SimpleDataElt

makes a deep copy of the element

Specified by:

cloneElt in class SimpleDataElt

Returns:

the deep copy

forceContent

public void forceContent(java.lang.String constraintvalue)

Specified by:

forceContent in class SimpleDataElt

Parameters:

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

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Named

getMessageFieldSpec

protected MessageFieldSpec getMessageFieldSpec()

Specified by:

getMessageFieldSpec in class SimpleDataElt

Returns:

gets the Message Field Spec

getMessageArrayValue

protected java.lang.Object getMessageArrayValue()

Specified by:

getMessageArrayValue in class SimpleDataElt

Returns:

the vale of an object in the message array