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

Lucy::Plan::StringType

parcel Lucy
class variable LUCY_STRINGTYPE
struct symbol lucy_StringType
class nickname lucy_StringType
header file Lucy/Plan/StringType.h

Name

Lucy::Plan::StringType – Non-tokenized text type.

Description

Lucy::Plan::StringType is used for “exact-match” strings.

Functions

new
lucy_StringType* // incremented
lucy_StringType_new(void);

Create a new StringType.

init
lucy_StringType*
lucy_StringType_init(
    lucy_StringType *self
);

Initialize a StringType.

init2
lucy_StringType*
lucy_StringType_init2(
    lucy_StringType *self,
    float boost,
    bool indexed,
    bool stored,
    bool sortable
);
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.

Methods

Equals
bool
lucy_StringType_Equals(
    lucy_StringType *self,
    cfish_Obj *other
);

Compares all common properties.

Methods inherited from Lucy::Plan::FieldType

Set_Boost
void
lucy_StringType_Set_Boost(
    lucy_StringType *self,
    float boost
);

Setter for boost.

Get_Boost
float
lucy_StringType_Get_Boost(
    lucy_StringType *self
);

Accessor for boost.

Set_Indexed
void
lucy_StringType_Set_Indexed(
    lucy_StringType *self,
    bool indexed
);

Setter for indexed.

Indexed
bool
lucy_StringType_Indexed(
    lucy_StringType *self
);

Accessor for indexed.

Set_Stored
void
lucy_StringType_Set_Stored(
    lucy_StringType *self,
    bool stored
);

Setter for stored.

Stored
bool
lucy_StringType_Stored(
    lucy_StringType *self
);

Accessor for stored.

Set_Sortable
void
lucy_StringType_Set_Sortable(
    lucy_StringType *self,
    bool sortable
);

Setter for sortable.

Sortable
bool
lucy_StringType_Sortable(
    lucy_StringType *self
);

Accessor for sortable.

Binary
bool
lucy_StringType_Binary(
    lucy_StringType *self
);

Indicate whether the field contains binary data.

Inheritance

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