KinoSearch Documentation

• KinoSearch - Search engine library.


• KinoSearch::Analysis::Analyzer - Tokenize/modify/filter text.
• KinoSearch::Analysis::LCNormalizer - Convert input to lower case.
• KinoSearch::Analysis::PolyAnalyzer - Multiple Analyzers in series.
• KinoSearch::Analysis::Stemmer - Reduce related words to a shared root.
• KinoSearch::Analysis::Stopalizer - Suppress a "stoplist" of common words.
• KinoSearch::Analysis::Tokenizer - Split a string into tokens.


• KinoSearch::Doc - A document.
• KinoSearch::Doc::HitDoc - A document read from an index.


• KinoSearch::Docs::Cookbook - KinoSearch recipes.
• KinoSearch::Docs::Cookbook::CachedSearcher - Improve search-time responsiveness with a cached Searcher.
• KinoSearch::Docs::Cookbook::CustomQuery - Sample subclass of Query.
• KinoSearch::Docs::Cookbook::CustomQueryParser - Sample subclass of QueryParser.
• KinoSearch::Docs::DocNums - Characteristics of KinoSearch document numbers.
• KinoSearch::Docs::FileFormat - Overview of invindex file format.
• KinoSearch::Docs::IRTheory - Crash course in information retrieval.
• KinoSearch::Docs::Tutorial - Step-by-step introduction to KinoSearch toolset.
• KinoSearch::Docs::Tutorial::Analysis - How to choose and use Analyzers.
• KinoSearch::Docs::Tutorial::BeyondSimple - A more flexible app structure.
• KinoSearch::Docs::Tutorial::FieldSpec - Specify per-field properties and behaviors.
• KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
• KinoSearch::Docs::Tutorial::QueryObjects - Use Query objects instead of query strings.
• KinoSearch::Docs::Tutorial::Simple - Bare-bones search app.


• KinoSearch::FieldSpec - Define a field's behavior.
• KinoSearch::FieldSpec::TextField - Default behaviors for text fields.


• KinoSearch::Highlight::HeatMap - Density of relevant data in a string.
• KinoSearch::Highlight::Highlighter - Create and highlight excerpts.


• KinoSearch::Index::IndexReader - Read from an inverted index.
• KinoSearch::Index::Lexicon - Iterator for a field's terms.
• KinoSearch::Index::PostingList - Term-Document pairings.


• KinoSearch::InvIndex - An inverted index.


• KinoSearch::InvIndexer - Build inverted indexes.


• KinoSearch::Obj - Base class for all KinoSearch objects.


• KinoSearch::QueryParser - Transform a string into a Query object.


• KinoSearch::Schema - User-created specification for an inverted index.


• KinoSearch::Search::ANDQuery - Intersect multiple result sets.
• KinoSearch::Search::Compiler - Query-to-Scorer compiler.
• KinoSearch::Search::HitCollector - Process doc/score pairs.
• KinoSearch::Search::HitCollector::BitCollector - HitCollector which records doc nums in a BitVector.
• KinoSearch::Search::Hits - Access search results.
• KinoSearch::Search::LeafQuery - Leaf node in a tree created by QueryParser.
• KinoSearch::Search::MatchAllQuery - Query which matches all documents.
• KinoSearch::Search::MultiSearcher - Aggregate results from multiple searchers.
• KinoSearch::Search::NoMatchQuery - Query which matches no documents.
• KinoSearch::Search::NOTQuery - Invert the result set of another Query.
• KinoSearch::Search::ORQuery - Union multiple result sets.
• KinoSearch::Search::PhraseQuery - Query matching an ordered list of Terms.
• KinoSearch::Search::PolyQuery - Base class for composite Query objects.
• KinoSearch::Search::Query - A specification for a search query.
• KinoSearch::Search::RangeQuery - Match a range of values.
• KinoSearch::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.
• KinoSearch::Search::Scorer - Score documents against a Query.
• KinoSearch::Search::Searchable - Base class for searchers.
• KinoSearch::Search::Similarity - Calculate how closely two things match.
• KinoSearch::Search::SortSpec - Specify a custom sort order for search results.
• KinoSearch::Search::Span - An offset, a length, and a weight.
• KinoSearch::Search::Tally - Scoring info for a single document.
• KinoSearch::Search::TermQuery - Query which matches individual terms.


• KinoSearch::Searcher - Execute searches against a single invindex.


• KinoSearch::Store::Folder - Abstract class representing a directory.
• KinoSearch::Store::FSFolder - File System implementation of Folder.
• KinoSearch::Store::Lock - Interprocess mutex lock.
• KinoSearch::Store::LockFactory - Create Locks.
• KinoSearch::Store::RAMFolder - In-memory Folder implementation.
• KinoSearch::Store::SharedLock - Shared (read) lock.


• KinoSearch::Util::BitVector - An array of bits.


• KSx::Remote::SearchClient - Connect to a remote SearchServer.
• KSx::Remote::SearchServer - Make a Searcher remotely accessible.


• KSx::Search::Filter - Build a caching filter based on results of a Query.
• KSx::Search::LongFieldSim - Similarity optimized for long fields.


• KSx::Simple - Basic search engine.