Table of Contents - Ferret -- Ruby Search Library
Pages
MIT-LICENSE
README
Ferret
Requirements
Installation
Usage
Performance
Contact
Authors
License
TODO
TUTORIAL
Quick Introduction to Ferret
Creating an index
Adding Documents
Searching
Highlighting
Accessing Documents
Modifying and Deleting Documents
Onwards
global.js
style.css
list.rhtml
show.rhtml
index.rhtml
index.rhtml
index.rhtml
layout.rhtml
index.rhtml
index.rhtml
termdocs.rhtml
Classes/Modules
Date
DateTime
Ferret
Ferret::Analysis
Summary
Classes
Analyzer
TokenStream
Token
Ferret::Analysis::Analyzer
Summary
Example
Ferret::Analysis::AsciiLetterAnalyzer
Summary
Ferret::Analysis::AsciiLetterTokenizer
Summary
Example
Ferret::Analysis::AsciiLowerCaseFilter
Summary
Example
Ferret::Analysis::AsciiStandardAnalyzer
Summary
Ferret::Analysis::AsciiStandardTokenizer
Summary
Example
Ferret::Analysis::AsciiWhiteSpaceAnalyzer
Summary
Ferret::Analysis::AsciiWhiteSpaceTokenizer
Summary
Example
Ferret::Analysis::HyphenFilter
Summary
Example
Ferret::Analysis::LetterAnalyzer
Summary
Ferret::Analysis::LetterTokenizer
Summary
Example
Ferret::Analysis::LowerCaseFilter
Summary
Example
Ferret::Analysis::MappingFilter
Summary
Example
Ferret::Analysis::PerFieldAnalyzer
Summary
Example
Ferret::Analysis::RegExpAnalyzer
Summary
Example
Ferret::Analysis::RegExpTokenizer
Summary
Example
Ferret::Analysis::StandardAnalyzer
Summary
Ferret::Analysis::StandardTokenizer
Summary
Example
Ferret::Analysis::StemFilter
Summary
Available algorithms and encodings
New Stemmers
Example
Attributes
Ferret::Analysis::StopFilter
Summary
Example
Ferret::Analysis::Token
Summary
Attributes
Ferret::Analysis::TokenStream
Summary
Ferret::Analysis::WhiteSpaceAnalyzer
Summary
Ferret::Analysis::WhiteSpaceTokenizer
Summary
Example
Ferret::BlankSlate
Ferret::BoostMixin
Ferret::Browser
Ferret::Browser::Controller
Ferret::Browser::Delegator
Ferret::Browser::DocumentController
Ferret::Browser::ErrorController
Ferret::Browser::HelpController
Ferret::Browser::HomeController
Ferret::Browser::TermController
Ferret::Browser::TermVectorController
Ferret::Browser::ViewHelper
Ferret::Document
Boost
Ferret::Field
Boost
Ferret::FieldSymbol
Ferret::FieldSymbolMethods
Examples
Note
Ferret::FileNotFoundError
Ferret::Index
Summary
Ferret::Index::FieldInfo
Summary
Properties
:store
:index
:term_vector
Property Table
Examples
Ferret::Index::FieldInfos
Summary
Example
Default Properties
Ferret::Index::Index
Ferret::Index::IndexReader
Summary
Ferret::Index::IndexWriter
Summary
Deleting Documents
Ferret::Index::LazyDoc
Summary
Example
Ferret::Index::LazyDoc::LazyDocData
Ferret::Index::TermDocEnum
Summary
Example
Ferret::Index::TermEnum
Summary
Example
Ferret::Index::TermVector
Summary
Example
Note
Ferret::Index::TermVector::TVOffsets
Summary
Ferret::Index::TermVector::TVTerm
Summary
Example
Ferret::ParseError
Ferret::QueryParser
Summary
Ferret Query Language
Preamble
TermQuery
PhraseQuery
FieldQuery
BooleanQuery
RangeQuery
WildQuery
FuzzyQuery
Ferret::QueryParser::QueryParseException
Summary
Ferret::Search
Summary
Ferret::Search::BooleanQuery
Summary
Example
Ferret::Search::BooleanQuery::BooleanClause
Summary
Example
Ferret::Search::ConstantScoreQuery
Summary
Example
Ferret::Search::Explanation
Summary
Example
Ferret::Search::Filter
Summary
Ferret::Search::FilteredQuery
Summary
Ferret::Search::FuzzyQuery
Summary
Example
Ferret::Search::Hit
Summary
Ferret::Search::MatchAllQuery
Summary
Ferret::Search::MultiSearcher
Summary
Ferret::Search::MultiTermQuery
Summary
Example
Ferret::Search::PhraseQuery
Summary
Slop
Multi-PhraseQuery
Ferret::Search::PrefixQuery
Summary
Example
Ferret::Search::Query
Summary
Query Boosts
Ferret::Search::QueryFilter
Summary
Example
Ferret::Search::RangeFilter
Summary
Example
Number fields
Ferret::Search::RangeQuery
Summary
Example
Range queries on numbers
Ferret::Search::Searcher
Summary
Example
Ferret::Search::Sort
Summary
Example
Ferret::Search::SortField
Summary
Example
Ferret::Search::Spans
Summary
Ferret::Search::Spans::SpanFirstQuery
Summary
Example
NOTE
Ferret::Search::Spans::SpanMultiTermQuery
Summary
Ferret::Search::Spans::SpanNearQuery
Summary
Example
NOTE
Ferret::Search::Spans::SpanNotQuery
Summary
Example
NOTE
Ferret::Search::Spans::SpanOrQuery
Summary
Example
NOTE
Ferret::Search::Spans::SpanPrefixQuery
Summary
Ferret::Search::Spans::SpanTermQuery
Summary
Ferret::Search::TermQuery
Summary
Example
Ferret::Search::TopDocs
Summary
Ferret::Search::TypedRangeFilter
Summary
Example
Ferret::Search::TypedRangeQuery
Summary
Example
Performance Note
Ferret::Search::WildcardQuery
Summary
Example
Ferret::StateError
Ferret::Store
Ferret::Store::Directory
Ferret::Store::FSDirectory
Ferret::Store::Lock
Ferret::Store::Lock::LockError
Ferret::Store::RAMDirectory
Ferret::Utils
> more to come
Ferret::Utils::BitVector
Summary
Boolean Operations
Set Bit Scanning
Ferret::Utils::MultiMapper
Summary
Example
Ferret::Utils::PriorityQueue
Summary
Example
FileUtils
Float
Integer
String
Symbol
Time
WEBrick
WEBrick::FerretBrowserHandler
unknown
Methods
::convert_strings_to_symbols — Ferret::Index::FieldInfos
::default_max_terms — Ferret::Search::MultiTermQuery
::default_max_terms= — Ferret::Search::MultiTermQuery
::default_min_similarity — Ferret::Search::FuzzyQuery
::default_min_similarity= — Ferret::Search::FuzzyQuery
::default_prefix_length — Ferret::Search::FuzzyQuery
::default_prefix_length= — Ferret::Search::FuzzyQuery
::load — Ferret::Index::FieldInfos
::locale — Ferret
::locale= — Ferret
::new — Ferret::Search::Sort
::new — Ferret::Search::BooleanQuery
::new — Ferret::Field
::new — Ferret::Search::BooleanQuery::BooleanClause
::new — Ferret::Analysis::AsciiLetterTokenizer
::new — Ferret::Analysis::LetterTokenizer
::new — Ferret::Analysis::AsciiWhiteSpaceTokenizer
::new — Ferret::Analysis::WhiteSpaceTokenizer
::new — Ferret::Analysis::AsciiStandardTokenizer
::new — Ferret::Analysis::StandardTokenizer
::new — Ferret::Analysis::RegExpTokenizer
::new — Ferret::Document
::new — WEBrick::FerretBrowserHandler
::new — Ferret::Analysis::AsciiLowerCaseFilter
::new — Ferret::Analysis::LowerCaseFilter
::new — Ferret::Analysis::HyphenFilter
::new — Ferret::Analysis::MappingFilter
::new — Ferret::Analysis::StopFilter
::new — Ferret::Analysis::StemFilter
::new — Ferret::Analysis::Analyzer
::new — Ferret::Browser::Controller
::new — Ferret::Analysis::AsciiLetterAnalyzer
::new — Ferret::Analysis::LetterAnalyzer
::new — Ferret::Analysis::AsciiWhiteSpaceAnalyzer
::new — Ferret::Analysis::WhiteSpaceAnalyzer
::new — Ferret::Analysis::AsciiStandardAnalyzer
::new — Ferret::Analysis::StandardAnalyzer
::new — Ferret::Analysis::PerFieldAnalyzer
::new — Ferret::Browser::Delegator
::new — Ferret::Search::RangeQuery
::new — Ferret::Search::TypedRangeQuery
::new — Ferret::Analysis::RegExpAnalyzer
::new — Ferret::Utils::PriorityQueue
::new — Ferret::Index::FieldInfo
::new — Ferret::Utils::MultiMapper
::new — Ferret::Search::PhraseQuery
::new — Ferret::Index::IndexWriter
::new — Ferret::Search::PrefixQuery
::new — Ferret::Search::WildcardQuery
::new — Ferret::FieldSymbol
::new — Ferret::Utils::BitVector
::new — Ferret::Store::FSDirectory
::new — Ferret::Store::RAMDirectory
::new — Ferret::Search::MultiSearcher
::new — Ferret::Index::Index
::new — Ferret::Search::Searcher
::new — Ferret::Index::FieldInfos
::new — Ferret::Search::MultiTermQuery
::new — Ferret::Index::IndexReader
::new — Ferret::Search::TermQuery
::new — Ferret::Search::FuzzyQuery
::new — Ferret::Search::SortField
::new — Ferret::Search::QueryFilter
::new — Ferret::Search::TypedRangeFilter
::new — Ferret::Search::RangeFilter
::new — Ferret::Search::Spans::SpanNotQuery
::new — Ferret::Search::MatchAllQuery
::new — Ferret::Search::Spans::SpanMultiTermQuery
::new — Ferret::Analysis::Token
::new — Ferret::QueryParser
::new — Ferret::Search::Spans::SpanOrQuery
::new — Ferret::Search::FilteredQuery
::new — Ferret::Search::Spans::SpanTermQuery
::new — Ferret::Search::Spans::SpanNearQuery
::new — Ferret::Search::Spans::SpanFirstQuery
::new — Ferret::Search::Spans::SpanPrefixQuery
::new — Ferret::Search::ConstantScoreQuery
#& — Ferret::Utils::BitVector
#+ — Ferret::Field
#<< — Ferret::Index::IndexWriter
#<< — Ferret::Search::Spans::SpanOrQuery
#<< — Ferret::Index::FieldInfos
#<< — Ferret::Utils::PriorityQueue
#<< — Ferret::Search::BooleanQuery
#<< — Ferret::Search::PhraseQuery
#<< — Ferret::Index::Index
#<< — Ferret::Search::MultiTermQuery
#<< — Ferret::Search::Spans::SpanNearQuery
#<=> — Ferret::Analysis::Token
#== — Ferret::Utils::BitVector
#== — Ferret::Field
#== — Ferret::Search::Query
#== — Ferret::Document
#=~ — Float
#[] — Ferret::Index::Index
#[] — Ferret::Index::FieldInfos
#[] — Ferret::Search::Searcher
#[] — Ferret::Utils::BitVector
#[] — Ferret::Index::IndexReader
#[]= — Ferret::Analysis::PerFieldAnalyzer
#[]= — Ferret::Utils::BitVector
#^ — Ferret::Utils::BitVector
#add — Ferret::Search::Spans::SpanOrQuery
#add — Ferret::Index::FieldInfos
#add — Ferret::Search::Spans::SpanNearQuery
#add_document — Ferret::Index::IndexWriter
#add_document — Ferret::Index::Index
#add_field — Ferret::Index::FieldInfos
#add_field — Ferret::Analysis::PerFieldAnalyzer
#add_indexes — Ferret::Index::Index
#add_query — Ferret::Search::BooleanQuery
#add_readers — Ferret::Index::IndexWriter
#add_term — Ferret::Search::PhraseQuery
#add_term — Ferret::Search::MultiTermQuery
#adjust — Ferret::Utils::PriorityQueue
#analyzer — Ferret::Index::IndexWriter
#analyzer= — Ferret::Index::IndexWriter
#and — Ferret::Utils::BitVector
#and! — Ferret::Utils::BitVector
#batch_delete — Ferret::Index::Index
#batch_update — Ferret::Index::Index
#bits — Ferret::Search::Filter
#boost — Ferret::Search::Query
#boost — Ferret::Index::FieldInfo
#boost= — Ferret::Search::Query
#capacity — Ferret::Utils::PriorityQueue
#choose_document — Ferret::Browser::DocumentController
#chunk_size — Ferret::Index::IndexWriter
#chunk_size= — Ferret::Index::IndexWriter
#clear — Ferret::Utils::PriorityQueue
#clear — Ferret::Utils::BitVector
#clone — Ferret::Utils::PriorityQueue
#close — Ferret::Index::IndexReader
#close — Ferret::Index::IndexWriter
#close — Ferret::Store::Directory
#close — Ferret::Index::Index
#close — Ferret::Search::Searcher
#close_all — Ferret::Index::Index
#commit — Ferret::Index::Index
#commit — Ferret::Index::IndexReader
#commit — Ferret::Index::IndexWriter
#comparator — Ferret::Search::SortField
#compressed? — Ferret::Index::FieldInfo
#count — Ferret::Utils::BitVector
#create_index — Ferret::Index::FieldInfos
#default — Ferret::Index::LazyDoc
#delegate — Ferret::Browser::Delegator
#delete — Ferret::Index::IndexReader
#delete — Ferret::Index::IndexWriter
#delete — Ferret::Index::Index
#delete — Ferret::Store::Directory
#deleted? — Ferret::Index::IndexReader
#deleted? — Ferret::Index::Index
#desc — Ferret::FieldSymbolMethods
#desc? — Ferret::FieldSymbolMethods
#do_GET — WEBrick::FerretBrowserHandler
#do_process_query — Ferret::Index::Index
#do_search — Ferret::Index::Index
#doc — Ferret::Index::Index
#doc — Ferret::Index::TermDocEnum
#doc_count — Ferret::Index::IndexWriter
#doc_freq — Ferret::Index::TermEnum
#doc_freq — Ferret::Index::IndexReader
#doc_freq — Ferret::Search::Searcher
#doc_skip_interval — Ferret::Index::IndexWriter
#doc_skip_interval= — Ferret::Index::IndexWriter
#each — Ferret::Index::FieldInfos
#each — Ferret::Index::TermEnum
#each — Ferret::Utils::BitVector
#each — Ferret::Index::TermDocEnum
#each — Ferret::Index::Index
#each_position — Ferret::Index::TermDocEnum
#end — Ferret::Analysis::Token
#end= — Ferret::Analysis::Token
#ensure_reader_open — Ferret::Index::Index
#ensure_searcher_open — Ferret::Index::Index
#ensure_writer_open — Ferret::Index::Index
#eql? — Ferret::Utils::BitVector
#eql? — Ferret::Document
#eql? — Ferret::Search::Query
#eql? — Ferret::Field
#exists? — Ferret::Store::Directory
#explain — Ferret::Search::Searcher
#explain — Ferret::Index::Index
#field= — Ferret::Index::TermEnum
#field_infos — Ferret::Index::Index
#field_infos — Ferret::Index::IndexWriter
#field_infos — Ferret::Index::IndexReader
#field_names — Ferret::Index::IndexReader
#fields — Ferret::Index::FieldInfos
#fields — Ferret::Search::Sort
#fields — Ferret::Index::LazyDoc
#fields — Ferret::QueryParser
#fields — Ferret::Index::IndexReader
#fields= — Ferret::QueryParser
#file_count — Ferret::Store::Directory
#flush — Ferret::Index::Index
#freq — Ferret::Index::TermDocEnum
#get — Ferret::Utils::BitVector
#get_document — Ferret::Search::Searcher
#get_document — Ferret::Index::IndexReader
#get_lex_format — String
#get_norms_into — Ferret::Index::IndexReader
#has_deletions? — Ferret::Index::Index
#has_deletions? — Ferret::Index::IndexReader
#has_norms? — Ferret::Index::FieldInfo
#hash — Ferret::Utils::BitVector
#hash — Ferret::Search::Query
#highlight — Ferret::Index::Index
#highlight — Ferret::Search::Searcher
#index — Ferret::Browser::DocumentController
#index — Ferret::Browser::ErrorController
#indexed? — Ferret::Index::FieldInfo
#insert — Ferret::Utils::PriorityQueue
#latest? — Ferret::Index::IndexReader
#list — Ferret::Browser::DocumentController
#load — Ferret::Index::LazyDoc
#load_page — Ferret::Browser::Controller
#locked? — Ferret::Store::Lock
#make_lock — Ferret::Store::Directory
#map — Ferret::Utils::MultiMapper
#max_buffer_memory — Ferret::Index::IndexWriter
#max_buffer_memory= — Ferret::Index::IndexWriter
#max_buffered_docs — Ferret::Index::IndexWriter
#max_buffered_docs= — Ferret::Index::IndexWriter
#max_doc — Ferret::Index::IndexReader
#max_doc — Ferret::Search::Searcher
#max_field_length — Ferret::Index::IndexWriter
#max_field_length= — Ferret::Index::IndexWriter
#max_merge_docs — Ferret::Index::IndexWriter
#max_merge_docs= — Ferret::Index::IndexWriter
#merge_factor — Ferret::Index::IndexWriter
#merge_factor= — Ferret::Index::IndexWriter
#method_missing — Ferret::FieldSymbol
#method_missing — Ferret::Browser::Controller
#min_similarity — Ferret::Search::FuzzyQuery
#name — Ferret::Search::SortField
#name — Ferret::Index::FieldInfo
#next — Ferret::Utils::BitVector
#next — Ferret::Analysis::TokenStream
#next? — Ferret::Index::TermDocEnum
#next? — Ferret::Index::TermEnum
#next_from — Ferret::Utils::BitVector
#next_position — Ferret::Index::TermDocEnum
#next_unset — Ferret::Utils::BitVector
#next_unset_from — Ferret::Utils::BitVector
#norms — Ferret::Index::IndexReader
#not — Ferret::Utils::BitVector
#not! — Ferret::Utils::BitVector
#num_docs — Ferret::Index::IndexReader
#obtain — Ferret::Store::Lock
#occur= — Ferret::Search::BooleanQuery::BooleanClause
#omit_norms? — Ferret::Index::FieldInfo
#optimize — Ferret::Index::IndexWriter
#optimize — Ferret::Index::Index
#or — Ferret::Utils::BitVector
#or! — Ferret::Utils::BitVector
#paginate — Ferret::Browser::Controller
#paginate_docs — Ferret::Browser::DocumentController
#parse — Ferret::QueryParser
#parse_query_string — Ferret::Browser::Delegator
#pathify — Ferret::Browser::Controller
#persist — Ferret::Index::Index
#pop — Ferret::Utils::PriorityQueue
#pos_inc — Ferret::Analysis::Token
#pos_inc= — Ferret::Analysis::Token
#prefix_length — Ferret::Search::FuzzyQuery
#process_query — Ferret::Index::Index
#prohibited? — Ferret::Search::BooleanQuery::BooleanClause
#query — Ferret::Search::BooleanQuery::BooleanClause
#query= — Ferret::Search::BooleanQuery::BooleanClause
#query_delete — Ferret::Index::Index
#query_update — Ferret::Index::Index
#reader — Ferret::Index::Index
#reader — Ferret::Search::Searcher
#refresh — Ferret::Store::Directory
#release — Ferret::Store::Lock
#rename — Ferret::Store::Directory
#render — Ferret::Browser::Controller
#required? — Ferret::Search::BooleanQuery::BooleanClause
#reset_scan — Ferret::Utils::BitVector
#reverse? — Ferret::Search::SortField
#run — Ferret::Browser::Delegator
#scan — Ferret::Search::Searcher
#scan — Ferret::Index::Index
#score — Ferret::Search::Explanation
#search — Ferret::Index::Index
#search — Ferret::Search::Searcher
#search_each — Ferret::Index::Index
#search_each — Ferret::Search::Searcher
#searcher — Ferret::Index::Index
#seek — Ferret::Index::TermDocEnum
#seek_term_enum — Ferret::Index::TermDocEnum
#set — Ferret::Utils::BitVector
#set_field — Ferret::Index::TermEnum
#set_norm — Ferret::Index::IndexReader
#show — Ferret::Browser::TermController
#show — Ferret::Browser::DocumentController
#size — Ferret::Utils::PriorityQueue
#size — Ferret::Index::Index
#size — Ferret::Index::FieldInfos
#skip_to — Ferret::Index::TermEnum
#skip_to — Ferret::Index::TermDocEnum
#slop — Ferret::Search::PhraseQuery
#slop= — Ferret::Search::PhraseQuery
#start — Ferret::Analysis::Token
#start= — Ferret::Analysis::Token
#store_offsets? — Ferret::Index::FieldInfo
#store_positions? — Ferret::Index::FieldInfo
#store_term_vector? — Ferret::Index::FieldInfo
#stored? — Ferret::Index::FieldInfo
#term — Ferret::Index::TermEnum
#term_count — Ferret::Index::IndexReader
#term_docs — Ferret::Index::IndexReader
#term_docs_for — Ferret::Index::IndexReader
#term_index_interval — Ferret::Index::IndexWriter
#term_index_interval= — Ferret::Index::IndexWriter
#term_positions — Ferret::Index::IndexReader
#term_positions_for — Ferret::Index::IndexReader
#term_vector — Ferret::Index::IndexReader
#term_vector — Ferret::Index::Index
#term_vectors — Ferret::Index::IndexReader
#termdocs — Ferret::Browser::TermController
#terms — Ferret::Search::Query
#terms — Ferret::Index::IndexReader
#terms_from — Ferret::Index::IndexReader
#text — Ferret::Analysis::Token
#text — Ferret::Analysis::RegExpTokenizer
#text — Ferret::Analysis::TokenStream
#text= — Ferret::Analysis::Token
#text= — Ferret::Analysis::TokenStream
#text= — Ferret::Analysis::RegExpTokenizer
#tick_or_cross — Ferret::Browser::ViewHelper
#to_a — Ferret::Utils::BitVector
#to_a — Ferret::Index::FieldInfos
#to_const — Ferret::Browser::Delegator
#to_date_lex — String
#to_date_time_lex — String
#to_html — Ferret::Search::Explanation
#to_i_lex — String
#to_json — Ferret::Index::TermEnum
#to_json — Ferret::Index::TermDocEnum
#to_json — Ferret::Search::TopDocs
#to_s — Ferret::Document
#to_s — Ferret::Index::FieldInfos
#to_s — Ferret::Search::Explanation
#to_s — Ferret::Search::Filter
#to_s — Ferret::Search::BooleanQuery::BooleanClause
#to_s — Ferret::Index::Index
#to_s — Ferret::Search::SortField
#to_s — Ferret::Search::TopDocs
#to_s — Ferret::Field
#to_s — Ferret::Analysis::Token
#to_s — Ferret::Index::FieldInfo
#to_s — Ferret::Search::Query
#to_s — Ferret::Search::Sort
#to_s_lex — Date
#to_s_lex — Time
#to_s_lex — DateTime
#to_s_lex — Integer
#to_s_pad — Integer
#to_time_lex — String
#token_stream — Ferret::Analysis::PerFieldAnalyzer
#token_stream — Ferret::Analysis::Analyzer
#token_stream — Ferret::Analysis::RegExpAnalyzer
#tokenized? — Ferret::Index::FieldInfo
#tokenized_fields — Ferret::Index::IndexReader
#tokenized_fields — Ferret::QueryParser
#tokenized_fields — Ferret::Index::FieldInfos
#tokenized_fields= — Ferret::QueryParser
#top — Ferret::Utils::PriorityQueue
#touch — Ferret::Store::Directory
#truncate — Ferret::Browser::ViewHelper
#type — Ferret::Search::SortField
#type — Ferret::FieldSymbolMethods
#undelete_all — Ferret::Index::IndexReader
#unescape_uri — Ferret::Browser::Delegator
#unset — Ferret::Utils::BitVector
#update — Ferret::Index::Index
#use_compound_file — Ferret::Index::IndexWriter
#use_compound_file= — Ferret::Index::IndexWriter
#version — Ferret::Index::IndexWriter
#version — Ferret::Index::IndexReader
#while_locked — Ferret::Store::Lock
#writer — Ferret::Index::Index
#xor — Ferret::Utils::BitVector
#xor! — Ferret::Utils::BitVector
#| — Ferret::Utils::BitVector
#~ — Ferret::Utils::BitVector