-/* $Id: recctrl.h,v 1.25 2006-07-04 14:10:29 adam Exp $
- Copyright (C) 1995-2006
+/* $Id: recctrl.h,v 1.40 2007-12-20 11:15:41 adam Exp $
+ Copyright (C) 1995-2007
Index Data ApS
This file is part of the Zebra server.
for more details.
You should have received a copy of the GNU General Public License
-along with Zebra; see the file LICENSE.zebra. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
*/
#ifndef IDZEBRA_RECCTRL_H
#include <sys/types.h>
#include <yaz/proto.h>
-#include <yaz/oid.h>
#include <yaz/odr.h>
#include <idzebra/res.h>
#include <idzebra/data1.h>
#include <idzebra/snippet.h>
-#include <idzebra/zebramap.h>
YAZ_BEGIN_CDECL
/* 1015 */
#define ZEBRA_XPATH_ATTR_CDATA "_XPATH_ATTR_CDATA"
-/* single word entity */
+/** Indexing token */
typedef struct {
- unsigned index_type;
+ /** index type, e.g. "w", "p", .. */
+ const char *index_type;
+ /** index name, e.g. "title" */
const char *index_name;
+ /** token char data */
const char *term_buf;
+ /** length of term_buf */
int term_len;
+ /** sequence number */
zint seqno;
+ /** segment number */
+ zint segment;
+ /** record ID */
zint record_id;
+ /** section ID */
zint section_id;
- ZebraMaps zebra_maps;
struct recExtractCtrl *extractCtrl;
} RecWord;
-/* Extract record control */
+/** \brief record reader stream */
+struct ZebraRecStream {
+ /** client data */
+ void *fh;
+ /** \brief read function */
+ int (*readf)(struct ZebraRecStream *s, char *buf, size_t count);
+ /** \brief seek function */
+ off_t (*seekf)(struct ZebraRecStream *s, off_t offset);
+ /** \brief tell function */
+ off_t (*tellf)(struct ZebraRecStream *s);
+ /** \brief set and get of record position */
+ off_t (*endf)(struct ZebraRecStream *s, off_t *offset);
+ /** \brief close and destroy stream */
+ void (*destroy)(struct ZebraRecStream *s);
+};
+
+/** record update action */
+enum zebra_recctrl_action_t {
+ /** insert record (fail if it exists already) */
+ action_insert = 1,
+ /** replace record (fail it it does not exist) */
+ action_replace,
+ /** delete record (fail if it does not exist) */
+ action_delete,
+ /** insert or replace */
+ action_update,
+ /** delete record (ignore if it does not exist) */
+ action_a_delete
+};
+
+/** \brief record extract for indexing */
struct recExtractCtrl {
- void *fh; /* File handle and read function */
- int (*readf)(void *fh, char *buf, size_t count);
- off_t (*seekf)(void *fh, off_t offset); /* seek function */
- off_t (*tellf)(void *fh); /* tell function */
- void (*endf)(void *fh, off_t offset); /* end of record position */
- off_t offset; /* start offset */
+ struct ZebraRecStream *stream;
void (*init)(struct recExtractCtrl *p, RecWord *w);
void *clientData;
void (*tokenAdd)(RecWord *w);
void (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
- ZebraMaps zebra_maps;
int first_record;
int flagShowRecords;
- int seqno[256];
char match_criteria[256];
zint staticrank;
void (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
data1_handle dh;
void *handle;
+ enum zebra_recctrl_action_t action;
};
/* Retrieve record control */
struct recRetrieveCtrl {
+ struct ZebraRecStream *stream;
/* Input parameters ... */
Res res; /* Resource pool */
ODR odr; /* ODR used to create response */
- void *fh; /* File descriptor and read function */
- int (*readf)(void *fh, char *buf, size_t count);
- off_t (*seekf)(void *fh, off_t offset);
- off_t (*tellf)(void *fh);
- oid_value input_format; /* Preferred record syntax */
+ const Odr_oid * input_format; /* Preferred record syntax OID */
Z_RecordComposition *comp; /* formatting instructions */
char *encoding; /* preferred character encoding */
zint localno; /* local id of record */
int recordSize; /* size of record in bytes */
char *fname; /* name of file (or NULL if internal) */
data1_handle dh;
- zebra_snippets *hit_snippet;
- zebra_snippets *doc_snippet;
/* response */
- oid_value output_format;
- void *rec_buf;
+ const Odr_oid * output_format; /* output format OID */
+ void * rec_buf;
int rec_len;
int diagnostic;
- char *addinfo;
+ char * addinfo;
};
typedef struct recType *RecType;
#define RECCTRL_EXTRACT_EOF 1
#define RECCTRL_EXTRACT_ERROR_GENERIC 2
#define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
+#define RECCTRL_EXTRACT_SKIP 4
typedef struct recTypeClass *RecTypeClass;
typedef struct recTypes *RecTypes;
RecType recType_byName(RecTypes rts, Res res, const char *name,
void **clientDataP);
-
-#define KEY_SEGMENT_SIZE 1024
-
YAZ_END_CDECL
#endif
projects / idzebra-moved-to-github.git / blobdiff