## Uses of Class
org.apache.lucene.index.TermsEnum

- Packages that use TermsEnum
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.util | Some utility classes.
  org.apache.lucene.util.automaton | Finite-state automaton for regular expressions.

- - ### Uses of TermsEnum in org.apache.lucene.codecs

    Methods in org.apache.lucene.codecs that return TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `TermsEnum` | BlockTreeTermsReader.FieldReader.`intersect(CompiledAutomaton compiled, BytesRef startTerm)`
    `TermsEnum` | BlockTreeTermsReader.FieldReader.`iterator(TermsEnum reuse)`

    Methods in org.apache.lucene.codecs with parameters of type TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `TermsEnum` | BlockTreeTermsReader.FieldReader.`iterator(TermsEnum reuse)`
    `void` | TermsConsumer.`merge(MergeState mergeState, FieldInfo.IndexOptions indexOptions, TermsEnum termsEnum)` Default merge impl

  - ### Uses of TermsEnum in org.apache.lucene.index

    Subclasses of TermsEnum in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `FilterAtomicReader.FilterTermsEnum` Base class for filtering `TermsEnum` implementations.
    `class` | `FilteredTermsEnum` Abstract class for enumerating a subset of all terms.
    `class` | `MultiTermsEnum` Exposes `TermsEnum` API, merged from `TermsEnum` API of sub-segments.
    `class` | `SingleTermsEnum` Subclass of FilteredTermsEnum for enumerating a single term.
    `class` | `SortedDocValuesTermsEnum` Implements a `TermsEnum` wrapping a provided `SortedDocValues`.
    `class` | `SortedSetDocValuesTermsEnum` Implements a `TermsEnum` wrapping a provided `SortedSetDocValues`.

    Fields in org.apache.lucene.index declared as TermsEnum
    Modifier and Type | Field and Description
    --- | ---
    `static TermsEnum` | TermsEnum.`EMPTY` An empty TermsEnum for quickly returning an empty instance e.g.
    `protected TermsEnum` | FilterAtomicReader.FilterTermsEnum.`in` The underlying TermsEnum instance.

    Methods in org.apache.lucene.index that return TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `TermsEnum` | DocTermOrds.`getOrdTermsEnum(AtomicReader reader)` Returns a TermsEnum that implements ord.
    `TermsEnum` | Terms.`intersect(CompiledAutomaton compiled, BytesRef startTerm)` Returns a TermsEnum that iterates over all terms that are accepted by the provided `CompiledAutomaton`.
    `TermsEnum` | MultiTerms.`intersect(CompiledAutomaton compiled, BytesRef startTerm)`
    `TermsEnum` | FilterAtomicReader.FilterTerms.`intersect(CompiledAutomaton automaton, BytesRef bytes)`
    `abstract TermsEnum` | Terms.`iterator(TermsEnum reuse)` Returns an iterator that will step through all terms.
    `TermsEnum` | MultiTerms.`iterator(TermsEnum reuse)`
    `TermsEnum` | FilterAtomicReader.FilterTerms.`iterator(TermsEnum reuse)`
    `TermsEnum` | MultiTermsEnum.`reset(org.apache.lucene.index.MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex)` The terms array must be newly created TermsEnum, ie `BytesRefIterator.next()` has not yet been called.

    Methods in org.apache.lucene.index with parameters of type TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `abstract TermsEnum` | Terms.`iterator(TermsEnum reuse)` Returns an iterator that will step through all terms.
    `TermsEnum` | MultiTerms.`iterator(TermsEnum reuse)`
    `TermsEnum` | FilterAtomicReader.FilterTerms.`iterator(TermsEnum reuse)`
    `SortedSetDocValues` | DocTermOrds.`iterator(TermsEnum termsEnum)` Returns a SortedSetDocValues view of this instance
    `BytesRef` | DocTermOrds.`lookupTerm(TermsEnum termsEnum, int ord)` Returns the term (`BytesRef`) corresponding to the provided ordinal.
    `protected void` | DocTermOrds.`visitTerm(TermsEnum te, int termNum)` Subclass can override this

    Constructors in org.apache.lucene.index with parameters of type TermsEnum
    Constructor and Description
    `FilterAtomicReader.FilterTermsEnum(TermsEnum in)` Creates a new FilterTermsEnum
    `FilteredTermsEnum(TermsEnum tenum)` Creates a filtered `TermsEnum` on a terms enum.
    `FilteredTermsEnum(TermsEnum tenum, boolean startWithSeek)` Creates a filtered `TermsEnum` on a terms enum.
    `MultiDocValues.OrdinalMap(Object owner, TermsEnum[] subs)` Creates an ordinal map that allows mapping ords to/from a merged space from `subs`.
    `SingleTermsEnum(TermsEnum tenum, BytesRef termText)` Creates a new `SingleTermsEnum`.

  - ### Uses of TermsEnum in org.apache.lucene.search

    Subclasses of TermsEnum in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FuzzyTermsEnum` Subclass of TermsEnum for enumerating all terms that are similar to the specified filter term.
    `class` | `PrefixTermsEnum` Subclass of FilteredTermEnum for enumerating all terms that match the specified prefix filter term.
    `class` | `TermRangeTermsEnum` Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.

    Methods in org.apache.lucene.search that return TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `protected TermsEnum` | FuzzyTermsEnum.`getAutomatonEnum(int editDistance, BytesRef lastTerm)` return an automata-based enum for matching up to editDistance from lastTerm, if possible
    `protected TermsEnum` | MultiTermQuery.RewriteMethod.`getTermsEnum(MultiTermQuery query, Terms terms, AttributeSource atts)` Returns the `MultiTermQuery`s `TermsEnum`
    `protected TermsEnum` | MultiTermQuery.`getTermsEnum(Terms terms)` Convenience method, if no attributes are needed: This simply passes empty attributes and is equal to: `getTermsEnum(terms, new AttributeSource())`
    `protected TermsEnum` | TermRangeQuery.`getTermsEnum(Terms terms, AttributeSource atts)`
    `protected TermsEnum` | PrefixQuery.`getTermsEnum(Terms terms, AttributeSource atts)`
    `protected TermsEnum` | NumericRangeQuery.`getTermsEnum(Terms terms, AttributeSource atts)`
    `protected abstract TermsEnum` | MultiTermQuery.`getTermsEnum(Terms terms, AttributeSource atts)` Construct the enumeration to be used, expanding the pattern term.
    `protected TermsEnum` | FuzzyQuery.`getTermsEnum(Terms terms, AttributeSource atts)`
    `protected TermsEnum` | AutomatonQuery.`getTermsEnum(Terms terms, AttributeSource atts)`
    `TermsEnum` | FieldCache.Parser.`termsEnum(Terms terms)` Pulls a `TermsEnum` from the given `Terms`.

    Methods in org.apache.lucene.search with parameters of type TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | FuzzyTermsEnum.`setEnum(TermsEnum actualEnum)` swap in a new actual enum to proxy to

    Constructors in org.apache.lucene.search with parameters of type TermsEnum
    Constructor and Description
    `PrefixTermsEnum(TermsEnum tenum, BytesRef prefixText)`
    `TermRangeTermsEnum(TermsEnum tenum, BytesRef lowerTerm, BytesRef upperTerm, boolean includeLower, boolean includeUpper)` Enumerates all terms greater/equal than `lowerTerm` but less/equal than `upperTerm`.

  - ### Uses of TermsEnum in org.apache.lucene.util

    Methods in org.apache.lucene.util that return TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `static TermsEnum` | NumericUtils.`filterPrefixCodedInts(TermsEnum termsEnum)` Filters the given `TermsEnum` by accepting only prefix coded 32 bit terms with a shift value of `0`.
    `static TermsEnum` | NumericUtils.`filterPrefixCodedLongs(TermsEnum termsEnum)` Filters the given `TermsEnum` by accepting only prefix coded 64 bit terms with a shift value of `0`.

    Methods in org.apache.lucene.util with parameters of type TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `static TermsEnum` | NumericUtils.`filterPrefixCodedInts(TermsEnum termsEnum)` Filters the given `TermsEnum` by accepting only prefix coded 32 bit terms with a shift value of `0`.
    `static TermsEnum` | NumericUtils.`filterPrefixCodedLongs(TermsEnum termsEnum)` Filters the given `TermsEnum` by accepting only prefix coded 64 bit terms with a shift value of `0`.

  - ### Uses of TermsEnum in org.apache.lucene.util.automaton

    Methods in org.apache.lucene.util.automaton that return TermsEnum
    Modifier and Type | Method and Description
    --- | ---
    `TermsEnum` | CompiledAutomaton.`getTermsEnum(Terms terms)`

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