Lucene 2.4.1 API

Apache Lucene is a high-performance, full-featured text search engine library.

See: Description

Core 
Package Description
org.apache.lucene
Top-level package.
org.apache.lucene.analysis
API and code to convert text into indexable/searchable tokens.
org.apache.lucene.analysis.standard
A fast grammar-based tokenizer constructed with JFlex.
org.apache.lucene.document
The logical representation of a Document for indexing and searching.
org.apache.lucene.index
Code to maintain and access indices.
org.apache.lucene.queryParser
A simple query parser implemented with JavaCC.
org.apache.lucene.search
Code to search indices.
org.apache.lucene.search.function
Programmatic control over documents scores.
org.apache.lucene.search.payloads
The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.spans
The calculus of spans.
org.apache.lucene.store
Binary i/o API, used for all index data.
org.apache.lucene.util
Some utility classes.
org.apache.lucene.util.cache  
Demo 
Package Description
org.apache.lucene.demo  
org.apache.lucene.demo.html  
contrib: Analysis 
Package Description
org.apache.lucene.analysis.br
Analyzer for Brazilian.
org.apache.lucene.analysis.cjk
Analyzer for Chinese, Japanese and Korean.
org.apache.lucene.analysis.cn
Analyzer for Chinese.
org.apache.lucene.analysis.compound
A filter that decomposes compound words you find in many Germanic languages to the word parts.
org.apache.lucene.analysis.compound.hyphenation
The code for the compound word hyphenation is taken from the Apache FOP project.
org.apache.lucene.analysis.cz
Analyzer for Czech.
org.apache.lucene.analysis.de
Analyzer for German.
org.apache.lucene.analysis.el
Analyzer for Greek.
org.apache.lucene.analysis.fr
Analyzer for French.
org.apache.lucene.analysis.miscellaneous  
org.apache.lucene.analysis.ngram  
org.apache.lucene.analysis.nl
Analyzer for Dutch.
org.apache.lucene.analysis.payloads
Provides various convenience classes for creating payloads on Tokens.
org.apache.lucene.analysis.query  
org.apache.lucene.analysis.ru
Analyzer for Russian.
org.apache.lucene.analysis.shingle  
org.apache.lucene.analysis.sinks
Implementations of the SinkTokenizer that might be useful.
org.apache.lucene.analysis.th  
contrib: Ant 
Package Description
org.apache.lucene.ant
Ant task to create Lucene indexes.
contrib: Benchmark 
Package Description
org.apache.lucene.benchmark  
org.apache.lucene.benchmark.byTask
Benchmarking Lucene By Tasks.
org.apache.lucene.benchmark.byTask.feeds
Sources for benchmark inputs: documents and queries.
org.apache.lucene.benchmark.byTask.programmatic
Sample performance test written programatically - no algorithm file is needed here.
org.apache.lucene.benchmark.byTask.stats
Statistics maintained when running benchmark tasks.
org.apache.lucene.benchmark.byTask.tasks
Extendable benchmark tasks.
org.apache.lucene.benchmark.byTask.utils
Utilities used for the benchmark, and for the reports.
org.apache.lucene.benchmark.quality
Search Quality Benchmarking.
org.apache.lucene.benchmark.quality.trec
Utilities for Trec related quality benchmarking, feeding from Trec Topics and QRels inputs.
org.apache.lucene.benchmark.quality.utils
Miscellaneous utilities for search quality benchmarking: query parsing, submission reports.
org.apache.lucene.benchmark.standard  
org.apache.lucene.benchmark.stats  
org.apache.lucene.benchmark.utils  
contrib: Highlighter 
Package Description
org.apache.lucene.search.highlight
The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.
contrib: Instantiated 
Package Description
org.apache.lucene.store.instantiated
InstantiatedIndex, alternative RAM store for small corpora.
contrib: Lucli 
Package Description
lucli
Lucene Command Line Interface
contrib: Memory 
Package Description
org.apache.lucene.index.memory
High-performance single-document main memory Apache Lucene fulltext search index.
contrib: Miscellaneous  
Package Description
org.apache.lucene.misc  
org.apache.lucene.queryParser.analyzing  
org.apache.lucene.queryParser.precedence  
contrib: Queries 
Package Description
org.apache.lucene.search.similar
Document similarity query generators.
contrib: RegEx 
Package Description
org.apache.lucene.search.regex
Regular expression Query.
org.apache.regexp
This package exists to allow access to useful package protected data within Jakarta Regexp.
contrib: Snowball 
Package Description
org.apache.lucene.analysis.snowball
TokenFilter and Analyzer implementations that use Snowball stemmers.
contrib: SpellChecker 
Package Description
org.apache.lucene.search.spell
Suggest alternate spellings for words.
contrib: Surround Parser 
Package Description
org.apache.lucene.queryParser.surround.parser
This package contains the QueryParser.jj source file for the Surround parser.
org.apache.lucene.queryParser.surround.query
This package contains SrndQuery and its subclasses.
contrib: Swing 
Package Description
org.apache.lucene.swing.models
Decorators for JTable TableModel and JList ListModel encapsulating Lucene indexing and searching functionality.
contrib: Wikipedia 
Package Description
org.apache.lucene.wikipedia.analysis  
contrib: WordNet 
Package Description
org.apache.lucene.wordnet
This package uses synonyms defined by WordNet to build a Lucene index storing them, which in turn can be used for query expansion.
contrib: XML Query Parser 
Package Description
org.apache.lucene.xmlparser  
org.apache.lucene.xmlparser.builders  
Other Packages 
Package Description
org.tartarus.snowball  
org.tartarus.snowball.ext  

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.