47e0208dfc2fc4eba1994d81c1276f8092e6ce2d tdreszer Thu Mar 24 13:54:35 2011 -0700 Renamed a bunch of mdbCv APIs to cv APIs. diff --git src/hg/inc/cv.h src/hg/inc/cv.h index 8fc6f4f..fe22532 100644 --- src/hg/inc/cv.h +++ src/hg/inc/cv.h @@ -1,69 +1,69 @@ // cv.c stands for Controlled Vocabullary and this file contains the // library API prototypes for reading and making sense of the contents of cv.ra. #ifndef CV_H #define CV_H #include "jksql.h" #define CV_FILE_NAME "cv.ra" // CV Common settings #define CV_TERM "term" #define CV_TYPE "type" #define CV_LABEL "label" #define CV_TAG "tag" // Type of Terms defines #define CV_TOT "typeOfTerm" #define CV_TOT_HIDDEN "hidden" #define CV_TOT_CV_DEFINED "cvDefined" // Validation Rules #define CV_VALIDATE "validate" #define CV_VALIDATE_CV "cv" #define CV_VALIDATE_CV_OR_NONE "cv or None" #define CV_VALIDATE_CV_OR_CONTROL "cv or control" #define CV_VALIDATE_DATE "date" #define CV_VALIDATE_EXISTS "exists" #define CV_VALIDATE_FLOAT "float" #define CV_VALIDATE_INT "integer" #define CV_VALIDATE_LIST "list:" #define CV_VALIDATE_REGEX "regex:" #define CV_VALIDATE_NONE "none" // CV TERMS (NOTE: UGLY Terms in cv.ra are hidden inside cv.c APIS) #define CV_TERM_CELL MDB_VAR_CELL #define CV_TERM_ANTIBODY MDB_VAR_ANTIBODY #define CV_TERM_CONTROL "control" -const struct hash *mdbCvTermHash(char *term); +const struct hash *cvTermHash(char *term); // returns a hash of hashes of a term which should be defined in cv.ra // NOTE: in static memory: DO NOT FREE -const struct hash *mdbCvTermTypeHash(); +const struct hash *cvTermTypeHash(); // returns a hash of hashes of mdb and controlled vocabulary (cv) term types // Those terms should contain label,descrition,searchable,cvDefined,hidden // NOTE: in static memory: DO NOT FREE -struct slPair *mdbCvWhiteList(boolean searchTracks, boolean cvLinks); +struct slPair *cvWhiteList(boolean searchTracks, boolean cvLinks); // returns the official mdb/controlled vocabulary terms that have been whitelisted for certain uses. -enum mdbCvSearchable +enum cvSearchable // metadata Variavble are only certain declared types { - cvsNotSearchable =0, // Txt is default - cvsSearchByMultiSelect =1, // Search by drop down multi-select of supplied list (NOT YET IMPLEMENTED) - cvsSearchBySingleSelect =2, // Search by drop down single-select of supplied list - cvsSearchByFreeText =3, // Search by free text field (NOT YET IMPLEMENTED) - cvsSearchByDateRange =4, // Search by discovered date range (NOT YET IMPLEMENTED) - cvsSearchByIntegerRange =5 // Search by discovered integer range (NOT YET IMPLEMENTED) + cvNotSearchable =0, // Txt is default + cvSearchByMultiSelect =1, // Search by drop down multi-select of supplied list (NOT YET IMPLEMENTED) + cvSearchBySingleSelect =2, // Search by drop down single-select of supplied list + cvSearchByFreeText =3, // Search by free text field (NOT YET IMPLEMENTED) + cvSearchByDateRange =4, // Search by discovered date range (NOT YET IMPLEMENTED) + cvSearchByIntegerRange =5 // Search by discovered integer range (NOT YET IMPLEMENTED) }; -enum mdbCvSearchable mdbCvSearchMethod(char *term); -// returns whether the term is searchable // TODO: replace with mdbCvWhiteList() returning struct +enum cvSearchable cvSearchMethod(char *term); +// returns whether the term is searchable const char *cvLabel(char *term); // returns cv label if term found or else just term #endif /* CV_H */