KinoSearch Documentation

• KinoSearch - Search engine library.


• KinoSearch::Analysis::Analyzer - Base class for analyzers.
• 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::Token - Unit of text.
• KinoSearch::Analysis::TokenBatch - A collection of tokens.
• KinoSearch::Analysis::Tokenizer - Customizable tokenizing.


• KinoSearch::Docs::Cookbook - Overview
• KinoSearch::Docs::DevGuide - Hacking/debugging KinoSearch.
• KinoSearch::Docs::FileFormat - Overview of invindex file format.
• KinoSearch::Docs::IRTheory - Crash course in information retrieval.
• KinoSearch::Docs::Tutorial - Overview
• KinoSearch::Docs::Tutorial::BeyondSimple - A more flexible app structure.
• KinoSearch::Docs::Tutorial::Simple - Bare-bones search app.


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


• KinoSearch::Highlight::Encoder - Encode excerpted text.
• KinoSearch::Highlight::Formatter - Format highlighted bits within excerpts.
• KinoSearch::Highlight::Highlighter - Create and highlight excerpts.
• KinoSearch::Highlight::SimpleHTMLEncoder - Encode HTML entities.
• KinoSearch::Highlight::SimpleHTMLFormatter - Surround highlight bits with tags.


• KinoSearch::Index::IndexReader - Read from an inverted index.
• KinoSearch::Index::Term - String of text associated with a field.


• KinoSearch::InvIndex - An inverted index.


• KinoSearch::InvIndexer - Build inverted indexes.


• KinoSearch::Posting - Base class for Postings.
• KinoSearch::Posting::MatchPosting - Match but not score documents.
• KinoSearch::Posting::RichPosting - Posting with per-position boost.
• KinoSearch::Posting::ScorePosting - Default posting type.


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


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


• KinoSearch::Search::BooleanQuery - Match boolean combinations of Queries.
• KinoSearch::Search::Filter - Base Filter class
• KinoSearch::Search::Hits - Access search results.
• KinoSearch::Search::MultiSearcher - Aggregate results from multiple searchers.
• KinoSearch::Search::PhraseQuery - Match ordered list of Terms.
• KinoSearch::Search::PolyFilter - Combine filters for a search.
• KinoSearch::Search::Query - Base class for search queries.
• KinoSearch::Search::QueryFilter - Build a filter based on results of a query.
• KinoSearch::Search::RangeFilter - Filter search results by range of values.
• KinoSearch::Search::SearchClient - Connect to a remote SearchServer.
• KinoSearch::Search::SearchServer - Make a Searcher remotely accessible.
• KinoSearch::Search::Similarity - Calculate how closely two things match.
• KinoSearch::Search::SortSpec - Specify a custom sort order for search results.
• KinoSearch::Search::TermQuery - Match individual Terms.


• KinoSearch::Searcher - Execute searches.


• KinoSearch::Simple - Basic search engine.


• 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.
• KinoSearch::Store::SharedLock - Shared (read) lock.


• KinoSearch::Util::Class - Class-building utility.
• KinoSearch::Util::ToolSet - Namespace pollution.


• KSx::Search::LongFieldSim - Similarity optimized for long fields.