lcn_fieldinfos.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_fieldinfos.h
 * @brief Routines for reading information about a segment's fields
 */

#ifndef _LCN_FIELDINFOS_H
#define _LCN_FIELDINFOS_H

#include "lcn_types.h"
#include "lcn_directory.h"

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

/** Information about a particular field in a segment. */
typedef struct {
  /** The name of the field */
  const lcn_char_t *name;

  /** Is the field indexed? */
  lcn_boolean_t is_indexed;

  /** The field's number */
  apr_int32_t number;

  /** Is the field stored in the term vector? */
  lcn_boolean_t store_term_vector;
} lcn_fieldinfo_t;

/** Opaque structure representing a segment's fieldinfos file. */
typedef struct lcn_fieldinfos_t lcn_fieldinfos_t;

/** Return in @a fis an @c lcn_fieldinfos_t corresponding to segment @a s in
 * directory @a d, allocated in @a pool.
 */
lcn_error_t *
lcn_fieldinfos_read (lcn_fieldinfos_t **fis,
                     const lcn_directory_t *d,
                     const lcn_char_t *s,
                     apr_pool_t *pool);

/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to number
 * @a i, or @c NULL if none exists.
 */
lcn_fieldinfo_t *
lcn_fieldinfos_get_by_number (const lcn_fieldinfos_t *fis,
                              int i);

/** Return a pointer to the @c lcn_fieldinfo_t that corresponds to @a name,
 * or @c NULL if none exists.
 */
lcn_fieldinfo_t *
lcn_fieldinfos_get_by_name (const lcn_fieldinfos_t *fis,
                            const lcn_char_t *name);

/** Return the number of fieldinfos within @a fis */
int lcn_fieldinfos_get_count (const lcn_fieldinfos_t *fis);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---