Lucy::Index::Lexicon – Iterator for a field’s terms.
A Lexicon is an iterator which provides access to all the unique terms for a given field in sorted order.
If an index consists of two documents with a ‘content’ field holding “three blind mice” and “three musketeers” respectively, then iterating through the ‘content’ field’s lexicon would produce this list:
blind mice musketeers three
void lucy_Lex_Seek( lucy_Lexicon *self, cfish_Obj *target );
Seek the Lexicon to the first iterator state which is greater than or
target is NULL,
reset the iterator.
bool lucy_Lex_Next( lucy_Lexicon *self );
Proceed to the next term.
Returns: true until the iterator is exhausted, then false.
void lucy_Lex_Reset( lucy_Lexicon *self );
Reset the iterator. Next() must be called to proceed to the first element.
cfish_Obj* lucy_Lex_Get_Term( lucy_Lexicon *self );
Return the current term, or NULL if the iterator is not in a valid state.
Lucy::Index::Lexicon is a Clownfish::Obj.
Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
Apache License, Version 2.0.
Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.