obiblob_indexer.h 4.16 KB
Newer Older
Celine Mercier committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/****************************************************************************
 * Blob indexer header file	                                                    *
 ****************************************************************************/

/**
 * @file obiblob_indexer.h
 * @author Celine Mercier
 * @date April 12th 2016
 * @brief Header file for the functions handling the indexing of values.
 */


#ifndef OBIBLOB_INDEXER_H_
#define OBIBLOB_INDEXER_H_


#include <stdlib.h>
#include <stdio.h>

#include "obidms.h"
#include "obiavl.h"
#include "obitypes.h"
#include "obiblob.h"


#define INDEXER_MAX_NAME AVL_MAX_NAME 			/**< Macro to refer to the maximum size of the name of an indexer structure.
 	 	 	 	 	 	 	 	 	 	 	 	 */


30 31 32
typedef struct OBIDMS_avl_group Obi_indexer;	/**< Typedef to refer to the used indexer structure.
 	 	 	 	 	 	 	 	 	 	 	 	 */
typedef OBIDMS_avl_group_p Obi_indexer_p; 		/**< Typedef to refer to the pointer of the used indexer structure.
Celine Mercier committed
33 34 35
 	 	 	 	 	 	 	 	 	 	 	 	 */


36 37 38 39 40 41 42 43 44 45 46 47 48 49
/**
 * @brief Checks if an indexer already exists or not.
 *
 * @param dms The OBIDMS to which the indexer belongs.
 * @param name The name of the indexer.
 *
 * @returns A value indicating whether the indexer exists or not.
 * @retval 1 if the indexer exists.
 * @retval 0 if the indexer does not exist.
 * @retval -1 if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
50
#define obi_indexer_exists obi_avl_exists
Celine Mercier committed
51 52


53 54 55 56 57 58 59 60 61 62 63 64
/**
 * @brief Opens an indexer and creates it if it does not already exist.
 *
 * @param dms The OBIDMS to which the indexer belongs.
 * @param name The name of the indexer.
 *
 * @returns A pointer to the indexer structure.
 * @retval NULL if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
65
#define obi_indexer obi_avl_group
Celine Mercier committed
66 67


68 69 70 71 72 73 74 75 76 77 78 79
/**
 * @brief Creates an indexer.
 *
 * @param dms The OBIDMS to which the indexer belongs.
 * @param name The name of the indexer.
 *
 * @returns A pointer to the AVL tree group structure.
 * @retval NULL if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
80
#define obi_create_indexer obi_create_avl_group
Celine Mercier committed
81 82


83 84 85 86 87 88 89 90 91 92 93 94
/**
 * @brief Opens an indexer.
 *
 * @param dms The OBIDMS to which the indexer belongs.
 * @param name The name of the indexer.
 *
 * @returns A pointer to the indexer structure.
 * @retval NULL if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
95
#define obi_open_indexer obi_open_avl_group
Celine Mercier committed
96 97


98 99 100 101 102 103 104 105 106 107 108
/**
 * @brief Closes an indexer.
 *
 * @param indexer A pointer to the indexer structure to close and free.
 *
 * @retval 0 if the operation was successfully completed.
 * @retval -1 if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
109
#define obi_close_indexer obi_close_avl_group
Celine Mercier committed
110 111


112 113 114 115 116 117 118 119 120 121 122 123
/**
 * @brief Indexes a blob in an indexer and returns the index referring to the blob.
 *
 * @param indexer A pointer to the indexer.
 * @param value The blob to index.
 *
 * @returns The index of the blob newly added in the indexer.
 * @retval -1 if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
124
#define obi_indexer_add obi_avl_group_add
Celine Mercier committed
125 126


127 128 129 130 131 132 133 134 135 136 137
/**
 * @brief Recovers a blob from an indexer.
 *
 * @param indexer A pointer to the indexer.
 * @param index The index of the blob in the indexer.
 *
 * @returns A pointer to the blob recovered.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
138
#define obi_indexer_get obi_avl_group_get
Celine Mercier committed
139 140


141 142 143
/**
 * @brief Builds an indexer name in the form columnname_columnversion_indexer.
 *
144 145
 * @warning The returned pointer has to be freed by the caller.
 *
146 147 148 149 150 151 152 153 154
 * @param column_name The name of the column associated with the indexer.
 * @param column_version The version of the column associated with the indexer.
 *
 * @returns A pointer on the indexer name built.
 * @retval NULL if an error occurred.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
155
char* obi_build_indexer_name(const char* column_name, obiversion_t column_version);
156 157


Celine Mercier committed
158 159
#endif /* OBIBLOB_INDEXER_H_ */