Main Page | Data Structures | Directories | File List | Data Fields | Globals

lcn_index.h File Reference

Routines for manipulating a lucene index. More...

#include "lcn_types.h"
#include "lcn_term.h"
#include "lcn_document.h"
#include <apr_file_io.h>

Go to the source code of this file.

Typedefs

typedef lcn_index_t lcn_index_t
 Opaque structure representing a lucene index.
typedef lcn_doc_iter_t lcn_doc_iter_t
 Opaque iterator for iterating over a list of documents.

Functions

lcn_error_tlcn_index_open (lcn_index_t **idx, const char *d, apr_pool_t *pool)
 Return the index contained in directory d in idx, allocated in pool.
apr_uint32_t lcn_index_max_docs (lcn_index_t *idx)
 Return the maximum document number contained in index idx.
apr_uint32_t lcn_doc_iter_doc (lcn_doc_iter_t *itr)
 Return the current document number from itr.
apr_uint32_t lcn_doc_iter_max_docs (lcn_doc_iter_t *itr)
 Return the maximum document number that can be returned from itr.
apr_uint32_t lcn_doc_iter_freq (lcn_doc_iter_t *itr)
 Return the current document's frequency from itr.
apr_uint32_t lcn_doc_iter_term_freq (lcn_doc_iter_t *itr)
 Return the total number of hits for the term in the current segment.
lcn_error_tlcn_doc_iter_next (lcn_boolean_t *next, lcn_doc_iter_t *itr)
 Move itr to the next document.
lcn_error_tlcn_doc_iter_close (lcn_doc_iter_t *itr)
 Close itr.
lcn_error_tlcn_index_term_docs (lcn_doc_iter_t **itr, lcn_index_t *idx, lcn_term_t *term, apr_pool_t *pool)
 Return an iterator itr for iterating over all documents that contain term within idx, allocated from within pool.
lcn_error_tlcn_index_get_document (lcn_document_t **doc, lcn_index_t *idx, apr_uint32_t docnum, apr_pool_t *pool)
 Return the document doc from idx that has the number docnum, allocated from pool.


Detailed Description

Routines for manipulating a lucene index.

Definition in file lcn_index.h.


Function Documentation

lcn_error_t* lcn_doc_iter_next lcn_boolean_t next,
lcn_doc_iter_t itr
 

Move itr to the next document.

If the increment was successful, next is TRUE, if it moved us past the end of the sequence next is FALSE.


Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by  doxygen 1.4.0