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

Lucy::Search::NoMatchQuery

parcel Lucy
class variable LUCY_NOMATCHQUERY
struct symbol lucy_NoMatchQuery
class nickname lucy_NoMatchQuery
header file Lucy/Search/NoMatchQuery.h

Name

Lucy::Search::NoMatchQuery – Query which matches no documents.

Description

NoMatchQuery is a utility class representing a query which matches nothing. Typical usage might include e.g. returning a NoMatchQuery when a QueryParser is asked to parse an empty string.

Functions

new
lucy_NoMatchQuery* // incremented
lucy_NoMatchQuery_new(void);

Constructor. Takes no arguments.

init
lucy_NoMatchQuery*
lucy_NoMatchQuery_init(
    lucy_NoMatchQuery *self
);

Initialize a NoMatchQuery.

Methods

Dump
cfish_Obj* // incremented
lucy_NoMatchQuery_Dump(
    lucy_NoMatchQuery *self
);
Load
lucy_NoMatchQuery* // incremented
lucy_NoMatchQuery_Load(
    lucy_NoMatchQuery *self,
    cfish_Obj *dump
);
Equals
bool
lucy_NoMatchQuery_Equals(
    lucy_NoMatchQuery *self,
    cfish_Obj *other
);

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

other

Another Obj.

To_String
cfish_String* // incremented
lucy_NoMatchQuery_To_String(
    lucy_NoMatchQuery *self
);

Generic stringification: “ClassName@hex_mem_address”.

Make_Compiler
lucy_Compiler* // incremented
lucy_NoMatchQuery_Make_Compiler(
    lucy_NoMatchQuery *self,
    lucy_Searcher *searcher,
    float boost,
    bool subordinate
);

Abstract factory method returning a Compiler derived from this Query.

searcher

A Searcher.

boost

A scoring multiplier.

subordinate

Indicates whether the Query is a subquery (as opposed to a top-level query). If false, the implementation must invoke Normalize() on the newly minted Compiler object before returning it.

Methods inherited from Lucy::Search::Query

Set_Boost
void
lucy_NoMatchQuery_Set_Boost(
    lucy_NoMatchQuery *self,
    float boost
);

Set the Query’s boost.

Get_Boost
float
lucy_NoMatchQuery_Get_Boost(
    lucy_NoMatchQuery *self
);

Get the Query’s boost.

Inheritance

Lucy::Search::NoMatchQuery is a Lucy::Search::Query is a Clownfish::Obj.