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

Lucy::Analysis::CaseFolder

parcel Lucy
class variable LUCY_CASEFOLDER
struct symbol lucy_CaseFolder
class nickname lucy_CaseFolder
header file Lucy/Analysis/CaseFolder.h

Name

Lucy::Analysis::CaseFolder – Normalize case, facilitating case-insensitive search.

Description

CaseFolder is DEPRECATED. Use Normalizer instead.

CaseFolder normalizes text according to Unicode case-folding rules, so that searches will be case-insensitive.

Functions

new
lucy_CaseFolder* // incremented
lucy_CaseFolder_new(void);

Constructor. Takes no arguments.

init
lucy_CaseFolder*
lucy_CaseFolder_init(
    lucy_CaseFolder *self
);

Initialize a CaseFolder.

Methods

Transform
lucy_Inversion* // incremented
lucy_CaseFolder_Transform(
    lucy_CaseFolder *self,
    lucy_Inversion *inversion
);

Take a single Inversion as input and returns an Inversion, either the same one (presumably transformed in some way), or a new one.

inversion

An inversion.

Transform_Text
lucy_Inversion* // incremented
lucy_CaseFolder_Transform_Text(
    lucy_CaseFolder *self,
    cfish_String *text
);

Kick off an analysis chain, creating an Inversion from string input. The default implementation simply creates an initial Inversion with a single Token, then calls Transform(), but occasionally subclasses will provide an optimized implementation which minimizes string copies.

text

A string.

Equals
bool
lucy_CaseFolder_Equals(
    lucy_CaseFolder *self,
    cfish_Obj *other
);

Indicate whether two objects are the same. By default, compares the memory address.

other

Another Obj.

Dump
cfish_Hash* // incremented
lucy_CaseFolder_Dump(
    lucy_CaseFolder *self
);

Dump the analyzer as hash.

Subclasses should call Dump() on the superclass. The returned object is a hash which should be populated with parameters of the analyzer.

Returns: A hash containing a description of the analyzer.

Load
lucy_CaseFolder* // incremented
lucy_CaseFolder_Load(
    lucy_CaseFolder *self,
    cfish_Obj *dump
);

Reconstruct an analyzer from a dump.

Subclasses should first call Load() on the superclass. The returned object is an analyzer which should be reconstructed by setting the dumped parameters from the hash contained in dump.

Note that the invocant analyzer is unused.

dump

A hash.

Returns: An analyzer.

Methods inherited from Lucy::Analysis::Analyzer

Split
cfish_Vector* // incremented
lucy_CaseFolder_Split(
    lucy_CaseFolder *self,
    cfish_String *text
);

Analyze text and return an array of token texts.

text

A string.

Inheritance

Lucy::Analysis::CaseFolder is a Lucy::Analysis::Analyzer is a Clownfish::Obj.