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

Lucy::Plan::FieldType

parcel Lucy
class variable LUCY_FIELDTYPE
struct symbol lucy_FieldType
class nickname lucy_FType
header file Lucy/Plan/FieldType.h

Name

Lucy::Plan::FieldType – Define a field’s behavior.

Description

FieldType is an abstract class defining a set of traits and behaviors which may be associated with one or more field names.

Properties which are common to all field types include boost, indexed, stored, sortable, binary, and similarity.

The boost property is a floating point scoring multiplier which defaults to 1.0. Values greater than 1.0 cause the field to contribute more to a document’s score, lower values, less.

The indexed property indicates whether the field should be indexed (so that it can be searched).

The stored property indicates whether to store the raw field value, so that it can be retrieved when a document turns up in a search.

The sortable property indicates whether search results should be sortable based on the contents of the field.

The binary property indicates whether the field contains binary or text data. Unlike most other properties, binary is not settable.

The similarity property is a Similarity object which defines matching and scoring behavior for the field. It is required if the field is indexed.

Methods

Set_Boost
void
lucy_FType_Set_Boost(
    lucy_FieldType *self,
    float boost
);

Setter for boost.

Get_Boost
float
lucy_FType_Get_Boost(
    lucy_FieldType *self
);

Accessor for boost.

Set_Indexed
void
lucy_FType_Set_Indexed(
    lucy_FieldType *self,
    bool indexed
);

Setter for indexed.

Indexed
bool
lucy_FType_Indexed(
    lucy_FieldType *self
);

Accessor for indexed.

Set_Stored
void
lucy_FType_Set_Stored(
    lucy_FieldType *self,
    bool stored
);

Setter for stored.

Stored
bool
lucy_FType_Stored(
    lucy_FieldType *self
);

Accessor for stored.

Set_Sortable
void
lucy_FType_Set_Sortable(
    lucy_FieldType *self,
    bool sortable
);

Setter for sortable.

Sortable
bool
lucy_FType_Sortable(
    lucy_FieldType *self
);

Accessor for sortable.

Binary
bool
lucy_FType_Binary(
    lucy_FieldType *self
);

Indicate whether the field contains binary data.

Equals
bool
lucy_FType_Equals(
    lucy_FieldType *self,
    cfish_Obj *other
);

Compares all common properties.

Inheritance

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