Index (Lucene 2.4.1 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A C D E G H K M N O P S T W

## A

addField(String, String, Analyzer) - Method in class org.apache.lucene.index.memory.MemoryIndex
  Convenience method; Tokenizes the given field text and adds the resulting terms to the index; Equivalent to adding an indexed non-keyword Lucene `Field` that is `tokenized`, `not stored`, `termVectorStored with positions` (or `termVectorStored with positions and offsets`),
addField(String, TokenStream) - Method in class org.apache.lucene.index.memory.MemoryIndex
  Equivalent to `addField(fieldName, stream, 1.0f)`.
addField(String, TokenStream, float) - Method in class org.apache.lucene.index.memory.MemoryIndex
  Iterates over the given token stream and adds the resulting terms to the index; Equivalent to adding a tokenized, indexed, termVectorStored, unstored, Lucene `Field`.
analyze(String) - Method in class org.apache.lucene.index.memory.SynonymMap
  Analyzes/transforms the given word on input stream loading.
AnalyzerUtil - Class in org.apache.lucene.index.memory
  Various fulltext analysis utilities avoiding redundant code in several classes.

## C

createSearcher() - Method in class org.apache.lucene.index.memory.MemoryIndex
  Creates and returns a searcher that can be used to execute arbitrary Lucene queries and to collect the resulting query results as hits.
createToken(String, Token, Token) - Method in class org.apache.lucene.index.memory.SynonymTokenFilter
  Creates and returns a token for the given synonym of the current input token; Override for custom (stateless or stateful) behavior, if desired.

## D

DEFAULT_ANALYZER - Static variable in class org.apache.lucene.index.memory.PatternAnalyzer
  A lower-casing word analyzer with English stop words (can be shared freely across threads without harm); global per class loader.

## E

equals(Object) - Method in class org.apache.lucene.index.memory.PatternAnalyzer
  Indicates whether some other object is "equal to" this one.
EXTENDED_ANALYZER - Static variable in class org.apache.lucene.index.memory.PatternAnalyzer
  A lower-casing word analyzer with extended English stop words (can be shared freely across threads without harm); global per class loader.

## G

getLoggingAnalyzer(Analyzer, PrintStream, String) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns a simple analyzer wrapper that logs all tokens produced by the underlying child analyzer to the given log stream (typically System.err); Otherwise behaves exactly like the child analyzer, delivering the very same tokens; useful for debugging purposes on custom indexing and/or querying.
getMaxTokenAnalyzer(Analyzer, int) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns an analyzer wrapper that returns at most the first `maxTokens` tokens from the underlying child analyzer, ignoring all remaining tokens.
getMemorySize() - Method in class org.apache.lucene.index.memory.MemoryIndex
  Returns a reasonable approximation of the main memory [bytes] consumed by this instance.
getMostFrequentTerms(Analyzer, String, int) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns (frequency:term) pairs for the top N distinct terms (aka words), sorted descending by frequency (and ascending by term, if tied).
getParagraphs(String, int) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns at most the first N paragraphs of the given text.
getPorterStemmerAnalyzer(Analyzer) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns an English stemming analyzer that stems tokens from the underlying child analyzer according to the Porter stemming algorithm.
getSentences(String, int) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns at most the first N sentences of the given text.
getSynonymAnalyzer(Analyzer, SynonymMap, int) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns an analyzer wrapper that wraps the underlying child analyzer's token stream into a `SynonymTokenFilter`.
getSynonyms(String) - Method in class org.apache.lucene.index.memory.SynonymMap
  Returns the synonym set for the given word, sorted ascending.
getTokenCachingAnalyzer(Analyzer) - Static method in class org.apache.lucene.index.memory.AnalyzerUtil
  Returns an analyzer wrapper that caches all tokens generated by the underlying child analyzer's token streams, and delivers those cached tokens on subsequent calls to `tokenStream(String fieldName, Reader reader)` if the fieldName has been seen before, altogether ignoring the Reader parameter on cache lookup.

## H

hashCode() - Method in class org.apache.lucene.index.memory.PatternAnalyzer
  Returns a hash code value for the object.

## K

keywordTokenStream(Collection) - Method in class org.apache.lucene.index.memory.MemoryIndex
  Convenience method; Creates and returns a token stream that generates a token for each keyword in the given collection, "as is", without any transforming text analysis.

## M

MemoryIndex - Class in org.apache.lucene.index.memory
  High-performance single-document main memory Apache Lucene fulltext search index.
MemoryIndex() - Constructor for class org.apache.lucene.index.memory.MemoryIndex
  Constructs an empty instance.

## N

next(Token) - Method in class org.apache.lucene.index.memory.SynonymTokenFilter
  Returns the next token in the stream, or null at EOS.
NON_WORD_PATTERN - Static variable in class org.apache.lucene.index.memory.PatternAnalyzer
  `"\\W+"`; Divides text at non-letters (NOT Character.isLetter(c))

## O

org.apache.lucene.index.memory - package org.apache.lucene.index.memory
  High-performance single-document main memory Apache Lucene fulltext search index.

## P

PatternAnalyzer - Class in org.apache.lucene.index.memory
  Efficient Lucene analyzer/tokenizer that preferably operates on a String rather than a `Reader`, that can flexibly separate text into terms via a regular expression `Pattern` (with behaviour identical to `String.split(String)`), and that combines the functionality of `LetterTokenizer`, `LowerCaseTokenizer`, `WhitespaceTokenizer`, `StopFilter` into a single efficient multi-purpose class.
PatternAnalyzer(Pattern, boolean, Set) - Constructor for class org.apache.lucene.index.memory.PatternAnalyzer
  Constructs a new instance with the given parameters.

## S

search(Query) - Method in class org.apache.lucene.index.memory.MemoryIndex
  Convenience method that efficiently returns the relevance score by matching this index against the given Lucene query expression.
SYNONYM_TOKEN_TYPE - Static variable in class org.apache.lucene.index.memory.SynonymTokenFilter
  The Token.type used to indicate a synonym to higher level filters.
SynonymMap - Class in org.apache.lucene.index.memory
  Loads the WordNet prolog file wn_s.pl into a thread-safe main-memory hash map that can be used for fast high-frequency lookups of synonyms for any given (lowercase) word string.
SynonymMap(InputStream) - Constructor for class org.apache.lucene.index.memory.SynonymMap
  Constructs an instance, loading WordNet synonym data from the given input stream.
SynonymTokenFilter - Class in org.apache.lucene.index.memory
  Injects additional tokens for synonyms of token terms fetched from the underlying child stream; the child stream must deliver lowercase tokens for synonyms to be found.
SynonymTokenFilter(TokenStream, SynonymMap, int) - Constructor for class org.apache.lucene.index.memory.SynonymTokenFilter
  Creates an instance for the given underlying stream and synonym table.

## T

tokenStream(String, String) - Method in class org.apache.lucene.index.memory.PatternAnalyzer
  Creates a token stream that tokenizes the given string into token terms (aka words).
tokenStream(String, Reader) - Method in class org.apache.lucene.index.memory.PatternAnalyzer
  Creates a token stream that tokenizes all the text in the given Reader; This implementation forwards to `tokenStream(String, String)` and is less efficient than `tokenStream(String, String)`.
toString() - Method in class org.apache.lucene.index.memory.MemoryIndex
  Returns a String representation of the index data for debugging purposes.
toString() - Method in class org.apache.lucene.index.memory.SynonymMap
  Returns a String representation of the index data for debugging purposes.

## W

WHITESPACE_PATTERN - Static variable in class org.apache.lucene.index.memory.PatternAnalyzer
  `"\\s+"`; Divides text at whitespaces (Character.isWhitespace(c))

A C D E G H K M N O P S T W

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

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