KeyValue Class Reference

This class stores the value of the key of a row. More...

#include <KeyValue.h>

Inheritance diagram for KeyValue:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 KeyValue (KeyImplPtr key, value_type value)
 Constructs a new KeyValue for to the specified field with the specified value.
 ~KeyValue ()
 Destructor, a noop.
KeyImplPtr getKeyImpl () const
 Returns what field this key belongs to.
bool isKey () const
 Returns that this is a key.
bool isPrimaryKey () const
 Whether this is a primary key.
bool isDirty () const
 Wether there are any unsaved changes to this key.
void setDirty (bool dirty)
 Sets wether there are any unsaved changes to this key.


Detailed Description

This class stores the value of the key of a row.

It may be used as if it were a regular Value object. Calls to getStringValue are illegal, but this is already asserted due to the field not being a text field.

See also:
Value

Definition at line 40 of file KeyValue.h.


Constructor & Destructor Documentation

KeyValue::KeyValue ( KeyImplPtr  key,
value_type  value 
)

Constructs a new KeyValue for to the specified field with the specified value.

KeyValue::~KeyValue (  ) 

Destructor, a noop.


Member Function Documentation

KeyImplPtr KeyValue::getKeyImpl (  )  const

Returns what field this key belongs to.

bool KeyValue::isKey (  )  const [inline, virtual]

Returns that this is a key.

Reimplemented from FieldValue.

Definition at line 55 of file KeyValue.h.

bool KeyValue::isPrimaryKey (  )  const

Whether this is a primary key.

bool KeyValue::isDirty (  )  const

Wether there are any unsaved changes to this key.

Reimplemented from FieldValue.

void KeyValue::setDirty ( bool  dirty  ) 

Sets wether there are any unsaved changes to this key.

Reimplemented from FieldValue.


Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo