#include <Dictionary.h>

Inheritance diagram for Dictionary< K, V >:

Collaboration diagram for Dictionary< K, V >:

Public Member Functions
	~Dictionary ()

ion_err_t	initializeDictionary (ion_dictionary_id_t dict_id, ion_key_type_t k_type, ion_key_size_t k_size, ion_value_size_t v_size, ion_dictionary_size_t dictionary_size)
	Creates a dictionary with a specific identifier (for use through the master table). More...

ion_status_t	insert (K key, V value)
	Insert a value into a dictionary. More...

V	get (K key)
	Retrieve a value given a key. More...

ion_status_t	deleteRecord (K key)
	Delete a value given a key. More...

ion_status_t	update (K key, V value)
	Update all records with a given key. More...

ion_err_t	deleteDictionary ()
	Deletes dictionary. More...

ion_err_t	destroyDictionary (ion_dictionary_id_t id)
	Destroys dictionary. More...

ion_err_t	open (ion_dictionary_config_info_t config_info)
	Opens a dictionary, given the desired config. More...

ion_err_t	close ()
	Closes a dictionary. More...

Cursor< K, V > *	range (K min_key, K max_key)
	Sets up cursor and predicate to perform a range query on a dictionary. More...

Cursor< K, V > *	equality (K key)
	Sets up cursor and predicate perform an equality query on a dictionary for a given key. More...

Cursor< K, V > *	allRecords ()
	Sets up cursor and predicate in order to find all records present in the dictionary. More...

Public Attributes
ion_dictionary_handler_t	handler

ion_dictionary_t	dict

ion_key_type_t	key_type

ion_key_size_t	key_size

ion_value_size_t	value_size

ion_dictionary_size_t	dict_size

ion_status_t	last_status

Detailed Description

template<typename K, typename V>
class Dictionary< K, V >

Definition at line 49 of file Dictionary.h.

Constructor & Destructor Documentation

template<typename K, typename V>

Dictionary< K, V >::~Dictionary ( )

inline

Definition at line 60 of file Dictionary.h.

   {
     this->deleteDictionary();
 }

Here is the call graph for this function:

Member Function Documentation

template<typename K, typename V>

Cursor<K, V>* Dictionary< K, V >::allRecords ( )

inline

Sets up cursor and predicate in order to find all records present in the dictionary.

Returns: An initialized cursor for the particular query.

Definition at line 306 of file Dictionary.h.

   {
     ion_predicate_t predicate;
 
     dictionary_build_predicate(&predicate, predicate_all_records);
     return new Cursor<K, V>(&dict, &predicate);
 }

Here is the call graph for this function:

template<typename K, typename V>

ion_err_t Dictionary< K, V >::close ( )

inline

Closes a dictionary.

Definition at line 248 of file Dictionary.h.

   {
     ion_err_t err = dictionary_close(&dict);
 
     last_status.error = err;
 
     return err;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename K, typename V>

ion_err_t Dictionary< K, V >::deleteDictionary ( )

inline

Deletes dictionary.

Returns: An error message describing the total destruction of the dictionary.

Definition at line 196 of file Dictionary.h.

   {
     ion_err_t err = dictionary_delete_dictionary(&dict);
 
     last_status.error = err;
 
     return err;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename K, typename V>

ion_status_t Dictionary< K, V >::deleteRecord ( K key )

inline

Delete a value given a key.

Parameters

key	The key to be deleted.

Returns: An error message describing the result of the deletion.

Definition at line 156 of file Dictionary.h.

   {
     ion_key_t       ion_key = &key;
     ion_status_t    status  = dictionary_delete(&dict, ion_key);
 
     this->last_status = status;
 
     return status;
 }

Here is the call graph for this function:

template<typename K, typename V>

ion_err_t Dictionary< K, V >::destroyDictionary ( ion_dictionary_id_t id )

inline

Destroys dictionary.

Parameters

id	The identifier identifying the dictionary to destroy.

Returns: The status of the total destruction of the dictionary.

Definition at line 212 of file Dictionary.h.

   {
     ion_err_t error = dictionary_destroy_dictionary(&handler, id);
 
     last_status.error = error;
 
     return error;
 }

Here is the call graph for this function:

template<typename K, typename V>

Cursor<K, V>* Dictionary< K, V >::equality ( K key )

inline

Sets up cursor and predicate perform an equality query on a dictionary for a given key.

Parameters

key	The key used to determine equality.

Returns: An initialized cursor for the particular query.

Definition at line 289 of file Dictionary.h.

   {
     ion_predicate_t predicate;
     ion_key_t       ion_key = &key;
 
     dictionary_build_predicate(&predicate, predicate_equality, ion_key);
     return new Cursor<K, V>(&dict, &predicate);
 }

Here is the call graph for this function:

template<typename K, typename V>

V Dictionary< K, V >::get ( K key )

inline

Retrieve a value given a key.

Parameters

key	The key to retrieve the value for.

Returns: value A pointer to the value byte array to copy data into.

Definition at line 137 of file Dictionary.h.

   {
     ion_key_t   ion_key = &key;
     ion_byte_t  ion_value[dict.instance->record.value_size];
 
     this->last_status = dictionary_get(&dict, ion_key, ion_value);
 
     return *((V *) ion_value);
 }

Here is the call graph for this function:

template<typename K, typename V>

ion_err_t Dictionary< K, V >::initializeDictionary	(	ion_dictionary_id_t	dict_id,
		ion_key_type_t	k_type,
		ion_key_size_t	k_size,
		ion_value_size_t	v_size,
		ion_dictionary_size_t	dictionary_size
	)

inline

Creates a dictionary with a specific identifier (for use through the master table).

Parameters

dict_id	A unique identifier important for use of the dictionary through the master table. If the dictionary is being created without the master table, this identifier can be 0.
k_type	The type of key to be used with this dictionary, which determines the key comparison operator.
k_size	The size of the key type to be used with this dictionary.
v_size	The size of the value type to be used with this dictionary.
dictionary_size	The dictionary implementation specific dictionary size parameter.

Returns: An error code describing the result of the operation.

Definition at line 85 of file Dictionary.h.

   {
     key_type    = k_type;
     key_size    = k_size;
     value_size  = v_size;
     dict_size   = dictionary_size;
 
     ion_err_t err = dictionary_create(&handler, &dict, dict_id, k_type, k_size, v_size, dictionary_size);
 
     last_status.error = err;
 
     return err;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename K, typename V>

ion_status_t Dictionary< K, V >::insert	(	K	key,
		V	value
	)

inline

Insert a value into a dictionary.

Parameters

key	The key that identifies `value`.
value	The value to store under `key`.

Returns: An error message describing the result of the insertion.

Definition at line 114 of file Dictionary.h.

   {
     ion_key_t   ion_key     = &key;
     ion_value_t ion_value   = &value;
 
     ion_status_t status     = dictionary_insert(&dict, ion_key, ion_value);
 
     this->last_status = status;
 
     return status;
 }

Here is the call graph for this function:

template<typename K, typename V>

ion_err_t Dictionary< K, V >::open ( ion_dictionary_config_info_t config_info )

inline

Opens a dictionary, given the desired config.

Parameters

config_info The configuration of the dictionary to be opened.

Returns: An error message describing the result of of the open.

Definition at line 230 of file Dictionary.h.

   {
     ion_err_t err = dictionary_open(&handler, &dict, &config_info);
 
     key_type            = config_info.type;
     key_size            = config_info.key_size;
     value_size          = config_info.value_size;
     dict_size           = config_info.dictionary_size;
     last_status.error   = err;
 
     return err;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename K, typename V>

Cursor<K, V>* Dictionary< K, V >::range	(	K	min_key,
		K	max_key
	)

inline

Sets up cursor and predicate to perform a range query on a dictionary.

Parameters

min_key	The minimum key to be included in the query.
max_key	The maximum key to be included in the query.

Returns: An initialized cursor for the particular query.

Definition at line 268 of file Dictionary.h.

   {
     ion_predicate_t predicate;
     ion_key_t       ion_min_key = &min_key;
     ion_key_t       ion_max_key = &max_key;
 
     dictionary_build_predicate(&predicate, predicate_range, ion_min_key, ion_max_key);
     return new Cursor<K, V>(&dict, &predicate);
 }

Here is the call graph for this function:

template<typename K, typename V>

ion_status_t Dictionary< K, V >::update	(	K	key,
		V	value
	)

inline

Update all records with a given key.

Parameters

key	The key to identify records for updating.
value	The value to update records with.

Returns: An error message describing the result of the update.

Definition at line 177 of file Dictionary.h.

   {
     ion_key_t       ion_key     = &key;
     ion_value_t     ion_value   = &value;
     ion_status_t    status      = dictionary_update(&dict, ion_key, ion_value);
 
     this->last_status = status;
 
     return status;
 }