com::wombat::mama::MamaFieldCacheField

Inherits from com.wombat.mama.MamaFieldCacheReadOnlyField

Inherited by com.wombat.mama.MamaFieldCacheBool, com.wombat.mama.MamaFieldCacheChar, com.wombat.mama.MamaFieldCacheDateTime, com.wombat.mama.MamaFieldCacheEnum, com.wombat.mama.MamaFieldCacheFloat32, com.wombat.mama.MamaFieldCacheFloat64, com.wombat.mama.MamaFieldCacheInt16, com.wombat.mama.MamaFieldCacheInt32, com.wombat.mama.MamaFieldCacheInt64, com.wombat.mama.MamaFieldCacheInt8, com.wombat.mama.MamaFieldCachePrice, com.wombat.mama.MamaFieldCacheString, com.wombat.mama.MamaFieldCacheUint16, com.wombat.mama.MamaFieldCacheUint32, com.wombat.mama.MamaFieldCacheUint64, com.wombat.mama.MamaFieldCacheUint8

Public Functions

Public Attributes

Protected Attributes

Public Functions Documentation

function MamaFieldCacheField

inline MamaFieldCacheField(
    MamaFieldDescriptor desc,
    short type
)

Constructor. Use one of the create() methods to actually initialize the field.

function MamaFieldCacheField

inline MamaFieldCacheField(
    int fid,
    short type,
    String name,
    boolean trackModState
)

Constructor. Also create a local copy of field descriptor based on supplied info.

function copy

abstract MamaFieldCacheField copy()

Return: the copy

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::copy

Reimplemented by: com::wombat::mama::MamaFieldCacheBool::copy, com::wombat::mama::MamaFieldCacheChar::copy, com::wombat::mama::MamaFieldCacheDateTime::copy, com::wombat::mama::MamaFieldCacheEnum::copy, com::wombat::mama::MamaFieldCacheFloat32::copy, com::wombat::mama::MamaFieldCacheFloat64::copy, com::wombat::mama::MamaFieldCacheInt16::copy, com::wombat::mama::MamaFieldCacheInt32::copy, com::wombat::mama::MamaFieldCacheInt64::copy, com::wombat::mama::MamaFieldCacheInt8::copy, com::wombat::mama::MamaFieldCachePrice::copy, com::wombat::mama::MamaFieldCacheString::copy, com::wombat::mama::MamaFieldCacheUint16::copy, com::wombat::mama::MamaFieldCacheUint32::copy, com::wombat::mama::MamaFieldCacheUint64::copy, com::wombat::mama::MamaFieldCacheUint8::copy

Make a copy of this field.

function addToMessage

abstract void addToMessage(
    boolean fieldName,
    MamaMsg message
)

Reimplemented by: com::wombat::mama::MamaFieldCacheBool::addToMessage, com::wombat::mama::MamaFieldCacheChar::addToMessage, com::wombat::mama::MamaFieldCacheDateTime::addToMessage, com::wombat::mama::MamaFieldCacheEnum::addToMessage, com::wombat::mama::MamaFieldCacheFloat32::addToMessage, com::wombat::mama::MamaFieldCacheFloat64::addToMessage, com::wombat::mama::MamaFieldCacheInt16::addToMessage, com::wombat::mama::MamaFieldCacheInt32::addToMessage, com::wombat::mama::MamaFieldCacheInt64::addToMessage, com::wombat::mama::MamaFieldCacheInt8::addToMessage, com::wombat::mama::MamaFieldCachePrice::addToMessage, com::wombat::mama::MamaFieldCacheString::addToMessage, com::wombat::mama::MamaFieldCacheUint16::addToMessage, com::wombat::mama::MamaFieldCacheUint32::addToMessage, com::wombat::mama::MamaFieldCacheUint64::addToMessage, com::wombat::mama::MamaFieldCacheUint8::addToMessage

function apply

abstract void apply(
    MamaMsgField msgField
)

Reimplemented by: com::wombat::mama::MamaFieldCacheBool::apply, com::wombat::mama::MamaFieldCacheChar::apply, com::wombat::mama::MamaFieldCacheDateTime::apply, com::wombat::mama::MamaFieldCacheEnum::apply, com::wombat::mama::MamaFieldCacheFloat32::apply, com::wombat::mama::MamaFieldCacheFloat64::apply, com::wombat::mama::MamaFieldCacheInt16::apply, com::wombat::mama::MamaFieldCacheInt32::apply, com::wombat::mama::MamaFieldCacheInt64::apply, com::wombat::mama::MamaFieldCacheInt8::apply, com::wombat::mama::MamaFieldCachePrice::apply, com::wombat::mama::MamaFieldCacheString::apply, com::wombat::mama::MamaFieldCacheUint16::apply, com::wombat::mama::MamaFieldCacheUint32::apply, com::wombat::mama::MamaFieldCacheUint64::apply, com::wombat::mama::MamaFieldCacheUint8::apply

Apply the MamaMsgField to the cached field.

function getAsString

abstract String getAsString()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::getAsString

Reimplemented by: com::wombat::mama::MamaFieldCacheBool::getAsString, com::wombat::mama::MamaFieldCacheChar::getAsString, com::wombat::mama::MamaFieldCacheDateTime::getAsString, com::wombat::mama::MamaFieldCacheEnum::getAsString, com::wombat::mama::MamaFieldCacheFloat32::getAsString, com::wombat::mama::MamaFieldCacheFloat64::getAsString, com::wombat::mama::MamaFieldCacheInt16::getAsString, com::wombat::mama::MamaFieldCacheInt32::getAsString, com::wombat::mama::MamaFieldCacheInt64::getAsString, com::wombat::mama::MamaFieldCacheInt8::getAsString, com::wombat::mama::MamaFieldCachePrice::getAsString, com::wombat::mama::MamaFieldCacheString::getAsString, com::wombat::mama::MamaFieldCacheUint16::getAsString, com::wombat::mama::MamaFieldCacheUint32::getAsString, com::wombat::mama::MamaFieldCacheUint64::getAsString, com::wombat::mama::MamaFieldCacheUint8::getAsString

Create a string value of the field in the buffer provided.

function setDescriptor

inline void setDescriptor(
    MamaFieldDescriptor desc
)

Set the MamaFieldDescriptor for this field. This is an unusual thing to want to do to an existing field but it can help with performance for specialized tasks.

function getDescriptor

inline MamaFieldDescriptor getDescriptor()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::getDescriptor

Return the MamaFieldDescriptor for this field (or NULL).

function getType

inline short getType()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::getType

Return the actual field type for this field. It is possible to create fields that actually differ from the type specified in the dictionary field descriptor.

function setTrackModState

inline void setTrackModState(
    boolean state
)

Set the whether track modification state for the field

function getTrackModState

inline boolean getTrackModState()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::getTrackModState

Get the track modification state for the field

function setModState

inline void setModState(
    short state
)

Set the modification state for the field.

function clearModState

inline void clearModState()

Clear the modification state for the field (i.e., set to MOD_STATE_NOT_MODIFIED).

function getModState

inline short getModState()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::getModState

Get the modification state for the field.

function isUnmodified

inline boolean isUnmodified()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::isUnmodified

Return whether the field is unmodified.

function isModified

inline boolean isModified()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::isModified

Return whether the field is modified.

function isTouched

inline boolean isTouched()

Reimplements: com::wombat::mama::MamaFieldCacheReadOnlyField::isTouched

Return whether the field is modified.

function touch

inline void touch()

Explicitly “touch” the cached value. To touch the cached value means to mark it as modified (or touched, actually) without actually bothering to check/update the current value.

function apply

abstract void apply(
    MamaFieldCacheField value
)

Reimplemented by: com::wombat::mama::MamaFieldCacheBool::apply, com::wombat::mama::MamaFieldCacheChar::apply, com::wombat::mama::MamaFieldCacheDateTime::apply, com::wombat::mama::MamaFieldCacheEnum::apply, com::wombat::mama::MamaFieldCacheFloat32::apply, com::wombat::mama::MamaFieldCacheFloat64::apply, com::wombat::mama::MamaFieldCacheInt16::apply, com::wombat::mama::MamaFieldCacheInt32::apply, com::wombat::mama::MamaFieldCacheInt64::apply, com::wombat::mama::MamaFieldCacheInt8::apply, com::wombat::mama::MamaFieldCachePrice::apply, com::wombat::mama::MamaFieldCacheString::apply, com::wombat::mama::MamaFieldCacheUint16::apply, com::wombat::mama::MamaFieldCacheUint32::apply, com::wombat::mama::MamaFieldCacheUint64::apply, com::wombat::mama::MamaFieldCacheUint8::apply

Public Attributes Documentation

variable MOD_STATE_NOT_MODIFIED

static final short MOD_STATE_NOT_MODIFIED = 1;

variable MOD_STATE_MODIFIED

static final short MOD_STATE_MODIFIED = 2;

variable MOD_STATE_TOUCHED

static final short MOD_STATE_TOUCHED = 3;

Protected Attributes Documentation

variable mType

short mType;

variable mDesc

MamaFieldDescriptor mDesc;

variable mModState

short mModState;

variable mTrackModState

boolean mTrackModState;

variable mLocalDescriptorCopy

boolean mLocalDescriptorCopy;

Updated on 2023-03-31 at 15:29:42 +0100