be.SIRAPRISE.messages
Class DmlExecutedMessageTypeV1_0

java.lang.Object
  extended by be.SIRAPRISE.messages.ServerMessageType
      extended by be.SIRAPRISE.messages.DmlExecutedMessageType
          extended by be.SIRAPRISE.messages.DmlExecutedMessageTypeV1_0

public final class DmlExecutedMessageTypeV1_0
extends DmlExecutedMessageType

DmlExecutedMessageTypeV1_0 is V1_0 of the DmlExecutedMessageType.

This message has the following fields :

Zone Format Length Description
RESPONSETYPE INTEGER 1 0 if the dml was an assignment (no further fields will be present), 1 if this message contains a relation value (subsequent fields will be present).
HEADING HEADING   The heading of the relation returned. The HEADING format is defined in the table below.
TUPLECOUNT INTEGER 4 The number of tuples that follow. Can be zero. Each tuple is specified as a MARKER field, followed by as many ATTRIBUTEVALUE fields as there are attributes in the heading.
MARKER INTEGER 2 Marks the beginning of a tuple value specification. Contains the value x'EEEE'.
ATTRIBUTEVALUE LSTRING   Appears as many times as there are attributes in the heading, and appears in the order that the attributes were mentioned in the description of the heading.

The heading field defines the heading/relation type of the relation returned. It is defined as follows :

Zone Format Length Description
ATTRIBUTECOUNT INTEGER 4 The number of attributes in the relation heading. This field defines how many times the subsequent ATTRIBUTENAME and TYPENAME field pairs appear. Can be zero.
ATTRIBUTENAME STRING   The name of an attribute in the heading of the relation described.
TYPENAME STRING   The name of the type of the attribute named in the preceding field. If the attribute is relation-typed, then the typename is 'RELATION' and the RELATIONTYPE field will be present. If the attribute is scalar, then the RELATIONTYPE field will not be present.
RELATIONTYPE HEADING   Defines the heading/relation type of the nonscalar attribute.

Since:
SIRA_PRISE 1.1
Author:
Erwin Smout

Field Summary
 
Fields inherited from class be.SIRAPRISE.messages.DmlExecutedMessageType
MESSAGETYPEID
 
Method Summary
 ServerMessage getDmlExecutedMessage(AbstractRelation relation)
          Factory method for getting the ServerMessage of the appropriate DmlExecuted type holding the relation holding the return values
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDmlExecutedMessage

public final ServerMessage getDmlExecutedMessage(AbstractRelation relation)
Description copied from class: DmlExecutedMessageType
Factory method for getting the ServerMessage of the appropriate DmlExecuted type holding the relation holding the return values

Specified by:
getDmlExecutedMessage in class DmlExecutedMessageType
Parameters:
relation - the relation holding the executed command's return values
Returns:
the ServerMessage of the appropriate DmlExecuted type holding the query response