lcn_field.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_field.h
 * @brief Routines for manipulating lucene fields
 */

#ifndef _LCN_FIELD_H
#define _LCN_FIELD_H

#include "lcn_types.h"

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

/** Opaque structure representing a field in a document. */
typedef struct lcn_field_t lcn_field_t;

/** Indicates if a field is stored in the index or not. */
typedef enum {
  LCN_STORED_NO,       /**< Field is not stored */
  LCN_STORED_YES,      /**< Field is stored */
  LCN_STORED_COMPRESS  /**< Field is stored in compressed form */
} lcn_field_stored_t;

/** Indicates if a field is indexed or not. */
typedef enum {
  LCN_INDEXED_NO,          /**< Field is not indexed */
  LCN_INDEXED_TOKENIZED,   /**< Field is indexed in tokenized form */
  LCN_INDEXED_UNTOKENIZED  /**< Field is indexed without being tokenized */
} lcn_field_indexed_t;

/** Indicates if a field is stored in the index's termvector. */
typedef enum {
  /** Field is not stored in the termvector */
  LCN_TERMVECTOR_NO,

  /** Field is stored in the termvector */
  LCN_TERMVECTOR_YES,

  /** Field is stored in the termvector along with its positions */
  LCN_TERMVECTOR_WITH_POSITIONS,

  /** Field is stored in the termvector along with its offsets */
  LCN_TERMVECTOR_WITH_OFFSETS,

  /** Field is stored in the termvector along with its positions and offsets */
  LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS
} lcn_field_termvector_t;

/** Create new field.
 *
 * The field will have the name @a name, the value @a value, and its status
 * with regard to storage, indexing, and termvector are determined by the
 * @a stored, @a indexed, and @a termvector arguments.
 *
 * All allocation is done with @a pool.
 */
lcn_field_t *
lcn_field_create (const lcn_char_t *name,
                  const lcn_char_t *value,
                  lcn_field_stored_t stored,
                  lcn_field_indexed_t indexed,
                  lcn_field_termvector_t termvector,
                  apr_pool_t *pool);

/** Return the name of field @a f. */
const lcn_char_t *
lcn_field_name (const lcn_field_t *f);

/** Return the content of field @a f. */
const lcn_char_t *
lcn_field_content (const lcn_field_t *f);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _LCN_FIELD_H */

---