be.SIRAPRISE.messages

Class DmlExecutedMessageTypeV1_0

java.lang.Object

be.SIRAPRISE.messages.ServerMessageType

be.SIRAPRISE.messages.DmlExecutedMessageType

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 :

Field detail

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 :

Field detail

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

Modifier and Type	Method and Description
ServerMessage	getAssignmentExecutedMessage() Factory method for getting the ServerMessage of the appropriate DmlExecuted type for signaling the succesful execution of an assignment
ServerMessage	getDmlExecutedMessage(RelationBuffer relationBuffer, Heading heading) Factory method for getting the ServerMessage of the appropriate DmlExecuted type holding the relation holding the return values
ServerMessage	getQueryExecutedMessage(RelationBuffer relation, Heading heading) Factory method for getting the ServerMessage of the appropriate DmlExecuted type holding the relation that is the result of a query

Methods inherited from class java.lang.Object

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

Method Detail

getAssignmentExecutedMessage

public final ServerMessage getAssignmentExecutedMessage()

Description copied from class: DmlExecutedMessageType

Factory method for getting the ServerMessage of the appropriate DmlExecuted type for signaling the succesful execution of an assignment

Specified by:

getAssignmentExecutedMessage in class DmlExecutedMessageType

Returns:

the ServerMessage of the appropriate DmlExecuted type

getDmlExecutedMessage

public final ServerMessage getDmlExecutedMessage(RelationBuffer relationBuffer,
                                                 Heading heading)

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:

relationBuffer - The buffer holding the relation to be communicated to the client

heading - The heading of the relation to be communicated to the client

Returns:

the ServerMessage of the appropriate DmlExecuted type holding the query response

getQueryExecutedMessage

public final ServerMessage getQueryExecutedMessage(RelationBuffer relation,
                                                   Heading heading)

Description copied from class: DmlExecutedMessageType

Factory method for getting the ServerMessage of the appropriate DmlExecuted type holding the relation that is the result of a query

Specified by:

getQueryExecutedMessage in class DmlExecutedMessageType

Parameters:

relation - the relation holding the executed command's return values

heading - the heading of the returned relation

Returns:

the ServerMessage of the appropriate DmlExecuted type holding the query response