com.neeve.sto
Interface StoTypeFactory

public interface StoTypeFactory

Represents an STO type factory.

An STO type factory manufactures user types. Each type factory is uniquely identified in the system via an identifier (a short value). Factories are dynamically loaded by the STO runtime and used to reconstitute type objects on the receiving end of a messaging channel.

Field Summary

static short	TFID_NULL Signifies an 'null' type factory.
static short	TFID_PLATFORM_STATIC_LAST Identifies the last platform static factory id NOTE: BE VERY CAREFUL WHEN CHANGING THIS VALUE SINCE IT IS SYNCHRONIZED WITH THE ADM CODE GENERATOR, THE ODS OBJECT FACTORY AND SMA VIEW FACTORY.

Method Summary

StoFieldContainer[]	createCompoundArrayType(short id, int len) Instantiate an array of a compound user type.
StoFieldContainer	createCompoundType(short id, ByteBuffer buffer) Instantiate a compound user type from its serialized form.
StoFieldContainer	createCompoundType(short id, ByteBuffer buffer, boolean attach) Instantiate a compound user type from its serialized form.
short	getTfid() Get the factory's unique identifier

Field Detail

TFID_NULL

static final short TFID_NULL

Signifies an 'null' type factory.

See Also:

Constant Field Values

TFID_PLATFORM_STATIC_LAST

static final short TFID_PLATFORM_STATIC_LAST

Identifies the last platform static factory id NOTE: BE VERY CAREFUL WHEN CHANGING THIS VALUE SINCE IT IS SYNCHRONIZED WITH THE ADM CODE GENERATOR, THE ODS OBJECT FACTORY AND SMA VIEW FACTORY. IF YOU NEED TO CHANGE THIS VALUE, THEN MAKE SURE YOU MAKE THE CORRESPONDING CHANGES IN SMA, ODS AND ADM.

See Also:

Constant Field Values

Method Detail

getTfid

short getTfid()

Get the factory's unique identifier

Threading:

This method can be invoked concurrently by multiple threads.

createCompoundType

StoFieldContainer createCompoundType(short id,
                                     ByteBuffer buffer,
                                     boolean attach)

Instantiate a compound user type from its serialized form.

Parameters:

id - The type id.

buffer - The buffer containing the serialized form of the type to be created. The remaining bytes in the buffer contain the serialized type.

attach - Indicates if the supplied buffer is to be kept attached to the container post deserialization. If kept attached, then the container can optimize performance by leaving field contents in the buffer and only deserialize from the buffer on demand.

Threading:

This method can be invoked concurrently by multiple threads.

A user compound type is an object that extends StoFieldContainer. This method instantiates a compound user type.

createCompoundType

StoFieldContainer createCompoundType(short id,
                                     ByteBuffer buffer)

Instantiate a compound user type from its serialized form.

This method is a comvenience method and is equivalent to the following:
createCompoundType(id, buffer, true)

createCompoundArrayType

StoFieldContainer[] createCompoundArrayType(short id,
                                            int len)

Instantiate an array of a compound user type.

Parameters:

id - The type id.

len - The length of the array to create.

Threading:

This method can be invoked concurrently by multiple threads.