Project Lucy has retired. For details please refer to its Attic page.
Lucy::Plan::FullTextType – C API Documentation
Apache Lucy™

Lucy::Plan::FullTextType

parcel Lucy
class variable LUCY_FULLTEXTTYPE
struct symbol lucy_FullTextType
class nickname lucy_FullTextType
header file Lucy/Plan/FullTextType.h

Name

Lucy::Plan::FullTextType – Full-text search field type.

Description

Lucy::Plan::FullTextType is an implementation of FieldType tuned for “full text search”.

Full text fields are associated with an Analyzer, which is used to tokenize and normalize the text so that it can be searched for individual words.

For an exact-match, single value field type using character data, see StringType.

Functions

new
lucy_FullTextType* // incremented
lucy_FullTextType_new(
    lucy_Analyzer *analyzer
);

Create a new FullTextType.

init
lucy_FullTextType*
lucy_FullTextType_init(
    lucy_FullTextType *self,
    lucy_Analyzer *analyzer
);

Initialize a FullTextType.

init2
lucy_FullTextType*
lucy_FullTextType_init2(
    lucy_FullTextType *self,
    lucy_Analyzer *analyzer,
    float boost,
    bool indexed,
    bool stored,
    bool sortable,
    bool highlightable
);
analyzer

An Analyzer.

boost

floating point per-field boost.

indexed

boolean indicating whether the field should be indexed.

stored

boolean indicating whether the field should be stored.

sortable

boolean indicating whether the field should be sortable.

highlightable

boolean indicating whether the field should be highlightable.

Methods

Set_Highlightable
void
lucy_FullTextType_Set_Highlightable(
    lucy_FullTextType *self,
    bool highlightable
);

Indicate whether to store data required by Highlighter for excerpt selection and search term highlighting.

Highlightable
bool
lucy_FullTextType_Highlightable(
    lucy_FullTextType *self
);

Accessor for “highlightable” property.

Get_Analyzer
lucy_Analyzer*
lucy_FullTextType_Get_Analyzer(
    lucy_FullTextType *self
);

Accessor for the type’s analyzer.

Equals
bool
lucy_FullTextType_Equals(
    lucy_FullTextType *self,
    cfish_Obj *other
);

Compares all common properties.

Methods inherited from Lucy::Plan::FieldType

Set_Boost
void
lucy_FullTextType_Set_Boost(
    lucy_FullTextType *self,
    float boost
);

Setter for boost.

Get_Boost
float
lucy_FullTextType_Get_Boost(
    lucy_FullTextType *self
);

Accessor for boost.

Set_Indexed
void
lucy_FullTextType_Set_Indexed(
    lucy_FullTextType *self,
    bool indexed
);

Setter for indexed.

Indexed
bool
lucy_FullTextType_Indexed(
    lucy_FullTextType *self
);

Accessor for indexed.

Set_Stored
void
lucy_FullTextType_Set_Stored(
    lucy_FullTextType *self,
    bool stored
);

Setter for stored.

Stored
bool
lucy_FullTextType_Stored(
    lucy_FullTextType *self
);

Accessor for stored.

Set_Sortable
void
lucy_FullTextType_Set_Sortable(
    lucy_FullTextType *self,
    bool sortable
);

Setter for sortable.

Sortable
bool
lucy_FullTextType_Sortable(
    lucy_FullTextType *self
);

Accessor for sortable.

Binary
bool
lucy_FullTextType_Binary(
    lucy_FullTextType *self
);

Indicate whether the field contains binary data.

Inheritance

Lucy::Plan::FullTextType is a Lucy::Plan::TextType is a Lucy::Plan::FieldType is a Clownfish::Obj.