## 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.queryParser | A simple query parser implemented with JavaCC.
  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 that return Term
    Modifier and Type | Method and Description
    --- | ---
    `Term` | Term.`createTerm(java.lang.String text)` Optimized construction of new Terms by reusing same field as this Term - avoids field.intern() overhead
    `abstract Term` | TermEnum.`term()` Returns the current Term in the enumeration.
    `Term` | FilterIndexReader.FilterTermEnum.`term()`

    Methods in org.apache.lucene.index with parameters of type Term
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `int` | IndexModifier.`deleteDocuments(Term term)` Deprecated. Deletes all documents containing `term`.
    `void` | IndexWriter.`deleteDocuments(Term term)` Deletes the document(s) containing `term`.
    `int` | IndexReader.`deleteDocuments(Term term)` Deletes all documents that have a given `term` indexed.
    `void` | IndexWriter.`deleteDocuments(Term[] terms)` Deletes the document(s) containing any of the terms.
    `int` | SegmentReader.`docFreq(Term t)`
    `int` | ParallelReader.`docFreq(Term term)`
    `int` | MultiReader.`docFreq(Term t)`
    `abstract int` | IndexReader.`docFreq(Term t)` Returns the number of documents containing the term `t`.
    `int` | FilterIndexReader.`docFreq(Term t)`
    `void` | MultipleTermPositions.`seek(Term arg0)` Not implemented.
    `void` | TermDocs.`seek(Term term)` Sets this to the data for a term.
    `void` | AbstractAllTermDocs.`seek(Term term)`
    `void` | FilterIndexReader.FilterTermDocs.`seek(Term term)`
    `boolean` | TermEnum.`skipTo(Term target)` Deprecated. This method is not performant and will be removed in Lucene 3.0. Use `IndexReader.terms(Term)` to create a new TermEnum positioned at a given term.
    `TermDocs` | SegmentReader.`termDocs(Term term)`
    `TermDocs` | ParallelReader.`termDocs(Term term)`
    `TermDocs` | IndexReader.`termDocs(Term term)` Returns an enumeration of all the documents which contain `term`.
    `TermDocs` | FilterIndexReader.`termDocs(Term term)`
    `TermPositions` | ParallelReader.`termPositions(Term term)`
    `TermPositions` | IndexReader.`termPositions(Term term)` Returns an enumeration of all the documents which contain `term`.
    `TermEnum` | SegmentReader.`terms(Term t)`
    `TermEnum` | ParallelReader.`terms(Term term)`
    `TermEnum` | MultiReader.`terms(Term term)`
    `abstract TermEnum` | IndexReader.`terms(Term t)` Returns an enumeration of all terms starting at a given term.
    `TermEnum` | FilterIndexReader.`terms(Term t)`
    `void` | IndexWriter.`updateDocument(Term term, Document doc)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.
    `void` | IndexWriter.`updateDocument(Term term, Document doc, Analyzer analyzer)` Updates a document by first deleting the document(s) containing `term` and then adding the new document.

    Constructors in org.apache.lucene.index with parameters of type Term
    Constructor and Description
    `MultipleTermPositions(IndexReader indexReader, Term[] terms)` Creates a new `MultipleTermPositions` instance.

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

    Methods in org.apache.lucene.queryParser with parameters of type Term
    Modifier and Type | Method and Description
    --- | ---
    `protected Query` | QueryParser.`newFuzzyQuery(Term term, float minimumSimilarity, int prefixLength)` Builds a new FuzzyQuery instance
    `protected Query` | QueryParser.`newPrefixQuery(Term prefix)` Builds a new PrefixQuery instance
    `protected Query` | QueryParser.`newTermQuery(Term term)` Builds a new TermQuery instance
    `protected Query` | QueryParser.`newWildcardQuery(Term t)` Builds a new WildcardQuery instance

  - ### 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` | FilteredTermEnum.`currentTerm` the current term
    `protected Term` | WildcardQuery.`term`
    `protected Term` | MultiTermQuery.`term`
    `protected Term` | FuzzyQuery.`term`
    `Term` | FuzzyQuery.ScoreTerm.`term`

    Methods in org.apache.lucene.search that return Term
    Modifier and Type | Method and Description
    --- | ---
    `Term` | RangeQuery.`getLowerTerm()` Deprecated. Returns the lower term of this range query.
    `Term` | PrefixQuery.`getPrefix()` Returns the prefix of this query.
    `Term` | PrefixFilter.`getPrefix()`
    `protected Term` | PrefixTermEnum.`getPrefixTerm()`
    `Term` | TermQuery.`getTerm()` Returns the term of this query.
    `Term` | WildcardQuery.`getTerm()` Returns the pattern term.
    `Term` | MultiTermQuery.`getTerm()` Deprecated. check sub class for possible term access - getTerm does not make sense for all MultiTermQuerys and will be removed.
    `Term` | FuzzyQuery.`getTerm()` Returns the pattern term.
    `Term[]` | PhraseQuery.`getTerms()` Returns the set of terms in this phrase.
    `Term` | RangeQuery.`getUpperTerm()` Deprecated. Returns the upper term of this range query.
    `Term` | FilteredTermEnum.`term()` Returns the current Term in the enumeration.

    Methods in org.apache.lucene.search with parameters of type Term
    Modifier and Type | Method and Description
    --- | ---
    `void` | MultiPhraseQuery.`add(Term term)` Add a single term at the next position in the phrase.
    `void` | PhraseQuery.`add(Term term)` Adds a term to the end of the query 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.
    `abstract int` | Searcher.`docFreq(Term term)`
    `int` | MultiSearcher.`docFreq(Term term)`
    `int` | IndexSearcher.`docFreq(Term term)`
    `int` | Searchable.`docFreq(Term term)` Expert: Returns the number of documents containing `term`.
    `int` | ParallelMultiSearcher.`docFreq(Term term)` TODO: parallelize this one too
    `int[]` | Searcher.`docFreqs(Term[] terms)`
    `int[]` | Searchable.`docFreqs(Term[] terms)` Expert: For each term in the terms array, calculates the number of documents containing `term`.
    `float` | Similarity.`idf(Term term, Searcher searcher)` Deprecated. see `Similarity.idfExplain(Term, Searcher)`
    `Explanation.IDFExplanation` | Similarity.`idfExplain(Term term, Searcher searcher)` Computes a score factor for a simple term and returns an explanation for that score factor.
    `protected boolean` | PrefixTermEnum.`termCompare(Term term)`
    `protected boolean` | WildcardTermEnum.`termCompare(Term term)`
    `protected abstract boolean` | FilteredTermEnum.`termCompare(Term term)` Equality compare on the term
    `protected boolean` | TermRangeTermEnum.`termCompare(Term term)`
    `protected boolean` | FuzzyTermEnum.`termCompare(Term term)` The termCompare method in FuzzyTermEnum uses Levenshtein distance to calculate the distance between the given term and the comparing term.

    Constructors in org.apache.lucene.search with parameters of type Term
    Constructor and Description
    `FuzzyQuery(Term term)` Calls `FuzzyQuery(term, 0.5f, 0)`.
    `FuzzyQuery(Term term, float minimumSimilarity)` Calls `FuzzyQuery(term, minimumSimilarity, 0)`.
    `FuzzyQuery(Term term, float minimumSimilarity, int prefixLength)` Create a new FuzzyQuery that will match terms with a similarity of at least `minimumSimilarity` to `term`.
    `FuzzyTermEnum(IndexReader reader, Term term)` Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f.
    `FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity)` Creates a FuzzyTermEnum with an empty prefix.
    `FuzzyTermEnum(IndexReader reader, Term term, float minSimilarity, int prefixLength)` 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`.
    `MultiTermQuery(Term term)` Deprecated. check sub class for possible term access - the Term does not make sense for all MultiTermQuerys and will be removed.
    `PrefixFilter(Term prefix)`
    `PrefixQuery(Term prefix)` Constructs a query for terms starting with `prefix`.
    `PrefixTermEnum(IndexReader reader, Term prefix)`
    `RangeQuery(Term lowerTerm, Term upperTerm, boolean inclusive)` Deprecated. Constructs a query selecting all terms greater than `lowerTerm` but less than `upperTerm`.
    `RangeQuery(Term lowerTerm, Term upperTerm, boolean inclusive, java.text.Collator collator)` Deprecated. Constructs a query selecting all terms greater than `lowerTerm` but less than `upperTerm`.
    `ScoreTerm(Term term, float score)`
    `TermQuery(Term t)` Constructs a query for the term `t`.
    `WildcardQuery(Term term)`
    `WildcardTermEnum(IndexReader reader, Term term)` Creates a new `WildcardTermEnum`.

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

    Constructors in org.apache.lucene.search.payloads with parameters of type Term
    Constructor and Description
    `BoostingTermQuery(Term term)` Deprecated.
    `BoostingTermQuery(Term term, boolean includeSpanScore)` Deprecated.
    `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` | SpanTermQuery.`term`
    `protected Term` | TermSpans.`term`

    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.

    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(TermPositions positions, Term term)`

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