com.caplin.transformer.module

Interface TransformerFlags

All Known Subinterfaces:

DataCache, TransformerContainer, TransformerData, TransformerPermission, TransformerRecord

All Known Implementing Classes:

TransformerContainerImpl, TransformerDataImpl, TransformerPermissionImpl, TransformerRecordImpl

public interface TransformerFlags

Defines flags used by DataCache.put and TransformerData.send. These flags should be ORed together if multiple flags need to be used (e.g. STORE_IN_CACHE|PUBLISH_TO_PEERS|SILENT_SEND).

The flags that are valid for DataCache.put are:

• NO_FLAGS
• STORE_IN_CACHE
• PUBLISH_TO_PEERS
• NO_PERSISTENCE
• SILENT_SEND

The flags that are valid for TransformerData.send are:

• NO_FLAGS
• STORE_IN_CACHE
• PUBLISH_TO_PEERS
• SILENT_SEND
• MAINTAIN_TIMESTAMP

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAINTAIN_TIMESTAMP Maintain the feedtime for the update.
static int	NO_FLAGS Option to use if none of the flags should be set for an object or update.
static int	NO_PERSISTENCE Do not save the object to disk when the Transformer is shutdown.
static int	PUBLISH_TO_PEERS Publish the object/update to the DataSource peers.
static int	SILENT_SEND Do not send the object/update to other Transformer modules.
static int	STORE_IN_CACHE Store the object/update within the Transformer cache.

Field Detail

NO_FLAGS

static final int NO_FLAGS

Option to use if none of the flags should be set for an object or update.

See Also:

Constant Field Values

STORE_IN_CACHE

static final int STORE_IN_CACHE

Store the object/update within the Transformer cache. This flag can be used for both objects and updates.

See Also:

Constant Field Values

PUBLISH_TO_PEERS

static final int PUBLISH_TO_PEERS

Publish the object/update to the DataSource peers. This flag can be used for both objects and updates.

See Also:

Constant Field Values

NO_PERSISTENCE

static final int NO_PERSISTENCE

Do not save the object to disk when the Transformer is shutdown. If the object is not being cached (i.e. the STORE_IN_CACHE flag is not set) then it cannot be saved to disk, even if this flag is omitted.

This flag will only be used by DataCache.put.

See Also:

Constant Field Values

SILENT_SEND

static final int SILENT_SEND

Do not send the object/update to other Transformer modules. This flag can be used for both objects and updates.

See Also:

Constant Field Values

MAINTAIN_TIMESTAMP

static final int MAINTAIN_TIMESTAMP

Maintain the feedtime for the update. The feedtime is the time that the last update was received by the Transformer core. If this flag is not set, then the feedtime will be changed to the time that the update is sent by the Transformer module to the core.

This flag will only be used by TransformerData.send.

See Also:

Constant Field Values