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

Lucy::Search::MatchAllQuery

parcel Lucy
class variable LUCY_MATCHALLQUERY
struct symbol lucy_MatchAllQuery
class nickname lucy_MatchAllQuery
header file Lucy/Search/MatchAllQuery.h

Name

Lucy::Search::MatchAllQuery – Query which matches all documents.

Description

MatchAllQuery is a utility class which matches all documents. Each match is assigned a score of 0.0, so that in composite queries, any document which matches against another part of the query will be ranked higher than a document which matches only via the MatchAllQuery.

Functions

new
lucy_MatchAllQuery* // incremented
lucy_MatchAllQuery_new(void);

Constructor. Takes no arguments.

init
lucy_MatchAllQuery*
lucy_MatchAllQuery_init(
    lucy_MatchAllQuery *self
);

Initialize a MatchAllQuery.

Methods

Equals
bool
lucy_MatchAllQuery_Equals(
    lucy_MatchAllQuery *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_MatchAllQuery_To_String(
    lucy_MatchAllQuery *self
);

Generic stringification: “ClassName@hex_mem_address”.

Make_Compiler
lucy_Compiler* // incremented
lucy_MatchAllQuery_Make_Compiler(
    lucy_MatchAllQuery *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_MatchAllQuery_Set_Boost(
    lucy_MatchAllQuery *self,
    float boost
);

Set the Query’s boost.

Get_Boost
float
lucy_MatchAllQuery_Get_Boost(
    lucy_MatchAllQuery *self
);

Get the Query’s boost.

Dump
cfish_Obj* // incremented
lucy_MatchAllQuery_Dump(
    lucy_MatchAllQuery *self
);
Load
cfish_Obj* // incremented
lucy_MatchAllQuery_Load(
    lucy_MatchAllQuery *self,
    cfish_Obj *dump
);

Inheritance

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