lcn_segment.h

Go to the documentation of this file.

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file lcn_segment.h
 * @brief Routines for manipulating a segment of a lucene index
 */

#ifndef _LCN_SEGMENT_H
#define _LCN_SEGMENT_H

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include "lcn_types.h"
#include "lcn_directory.h"
#include "lcn_term.h"
#include "lcn_document.h"

/** An opaque structure representing a segment of a lucene index. */
typedef struct lcn_segment_t lcn_segment_t;

/** Open the segment @a segname, of size @a size containing documents
 * starting at @a offset, within directory @a d and return it in @a segment,
 * allocated from @a pool.
 */
lcn_error_t *
lcn_segment_open (lcn_segment_t **segment,
                  const lcn_char_t *segname,
                  apr_uint32_t size,
                  apr_uint32_t offset,
                  const lcn_directory_t *d,
                  apr_pool_t *pool);

/** Return the name of @a segment. */
const lcn_char_t *
lcn_segment_name (const lcn_segment_t *segment);

/** Return the size (in documents) of @a segment. */
apr_uint32_t
lcn_segment_size (const lcn_segment_t *segment);

/** Return the directory @a segment is in. */
const lcn_directory_t *
lcn_segment_directory (const lcn_segment_t *segment);

/** Return the document frquency @a doc_freq, document numbers @a docs, and
 * the frequencies @a freqs of the documents within @a segment that contain
 * @a term, using @a pool for allocation.
 */
lcn_error_t *
lcn_segment_term_docs (apr_uint32_t *doc_freq,
                       apr_uint32_t **docs,
                       apr_uint32_t **freqs,
                       lcn_segment_t *segment,
                       const lcn_term_t *term,
                       apr_pool_t *pool);

/** Return the document @a doc from @a segment that has the number @a docnum,
 * allocated within @a pool.
 */
lcn_error_t *
lcn_segment_get_document (lcn_document_t **doc,
                          lcn_segment_t *segment,
                          apr_uint32_t docnum,
                          apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---