IDZEBRA  2.1.2
Data Structures | Macros | Typedefs | Enumerations | Functions
recctrl.h File Reference
#include <sys/types.h>
#include <yaz/proto.h>
#include <yaz/odr.h>
#include <idzebra/res.h>
#include <idzebra/data1.h>
#include <idzebra/snippet.h>

Go to the source code of this file.

Data Structures

struct  RecWord
 
struct  ZebraRecStream
 record reader stream More...
 
struct  recExtractCtrl
 record extract for indexing More...
 
struct  recRetrieveCtrl
 
struct  recType
 

Macros

#define ZEBRA_XPATH_ELM_BEGIN   "_XPATH_BEGIN"
 
#define ZEBRA_XPATH_ELM_END   "_XPATH_END"
 
#define ZEBRA_XPATH_CDATA   "_XPATH_CDATA"
 
#define ZEBRA_XPATH_ATTR_NAME   "_XPATH_ATTR_NAME"
 
#define ZEBRA_XPATH_ATTR_CDATA   "_XPATH_ATTR_CDATA"
 
#define ZEBRA_GROUP_INDEX_NAME   "_GROUP_"
 
#define RECCTRL_EXTRACT_OK   0
 
#define RECCTRL_EXTRACT_EOF   1
 
#define RECCTRL_EXTRACT_ERROR_GENERIC   2
 
#define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER   3
 
#define RECCTRL_EXTRACT_SKIP   4
 

Typedefs

typedef struct recTypeRecType
 
typedef struct recTypeClassRecTypeClass
 
typedef struct recTypesRecTypes
 

Enumerations

enum  zebra_recctrl_action_t {
  action_insert = 1, action_replace, action_delete, action_update,
  action_a_delete
}
 

Functions

RecTypeClass recTypeClass_create (Res res, NMEM nmem)
 
void recTypeClass_load_modules (RecTypeClass *rts, NMEM nmem, const char *module_path)
 
RecTypeClass recTypeClass_add_modules (Res res, NMEM nmem, const char *module_path)
 
void recTypeClass_destroy (RecTypeClass rtc)
 
void recTypeClass_info (RecTypeClass rtc, void *cd, void(*cb)(void *cd, const char *s))
 
RecTypes recTypes_init (RecTypeClass rtc, data1_handle dh)
 
void recTypes_destroy (RecTypes recTypes)
 
void recTypes_default_handlers (RecTypes recTypes, Res res)
 
RecType recType_byName (RecTypes rts, Res res, const char *name, void **clientDataP)
 

Macro Definition Documentation

#define RECCTRL_EXTRACT_EOF   1
#define RECCTRL_EXTRACT_ERROR_GENERIC   2
#define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER   3

Definition at line 166 of file recctrl.h.

Referenced by zebra_extract_record_stream().

#define RECCTRL_EXTRACT_OK   0
#define RECCTRL_EXTRACT_SKIP   4

Definition at line 167 of file recctrl.h.

Referenced by convert_extract_doc(), and zebra_extract_record_stream().

#define ZEBRA_GROUP_INDEX_NAME   "_GROUP_"

Definition at line 47 of file recctrl.h.

Referenced by process_xml_element_zebra_node(), and search_group().

#define ZEBRA_XPATH_ATTR_CDATA   "_XPATH_ATTR_CDATA"

Definition at line 45 of file recctrl.h.

Referenced by index_xpath_attr(), and rpn_search_database().

#define ZEBRA_XPATH_ATTR_NAME   "_XPATH_ATTR_NAME"

Definition at line 42 of file recctrl.h.

Referenced by index_xpath(), and rpn_search_xpath().

#define ZEBRA_XPATH_CDATA   "_XPATH_CDATA"

Definition at line 39 of file recctrl.h.

Referenced by dumpkeys_r(), parse_termlists(), and rpn_search_database().

#define ZEBRA_XPATH_ELM_BEGIN   "_XPATH_BEGIN"

Definition at line 33 of file recctrl.h.

Referenced by dumpkeys_r(), index_xpath_attr(), and rpn_search_xpath().

#define ZEBRA_XPATH_ELM_END   "_XPATH_END"

Definition at line 36 of file recctrl.h.

Referenced by dumpkeys_r(), index_xpath_attr(), and rpn_search_xpath().

Typedef Documentation

typedef struct recType* RecType

Definition at line 148 of file recctrl.h.

typedef struct recTypeClass* RecTypeClass

Definition at line 169 of file recctrl.h.

typedef struct recTypes* RecTypes

Definition at line 170 of file recctrl.h.

Enumeration Type Documentation

record update action

Enumerator
action_insert 

insert record (fail if it exists already)

action_replace 

replace record (fail it it does not exist)

action_delete 

delete record (fail if it does not exist)

action_update 

insert or replace

action_a_delete 

delete record (ignore if it does not exist)

Definition at line 87 of file recctrl.h.

Function Documentation

RecType recType_byName ( RecTypes  rts,
Res  res,
const char *  name,
void **  clientDataP 
)
RecTypeClass recTypeClass_add_modules ( Res  res,
NMEM  nmem,
const char *  module_path 
)
RecTypeClass recTypeClass_create ( Res  res,
NMEM  nmem 
)

Definition at line 57 of file recctrl.c.

References recTypeClass_add().

Referenced by zebra_start_res().

void recTypeClass_destroy ( RecTypeClass  rtc)

Definition at line 223 of file recctrl.c.

References recTypeClass::module_handle, and recTypeClass::next.

Referenced by zebra_stop().

void recTypeClass_info ( RecTypeClass  rtc,
void *  cd,
void(*)(void *cd, const char *s)  cb 
)

Definition at line 216 of file recctrl.c.

References recType::name, recTypeClass::next, and recTypeClass::recType.

Referenced by zebra_filter_info().

void recTypeClass_load_modules ( RecTypeClass rts,
NMEM  nmem,
const char *  module_path 
)

Definition at line 177 of file recctrl.c.

References FILENAME_MAX, and load_from_dir().

Referenced by zebra_start_res().

void recTypes_default_handlers ( RecTypes  recTypes,
Res  res 
)
void recTypes_destroy ( RecTypes  recTypes)
RecTypes recTypes_init ( RecTypeClass  rtc,
data1_handle  dh 
)