MasterTable Class Reference

#include <MasterTable.h>

Collaboration diagram for MasterTable:

Public Member Functions
	MasterTable ()
	~MasterTable ()
ion_err_t	initializeMasterTable ()
	Opens the master table. More...
ion_err_t	closeMasterTable ()
	Closes the master table. More...
ion_err_t	closeAllMasterTable ()
	Closes the master table and all dictionary instances in it. More...
ion_err_t	deleteMasterTable ()
	Deletes the master table. More...
template<typename K , typename V >
ion_err_t	addToMasterTable (Dictionary< K, V > *dictionary, ion_dictionary_size_t dictionary_size)
	Adds the given dictionary to the master table. More...
ion_dictionary_id_t	getNextID ()
	Returns the next dictionary ID. More...
ion_err_t	initializeHandler (ion_dictionary_type_t type)
	Retrieves the type of dictionary stored under a particular id in the master table. More...
ion_err_t	lookupMasterTable (ion_dictionary_id_t id, ion_dictionary_config_info_t *config)
	Looks up the config of the given id. More...
ion_err_t	findByUse (ion_dictionary_config_info_t *config, ion_dict_use_t use_type, char whence)
	Find first or last dictionary in master table with a given use. More...
ion_err_t	deleteFromMasterTable (ion_dictionary_id_t id)
	Deletes a dictionary from the master table. More...
template<typename K , typename V >
ion_err_t	openDictionary (Dictionary< K, V > *dictionary, ion_dictionary_id_t id)
	Finds the target dictionary and opens it. More...
template<typename K , typename V >
ion_err_t	closeDictionary (Dictionary< K, V > *dictionary)
	Closes a given dictionary. More...
template<typename K , typename V >
Dictionary< K, V > *	initializeDictionary (ion_key_type_t key_type, K k, V v, ion_key_size_t key_size, ion_value_size_t value_size, ion_dictionary_size_t dictionary_size, ion_dictionary_type_t dictionary_type)
	Creates a dictionary of a specified implementation. More...
template<typename K , typename V >
ion_err_t	deleteDictionary (Dictionary< K, V > *dictionary)

Public Attributes
ion_dictionary_handler_t	handler

Detailed Description

Definition at line 50 of file MasterTable.h.

Constructor & Destructor Documentation

MasterTable::MasterTable ( )

inline

Definition at line 55 of file MasterTable.h.

  {
    this->initializeMasterTable();
}

Here is the call graph for this function:

MasterTable::~MasterTable ( )

inline

Definition at line 60 of file MasterTable.h.

  {
    this->deleteMasterTable();
}

Here is the call graph for this function:

Member Function Documentation

template<typename K , typename V >

ion_err_t MasterTable::addToMasterTable ( Dictionary< K, V > *  dictionary, ion_dictionary_size_t  dictionary_size  )

inline

Adds the given dictionary to the master table.

Parameters

dictionary	A pointer to the dictionary object to add to the master table.
dictionary_size	The implementation specific size parameter used when creating the dictionary. This parameter must be passed to this function by ion_master_table_create_dictionary, since not all implementations track the dictionary size.

Definition at line 120 of file MasterTable.h.

  {
    ion_dictionary_id_t id;

    ion_err_t err = ion_master_table_get_next_id(&id);

    if (err_ok != err) {
        return err;
    }

    dictionary->dict.instance->id = id;

    ion_dictionary_config_info_t config = {
        .id = dictionary->dict.instance->id, .use_type = 0, .type = dictionary->dict.instance->key_type, .key_size = dictionary->dict.instance->record.key_size, .value_size = dictionary->dict.instance->record.value_size, .dictionary_size = dictionary_size, .dictionary_type = dictionary->dict.instance->type
    };

    return ion_master_table_write(&config, ION_MASTER_TABLE_WRITE_FROM_END);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ion_err_t MasterTable::closeAllMasterTable ( )

inline

Closes the master table and all dictionary instances in it.

For this method to work properly, all dictionary instances must already be closed or must have been closed previously and are now re-opened.

Returns

An error code describing the result of the operation.

Definition at line 93 of file MasterTable.h.

  {
    return ion_close_all_master_table();
}

Here is the call graph for this function:

template<typename K , typename V >

ion_err_t MasterTable::closeDictionary ( Dictionary< K, V > *  dictionary )

inline

Closes a given dictionary.

Parameters

dictionary

A pointer to an allocated dictionary object, which will be closed.

Returns

An error code describing the result of the operation.

Definition at line 268 of file MasterTable.h.

  {
    ion_err_t err = dictionary->close();

    return err;
}

Here is the call graph for this function:

ion_err_t MasterTable::closeMasterTable ( )

inline

Closes the master table.

Returns

An error code describing the result of the operation.

Definition at line 81 of file MasterTable.h.

  {
    return ion_close_master_table();
}

Here is the call graph for this function:

template<typename K , typename V >

ion_err_t MasterTable::deleteDictionary ( Dictionary< K, V > *  dictionary )

inline

Definition at line 372 of file MasterTable.h.

  {
    ion_dictionary_id_t id = dictionary->dict.instance->id;

    delete dictionary;

    return ion_delete_from_master_table(id);
}

Here is the call graph for this function:

ion_err_t MasterTable::deleteFromMasterTable ( ion_dictionary_id_t  id )

inline

Deletes a dictionary from the master table.

Returns

An error code describing the result of the operation.

Definition at line 214 of file MasterTable.h.

  {
    return ion_delete_from_master_table(id);
}

Here is the call graph for this function:

ion_err_t MasterTable::deleteMasterTable ( )

inline

Deletes the master table.

Returns

An error code describing the result of the operation.

Definition at line 103 of file MasterTable.h.

  {
    return ion_delete_master_table();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ion_err_t MasterTable::findByUse ( ion_dictionary_config_info_t *  config, ion_dict_use_t  use_type, char  whence  )

inline

Find first or last dictionary in master table with a given use.

Parameters

config	A pointer to an already allocated configuration object that will be used to open the found dictionary.
use_type	The integral usage type for the dictionary. This is user defined.
whence	Whether to find the first or the last dictionary having use_type. This can take exactly two values, ION_MASTER_TABLE_FIND_FIRST or ION_MASTER_TABLE_FIND_LAST.

Returns

err_ok if a dictionary having usage type use_type is found, otherwise an error code properly describing the situation and outcome.

Definition at line 201 of file MasterTable.h.

  {
    return ion_find_by_use_master_table(config, use_type, whence);
}

Here is the call graph for this function:

ion_dictionary_id_t MasterTable::getNextID ( )

inline

Returns the next dictionary ID.

Returns

The next ID to be used by the master table.

Definition at line 146 of file MasterTable.h.

  {
    return ion_master_table_next_id;
}

template<typename K , typename V >

Dictionary<K, V>* MasterTable::initializeDictionary ( ion_key_type_t  key_type, K  k, V  v, ion_key_size_t  key_size, ion_value_size_t  value_size, ion_dictionary_size_t  dictionary_size, ion_dictionary_type_t  dictionary_type  )

inline

Creates a dictionary of a specified implementation.

This method is not currently used for creation of a C++ dictionary.

Parameters

key_type	The type of key to be used with this dictionary, which determines the key comparison operator.
k	The type of key to be used with this dictionary.
v	The type of value to be used with this dictionary.
key_size	The size of the key type to be used with this dictionary.
value_size	The size of the value type to be used with this dictionary.
dictionary_size	The dictionary implementation specific dictionary size parameter.
dictionary_type	The type of dictionary to be created.

Returns

An error code describing the result of the operation.

Definition at line 299 of file MasterTable.h.

  {
    UNUSED(k);
    UNUSED(v);

    Dictionary<K, V> *dictionary;

    ion_dictionary_id_t id = ion_master_table_next_id;

    switch (dictionary_type) {
        case dictionary_type_bpp_tree_t: {
            dictionary = new BppTree<K, V>(id, key_type, key_size, value_size);

            break;
        }

        case dictionary_type_flat_file_t: {
            dictionary = new FlatFile<K, V>(id, key_type, key_size, value_size, dictionary_size);

            break;
        }

        case dictionary_type_open_address_file_hash_t: {
            dictionary = new OpenAddressFileHash<K, V>(id, key_type, key_size, value_size, dictionary_size);

            break;
        }

        case dictionary_type_open_address_hash_t: {
            dictionary = new OpenAddressHash<K, V>(id, key_type, key_size, value_size, dictionary_size);

            break;
        }

        case dictionary_type_skip_list_t: {
            dictionary = new SkipList<K, V>(id, key_type, key_size, value_size, dictionary_size);

            break;
        }

        case dictionary_type_linear_hash_t: {
            dictionary = new LinearHash<K, V>(id, key_type, key_size, value_size, dictionary_size);

            break;
        }

        case dictionary_type_error_t: {
            dictionary              = new SkipList<K, V>(id, key_type, key_size, value_size, dictionary_size);
            dictionary->dict.status = ion_dictionary_status_error;
            break;
        }
    }

    if ((dictionary_type != dictionary_type_error_t) && (ion_dictionary_status_error != dictionary->dict.status)) {
        ion_err_t err = addToMasterTable(dictionary, dictionary_size);

        if (err_ok != err) {
            dictionary->dict.status = ion_dictionary_status_error;
        }
    }

    return dictionary;
}

Here is the call graph for this function:

ion_err_t MasterTable::initializeHandler ( ion_dictionary_type_t  type )

inline

Retrieves the type of dictionary stored under a particular id in the master table.

Parameters

type	The type of dictionary instance to initialize the handler to.

Returns

An error code describing the result of the operation.

Definition at line 159 of file MasterTable.h.

  {
    return ion_switch_handler(type, &handler);
}

Here is the call graph for this function:

ion_err_t MasterTable::initializeMasterTable ( )

inline

Opens the master table.

Can be safely called multiple times without closing.

Returns

An error code describing the result of the operation.

Definition at line 71 of file MasterTable.h.

  {
    return ion_init_master_table();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ion_err_t MasterTable::lookupMasterTable ( ion_dictionary_id_t  id, ion_dictionary_config_info_t *  config  )

inline

Looks up the config of the given id.

Parameters

id	The identifier identifying the dictionary metadata in the master table which is to be looked up.
config	A pointer to an already allocated configuration object that will be read into from the master table.

Returns

An error code describing the result of the operation.

Definition at line 176 of file MasterTable.h.

  {
    return ion_lookup_in_master_table(id, config);
}

Here is the call graph for this function:

template<typename K , typename V >

ion_err_t MasterTable::openDictionary ( Dictionary< K, V > *  dictionary, ion_dictionary_id_t  id  )

inline

Finds the target dictionary and opens it.

Parameters

dictionary	A pointer to an allocated dictionary object, which will be opened.
id	The identifier identifying the dictionary metadata in the master table.

Returns

An error code describing the result of the operation.

Definition at line 232 of file MasterTable.h.

  {
    ion_err_t                       err;
    ion_dictionary_config_info_t    config;

    err = ion_lookup_in_master_table(id, &config);

    /* Lookup for id failed. */
    if (err_ok != err) {
        return err_uninitialized;
    }

    err = ion_switch_handler(config.dictionary_type, &handler);

    if (err_ok != err) {
        return err;
    }

    dictionary->dict.handler    = &handler;

    err                         = dictionary->open(config);

    return err;
}

Here is the call graph for this function:

Member Data Documentation

ion_dictionary_handler_t MasterTable::handler

Definition at line 53 of file MasterTable.h.

---

The documentation for this class was generated from the following file:

• MasterTable.h