KinoSearch Documentation

• KinoSearch - Search engine library.


• KinoSearch::Analysis::Analyzer - Tokenize/modify/filter text.
• KinoSearch::Analysis::CaseFolder - Normalize case, facilitating case-insensitive search.
• 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::Docs::Cookbook - KinoSearch recipes.
• KinoSearch::Docs::Cookbook::CustomQuery - Sample subclass of Query.
• KinoSearch::Docs::Cookbook::CustomQueryParser - Sample subclass of QueryParser.
• KinoSearch::Docs::Cookbook::FastUpdates - Near real-time index updates.
• KinoSearch::Docs::DevGuide - Quick-start guide to hacking on KinoSearch.
• KinoSearch::Docs::DocIDs - Characteristics of KinoSearch document ids.
• KinoSearch::Docs::FileFormat - Overview of index file format.
• KinoSearch::Docs::FileLocking - Manage indexes on shared volumes.
• KinoSearch::Docs::IRTheory - Crash course in information retrieval.
• KinoSearch::Docs::Tutorial - Step-by-step introduction to KinoSearch.
• KinoSearch::Docs::Tutorial::Analysis - How to choose and use Analyzers.
• KinoSearch::Docs::Tutorial::BeyondSimple - A more flexible app structure.
• KinoSearch::Docs::Tutorial::FieldType - 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::Document::Doc - A document.
• KinoSearch::Document::HitDoc - A document read from an index.


• KinoSearch::Highlight::Highlighter - Create and highlight excerpts.


• KinoSearch::Index::BackgroundMerger - Consolidate index segments in the background.
• KinoSearch::Index::DataReader - Abstract base class for reading index data.
• KinoSearch::Index::DataWriter - Write data to an index.
• KinoSearch::Index::DeletionsWriter - Abstract base class for marking documents as deleted.
• KinoSearch::Index::DocReader - Retrieve stored documents.
• KinoSearch::Index::Indexer - Build inverted indexes.
• KinoSearch::Index::IndexManager - Policies governing index updating, locking, and file deletion.
• KinoSearch::Index::IndexReader - Read from an inverted index.
• KinoSearch::Index::Lexicon - Iterator for a field's terms.
• KinoSearch::Index::LexiconReader - Read Lexicon data.
• KinoSearch::Index::PolyReader - Multi-segment implementation of IndexReader.
• KinoSearch::Index::PostingList - Term-Document pairings.
• KinoSearch::Index::PostingListReader - Read postings data.
• KinoSearch::Index::Segment - Warehouse for information about one segment of an inverted index.
• KinoSearch::Index::SegReader - Single-segment IndexReader.
• KinoSearch::Index::SegWriter - Write one segment of an index.
• KinoSearch::Index::Similarity - Judge how well a document matches a query.
• KinoSearch::Index::Snapshot - Point-in-time index file list.


• KinoSearch::Object::BitVector - An array of bits.
• KinoSearch::Object::Err - Exception.
• KinoSearch::Object::Obj - Base class for all KinoSearch objects.


• KinoSearch::Plan::Architecture - Configure major components of an index.
• KinoSearch::Plan::BlobType - Default behaviors for binary fields.
• KinoSearch::Plan::FieldType - Define a field's behavior.
• KinoSearch::Plan::FullTextType - Full-text search field type.
• KinoSearch::Plan::Schema - User-created specification for an inverted index.
• KinoSearch::Plan::StringType - Non-tokenized text type.


• KinoSearch::Search::ANDQuery - Intersect multiple result sets.
• KinoSearch::Search::Collector - Process hits.
• KinoSearch::Search::Collector::BitCollector - Collector which records doc nums in a BitVector.
• KinoSearch::Search::Compiler - Query-to-Matcher compiler.
• KinoSearch::Search::Hits - Access search results.
• KinoSearch::Search::IndexSearcher - Execute searches against a single index.
• KinoSearch::Search::LeafQuery - Leaf node in a tree created by QueryParser.
• KinoSearch::Search::MatchAllQuery - Query which matches all documents.
• KinoSearch::Search::Matcher - Match a set of document ids.
• 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::PolySearcher - Aggregate results from multiple Searchers.
• KinoSearch::Search::Query - A specification for a search query.
• KinoSearch::Search::QueryParser - Transform a string into a Query object.
• KinoSearch::Search::RangeQuery - Match a range of values.
• KinoSearch::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.
• KinoSearch::Search::Searcher - Base class for searching collections of documents.
• KinoSearch::Search::SortRule - Element of a SortSpec.
• KinoSearch::Search::SortSpec - Specify a custom sort order for search results.
• KinoSearch::Search::Span - An offset, a length, and a weight.
• KinoSearch::Search::TermQuery - Query which matches individual terms.


• KinoSearch::Store::Folder - Abstract class representing a directory.
• KinoSearch::Store::FSFolder - File System implementation of Folder.
• KinoSearch::Store::Lock - Abstract class representing an interprocess mutex lock.
• KinoSearch::Store::LockErr - Lock exception.
• KinoSearch::Store::LockFactory - Create Locks.
• KinoSearch::Store::RAMFolder - In-memory Folder implementation.


• KSx::Index::ByteBufDocReader - Read a Doc as a fixed-width byte array.
• KSx::Index::ByteBufDocWriter - Write a Doc as a fixed-width byte array.
• KSx::Index::LongFieldSim - Similarity optimized for long fields.
• KSx::Index::ZlibDocReader - Compressed doc storage.
• KSx::Index::ZlibDocWriter - Compressed doc storage.


• 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::MockScorer - Matcher with arbitrary docs and scores.
• KSx::Search::ProximityQuery - Query matching an ordered list of terms.


• KSx::Simple - Basic search engine.