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

- Packages that use DocsEnum
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.lucene40 | Lucene 4.0 file format.
  org.apache.lucene.codecs.lucene41 | Lucene 4.1 file format.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  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.

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

    Subclasses of DocsEnum in org.apache.lucene.codecs
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MappingMultiDocsAndPositionsEnum` Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).
    `class` | `MappingMultiDocsEnum` Exposes flex API, merged from flex API of sub-segments, remapping docIDs (this is used for segment merging).

    Methods in org.apache.lucene.codecs that return DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `abstract DocsEnum` | PostingsReaderBase.`docs(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsEnum reuse, int flags)` Must fully consume state, since after this call that TermState may be reused.

    Methods in org.apache.lucene.codecs with parameters of type DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `abstract DocsEnum` | PostingsReaderBase.`docs(FieldInfo fieldInfo, BlockTermState state, Bits skipDocs, DocsEnum reuse, int flags)` Must fully consume state, since after this call that TermState may be reused.
    `TermStats` | PostingsConsumer.`merge(MergeState mergeState, FieldInfo.IndexOptions indexOptions, DocsEnum postings, FixedBitSet visitedDocs)` Default merge impl: append documents, mapping around deletes

  - ### Uses of DocsEnum in org.apache.lucene.codecs.lucene40

    Methods in org.apache.lucene.codecs.lucene40 that return DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene40PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)` Deprecated.

    Methods in org.apache.lucene.codecs.lucene40 with parameters of type DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene40PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)` Deprecated.

  - ### Uses of DocsEnum in org.apache.lucene.codecs.lucene41

    Methods in org.apache.lucene.codecs.lucene41 that return DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene41PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)`

    Methods in org.apache.lucene.codecs.lucene41 with parameters of type DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | Lucene41PostingsReader.`docs(FieldInfo fieldInfo, BlockTermState termState, Bits liveDocs, DocsEnum reuse, int flags)`

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

    Subclasses of DocsEnum in org.apache.lucene.index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DocsAndPositionsEnum` Also iterates through positions.
    `static class` | `FilterAtomicReader.FilterDocsAndPositionsEnum` Base class for filtering `DocsAndPositionsEnum` implementations.
    `static class` | `FilterAtomicReader.FilterDocsEnum` Base class for filtering `DocsEnum` implementations.
    `class` | `MultiDocsAndPositionsEnum` Exposes flex API, merged from flex API of sub-segments.
    `class` | `MultiDocsEnum` Exposes `DocsEnum`, merged from `DocsEnum` API of sub-segments.

    Fields in org.apache.lucene.index declared as DocsEnum
    Modifier and Type | Field and Description
    --- | ---
    `DocsEnum` | MultiDocsEnum.EnumWithSlice.`docsEnum` `DocsEnum` of this sub-reader.
    `protected DocsEnum` | DocTermOrds.`docsEnum` Used while uninverting.
    `protected DocsEnum` | FilterAtomicReader.FilterDocsEnum.`in` The underlying DocsEnum instance.

    Methods in org.apache.lucene.index that return DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | TermsEnum.`docs(Bits liveDocs, DocsEnum reuse)` Get `DocsEnum` for the current term.
    `abstract DocsEnum` | TermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)` Get `DocsEnum` for the current term, with control over whether freqs are required.
    `DocsEnum` | SortedSetDocValuesTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | SortedDocValuesTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | MultiTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | FilteredTermsEnum.`docs(Bits bits, DocsEnum reuse, int flags)`
    `DocsEnum` | FilterAtomicReader.FilterTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `static DocsEnum` | MultiFields.`getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term)` Returns `DocsEnum` for the specified field & term.
    `static DocsEnum` | MultiFields.`getTermDocsEnum(IndexReader r, Bits liveDocs, String field, BytesRef term, int flags)` Returns `DocsEnum` for the specified field & term, with control over whether freqs are required.
    `DocsEnum` | AtomicReader.`termDocsEnum(Term term)` Returns `DocsEnum` for the specified term.

    Methods in org.apache.lucene.index with parameters of type DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | TermsEnum.`docs(Bits liveDocs, DocsEnum reuse)` Get `DocsEnum` for the current term.
    `abstract DocsEnum` | TermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)` Get `DocsEnum` for the current term, with control over whether freqs are required.
    `DocsEnum` | SortedSetDocValuesTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | SortedDocValuesTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | MultiTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`
    `DocsEnum` | FilteredTermsEnum.`docs(Bits bits, DocsEnum reuse, int flags)`
    `DocsEnum` | FilterAtomicReader.FilterTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`

    Constructors in org.apache.lucene.index with parameters of type DocsEnum
    Constructor and Description
    `FilterAtomicReader.FilterDocsEnum(DocsEnum in)` Create a new FilterDocsEnum

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

    Subclasses of DocsEnum in org.apache.lucene.search
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `ConstantScoreQuery.ConstantScorer`
    `class` | `ScoreCachingWrappingScorer` A `Scorer` which wraps another scorer and caches the score of the current document.
    `class` | `Scorer` Expert: Common scoring functionality for different types of queries.

    Methods in org.apache.lucene.search that return DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | FuzzyTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`

    Methods in org.apache.lucene.search with parameters of type DocsEnum
    Modifier and Type | Method and Description
    --- | ---
    `DocsEnum` | FuzzyTermsEnum.`docs(Bits liveDocs, DocsEnum reuse, int flags)`

  - ### Uses of DocsEnum in org.apache.lucene.search.payloads

    Subclasses of DocsEnum in org.apache.lucene.search.payloads
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PayloadNearQuery.PayloadNearSpanScorer`
    `protected class` | `PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer`

  - ### Uses of DocsEnum in org.apache.lucene.search.spans

    Subclasses of DocsEnum in org.apache.lucene.search.spans
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SpanScorer` Public for extension only.

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