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

- Packages that use Term
  Package | Description
  --- | ---
  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 Term in org.apache.lucene.index

    Methods in org.apache.lucene.index with parameters of type Term
    Modifier and Type | Method and Description
    --- | ---
    `static TermContext` | TermContext.`build(IndexReaderContext context, Term term, boolean cache)` Creates a `TermContext` from a top-level `IndexReaderContext` and the given `Term`.
    `int` | Term.`compareTo(Term other)` Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument.
    `void` | IndexWriter.`deleteDocuments(Term... terms)` Deletes the document(s) containing any of the terms.
    `void` | IndexWriter.`deleteDocuments(Term term)` Deletes the document(s) containing `term`.
    `abstract int` | IndexReader.`docFreq(Term term)` Returns the number of documents containing the `term`.
    `int` | BaseCompositeReader.`docFreq(Term term)`
    `int` | AtomicReader.`docFreq(Term term)`
    `DocsEnum` | AtomicReader.`termDocsEnum(Term term)` Returns `DocsEnum` for the specified term.
    `DocsAndPositionsEnum` | AtomicReader.`termPositionsEnum(Term term)` Returns `DocsAndPositionsEnum` for the specified term.
    `abstract long` | IndexReader.`totalTermFreq(Term term)` Returns the number of documents containing the term `term`.
    `long` | BaseCompositeReader.`totalTermFreq(Term term)`
    `long` | AtomicReader.`totalTermFreq(Term term)` Returns the number of documents containing the term `t`.
    `void` | IndexWriter.`updateDocument(Term term, Iterable<? extends IndexableField> doc)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
    `void` | IndexWriter.`updateDocument(Term term, Iterable<? extends IndexableField> doc, Analyzer analyzer)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
    `void` | IndexWriter.`updateDocuments(Term delTerm, Iterable<? extends Iterable<? extends IndexableField>> docs)` Atomically deletes documents matching the provided delTerm and adds a block of documents with sequentially assigned document IDs, such that an external reader will see all or none of the documents.
    `void` | IndexWriter.`updateDocuments(Term delTerm, Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer analyzer)` Atomically deletes documents matching the provided delTerm and adds a block of documents, analyzed using the provided analyzer, with sequentially assigned document IDs, such that an external reader will see all or none of the documents.

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

    Fields in org.apache.lucene.search declared as Term
    Modifier and Type | Field and Description
    --- | ---
    `protected Term` | AutomatonQuery.`term` term containing the field, and possibly some pattern structure

    Methods in org.apache.lucene.search that return Term
    Modifier and Type | Method and Description
    --- | ---
    `Term` | PrefixQuery.`getPrefix()` Returns the prefix of this query.
    `Term` | PrefixFilter.`getPrefix()`
    `Term` | WildcardQuery.`getTerm()` Returns the pattern term.
    `Term` | TermQuery.`getTerm()` Returns the term of this query.
    `Term` | FuzzyQuery.`getTerm()` Returns the pattern term.
    `Term[]` | PhraseQuery.`getTerms()` Returns the set of terms in this phrase.

    Methods in org.apache.lucene.search with parameters of type Term
    Modifier and Type | Method and Description
    --- | ---
    `void` | PhraseQuery.`add(Term term)` Adds a term to the end of the query phrase.
    `void` | MultiPhraseQuery.`add(Term term)` Add a single term at the next position in the phrase.
    `void` | MultiPhraseQuery.`add(Term[] terms)` Add multiple terms at the next position in the phrase.
    `void` | MultiPhraseQuery.`add(Term[] terms, int position)` Allows to specify the relative position of terms within the phrase.
    `void` | PhraseQuery.`add(Term term, int position)` Adds a term to the end of the query phrase.
    `protected void` | MultiTermQuery.TopTermsScoringBooleanQueryRewrite.`addClause(BooleanQuery topLevel, Term term, int docCount, float boost, TermContext states)`
    `protected void` | MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite.`addClause(BooleanQuery topLevel, Term term, int docFreq, float boost, TermContext states)`
    `long` | NRTManager.TrackingIndexWriter.`deleteDocuments(Term... terms)`
    `long` | NRTManager.TrackingIndexWriter.`deleteDocuments(Term t)`
    `TermStatistics` | IndexSearcher.`termStatistics(Term term, TermContext context)` Returns `TermStatistics` for a term.
    `static Automaton` | WildcardQuery.`toAutomaton(Term wildcardquery)` Convert Lucene wildcard syntax into an automaton.
    `long` | NRTManager.TrackingIndexWriter.`updateDocument(Term t, Iterable<? extends IndexableField> d)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocument(Term t, Iterable<? extends IndexableField> d, Analyzer a)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Iterable<? extends Iterable<? extends IndexableField>> docs)`
    `long` | NRTManager.TrackingIndexWriter.`updateDocuments(Term t, Iterable<? extends Iterable<? extends IndexableField>> docs, Analyzer a)`

    Method parameters in org.apache.lucene.search with type arguments of type Term
    Modifier and Type | Method and Description
    --- | ---
    `void` | TermQuery.`extractTerms(Set<Term> terms)`
    `void` | Query.`extractTerms(Set<Term> terms)` Expert: adds all terms occurring in this query to the terms set.
    `void` | PhraseQuery.`extractTerms(Set<Term> queryTerms)`
    `void` | MultiPhraseQuery.`extractTerms(Set<Term> terms)`
    `void` | MatchAllDocsQuery.`extractTerms(Set<Term> terms)`
    `void` | FilteredQuery.`extractTerms(Set<Term> terms)`
    `void` | DisjunctionMaxQuery.`extractTerms(Set<Term> terms)`
    `void` | ConstantScoreQuery.`extractTerms(Set<Term> terms)`
    `void` | BooleanQuery.`extractTerms(Set<Term> terms)`

    Constructors in org.apache.lucene.search with parameters of type Term
    Constructor and Description
    `AutomatonQuery(Term term, Automaton automaton)` Create a new AutomatonQuery from an `Automaton`.
    `FuzzyQuery(Term term)` Calls `FuzzyQuery(term, defaultMaxEdits)`.
    `FuzzyQuery(Term term, int maxEdits)` Calls `FuzzyQuery(term, maxEdits, defaultPrefixLength)`.
    `FuzzyQuery(Term term, int maxEdits, int prefixLength)` Calls `FuzzyQuery(term, maxEdits, prefixLength, defaultMaxExpansions, defaultTranspositions)`.
    `FuzzyQuery(Term term, int maxEdits, int prefixLength, int maxExpansions, boolean transpositions)` Create a new FuzzyQuery that will match terms with an edit distance of at most `maxEdits` to `term`.
    `FuzzyTermsEnum(Terms terms, AttributeSource atts, Term term, float minSimilarity, int prefixLength, boolean transpositions)` Constructor for enumeration of all terms from specified `reader` which share a prefix of length `prefixLength` with `term` and which have a fuzzy similarity > `minSimilarity`.
    `PrefixFilter(Term prefix)`
    `PrefixQuery(Term prefix)` Constructs a query for terms starting with `prefix`.
    `RegexpQuery(Term term)` Constructs a query for terms matching `term`.
    `RegexpQuery(Term term, int flags)` Constructs a query for terms matching `term`.
    `RegexpQuery(Term term, int flags, AutomatonProvider provider)` Constructs a query for terms matching `term`.
    `TermQuery(Term t)` Constructs a query for the term `t`.
    `TermQuery(Term t, int docFreq)` Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.
    `TermQuery(Term t, TermContext states)` Expert: constructs a TermQuery that will use the provided docFreq instead of looking up the docFreq against the searcher.
    `WildcardQuery(Term term)` Constructs a query for terms matching `term`.

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

    Constructors in org.apache.lucene.search.payloads with parameters of type Term
    Constructor and Description
    `PayloadTermQuery(Term term, PayloadFunction function)`
    `PayloadTermQuery(Term term, PayloadFunction function, boolean includeSpanScore)`

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

    Fields in org.apache.lucene.search.spans declared as Term
    Modifier and Type | Field and Description
    --- | ---
    `protected Term` | TermSpans.`term`
    `protected Term` | SpanTermQuery.`term`

    Fields in org.apache.lucene.search.spans with type parameters of type Term
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<Term,TermContext>` | SpanWeight.`termContexts`

    Methods in org.apache.lucene.search.spans that return Term
    Modifier and Type | Method and Description
    --- | ---
    `Term` | SpanTermQuery.`getTerm()` Return the term whose spans are matched.

    Method parameters in org.apache.lucene.search.spans with type arguments of type Term
    Modifier and Type | Method and Description
    --- | ---
    `void` | SpanTermQuery.`extractTerms(Set<Term> terms)`
    `void` | SpanPositionCheckQuery.`extractTerms(Set<Term> terms)`
    `void` | SpanOrQuery.`extractTerms(Set<Term> terms)`
    `void` | SpanNotQuery.`extractTerms(Set<Term> terms)`
    `void` | SpanNearQuery.`extractTerms(Set<Term> terms)`
    `void` | FieldMaskingSpanQuery.`extractTerms(Set<Term> terms)`
    `Spans` | SpanTermQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `abstract Spans` | SpanQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)` Expert: Returns the matches for this query in an index.
    `Spans` | SpanPositionCheckQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanOrQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanNotQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanNearQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | SpanMultiTermQueryWrapper.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `Spans` | FieldMaskingSpanQuery.`getSpans(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`

    Constructors in org.apache.lucene.search.spans with parameters of type Term
    Constructor and Description
    `SpanTermQuery(Term term)` Construct a SpanTermQuery matching the named term's spans.
    `TermSpans(DocsAndPositionsEnum postings, Term term)`

    Constructor parameters in org.apache.lucene.search.spans with type arguments of type Term
    Constructor and Description
    `NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `NearSpansOrdered(SpanNearQuery spanNearQuery, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts, boolean collectPayloads)`
    `NearSpansUnordered(SpanNearQuery query, AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`
    `SpanPositionCheckQuery.PositionCheckSpan(AtomicReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts)`

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