lcn_field.h File Reference

Routines for manipulating lucene fields. More...

#include "lcn_types.h"

Go to the source code of this file.

Typedefs
typedef lcn_field_t	lcn_field_t
	Opaque structure representing a field in a document.
Enumerations
enum	lcn_field_stored_t {   LCN_STORED_NO,   LCN_STORED_YES,   LCN_STORED_COMPRESS }
	Indicates if a field is stored in the index or not. More...
enum	lcn_field_indexed_t {   LCN_INDEXED_NO,   LCN_INDEXED_TOKENIZED,   LCN_INDEXED_UNTOKENIZED }
	Indicates if a field is indexed or not. More...
enum	lcn_field_termvector_t {   LCN_TERMVECTOR_NO,   LCN_TERMVECTOR_YES,   LCN_TERMVECTOR_WITH_POSITIONS,   LCN_TERMVECTOR_WITH_OFFSETS,   LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS }
	Indicates if a field is stored in the index's termvector. More...
Functions
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)
	Create new field.
const lcn_char_t *	lcn_field_name (const lcn_field_t *f)
	Return the name of field f.
const lcn_char_t *	lcn_field_content (const lcn_field_t *f)
	Return the content of field f.

---

Detailed Description

Routines for manipulating lucene fields.

Definition in file lcn_field.h.

---

Enumeration Type Documentation

enum lcn_field_indexed_t

Indicates if a field is indexed or not. Enumeration values: 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. Definition at line 42 of file lcn_field.h.

enum lcn_field_stored_t

Indicates if a field is stored in the index or not. Enumeration values: LCN_STORED_NO  Field is not stored. LCN_STORED_YES  Field is stored. LCN_STORED_COMPRESS  Field is stored in compressed form. Definition at line 35 of file lcn_field.h.

enum lcn_field_termvector_t

Indicates if a field is stored in the index's termvector. Enumeration values: LCN_TERMVECTOR_NO  Field is not stored in the termvector. LCN_TERMVECTOR_YES  Field is stored in the termvector. LCN_TERMVECTOR_WITH_POSITIONS  Field is stored in the termvector along with its positions. LCN_TERMVECTOR_WITH_OFFSETS  Field is stored in the termvector along with its offsets. LCN_TERMVECTOR_WITH_POSITIONS_OFFSETS  Field is stored in the termvector along with its positions and offsets. Definition at line 49 of file lcn_field.h.

---

Function Documentation

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 )

Create new field. The field will have the name name, the value value, and its status with regard to storage, indexing, and termvector are determined by the stored, indexed, and termvector arguments. All allocation is done with pool.

---