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

Packages that use Term

org.apache.lucene.analysis.query	Automatically filter high-frequency stopwords.
org.apache.lucene.facet.enhancements	Enhanced category features
org.apache.lucene.facet.enhancements.association	Association category enhancements
org.apache.lucene.facet.index	Indexing of document categories
org.apache.lucene.facet.index.params	Indexing-time specifications for handling facets
org.apache.lucene.facet.search	Faceted Search API
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.pruning	Static Index Pruning Tools
org.apache.lucene.misc	Miscellaneous index tools.
org.apache.lucene.queryParser	A simple query parser implemented with JavaCC.
org.apache.lucene.queryParser.complexPhrase	QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
org.apache.lucene.queryParser.surround.query	This package contains SrndQuery and its subclasses.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.function	Programmatic control over documents scores.
org.apache.lucene.search.join	This modules support index-time and query-time joins.
org.apache.lucene.search.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.regex	Regular expression Query.
org.apache.lucene.search.spans	The calculus of spans.
org.apache.lucene.store.instantiated	InstantiatedIndex, alternative RAM store for small corpora.

Uses of Term in org.apache.lucene.analysis.query

Methods in org.apache.lucene.analysis.query that return Term

Term[]

QueryAutoStopWordAnalyzer.getStopWords() Provides information on which stop words have been identified for all fields

Uses of Term in org.apache.lucene.facet.enhancements

Constructors in org.apache.lucene.facet.enhancements with parameters of type Term

EnhancementsPayloadIterator(List<CategoryEnhancement> enhancementsList, IndexReader indexReader, Term term)
Constructor.

Uses of Term in org.apache.lucene.facet.enhancements.association

Fields in org.apache.lucene.facet.enhancements.association declared as Term

static Term

AssociationsPayloadIterator.ASSOCIATION_POSTING_TERM Default Term for associations

Uses of Term in org.apache.lucene.facet.index

Methods in org.apache.lucene.facet.index with parameters of type Term

PayloadProcessorProvider.PayloadProcessor

FacetsPayloadProcessorProvider.FacetsDirPayloadProcessor.getProcessor(Term term)

Uses of Term in org.apache.lucene.facet.index.params

Fields in org.apache.lucene.facet.index.params declared as Term

static Term

CategoryListParams.DEFAULT_TERM The default term used to store the facets information.

Methods in org.apache.lucene.facet.index.params that return Term

Term	CategoryListParams.getTerm() A Term who's payload holds the category-list.

Constructors in org.apache.lucene.facet.index.params with parameters of type Term

CategoryListParams(Term term)
Constructs a category list parameters object, using the given Term.

Uses of Term in org.apache.lucene.facet.search

Methods in org.apache.lucene.facet.search that return Term

static Term	DrillDown.term(FacetIndexingParams iParams, CategoryPath path) Return a term for drilling down into a category.
static Term	DrillDown.term(FacetSearchParams sParams, CategoryPath path)

Constructors in org.apache.lucene.facet.search with parameters of type Term

PayloadIntDecodingIterator(IndexReader indexReader, Term term, IntDecoder decoder)

PayloadIntDecodingIterator(IndexReader indexReader, Term term, IntDecoder decoder, byte[] buffer)

PayloadIterator(IndexReader indexReader, Term term)

PayloadIterator(IndexReader indexReader, Term term, byte[] buffer)

Uses of Term in org.apache.lucene.index

Methods in org.apache.lucene.index that return Term

Term	Term.createTerm(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

protected void	ThreadedIndexingAndSearchingTestCase.addDocument(Term id, Document doc)
protected void	ThreadedIndexingAndSearchingTestCase.addDocuments(Term id, Collection<Document> docs)
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.
protected void	ThreadedIndexingAndSearchingTestCase.deleteDocuments(Term term)
void	RandomIndexWriter.deleteDocuments(Term term)
int	IndexReader.deleteDocuments(Term term) Deprecated. Write support will be removed in Lucene 4.0. Use IndexWriter.deleteDocuments(Term) instead
void	IndexWriter.deleteDocuments(Term term) Deletes the document(s) containing term.
int	ParallelReader.docFreq(Term term)
abstract int	IndexReader.docFreq(Term t) Returns the number of documents containing the term t.
int	MultiReader.docFreq(Term t)
int	FilterIndexReader.docFreq(Term t)
int	SegmentReader.docFreq(Term t)
abstract PayloadProcessorProvider.PayloadProcessor	PayloadProcessorProvider.ReaderPayloadProcessor.getProcessor(Term term) Returns a PayloadProcessorProvider.ReaderPayloadProcessor for the given term.
TermDocs	SegmentReader.rawTermDocs(Term term) Expert: returns an enumeration of the documents that contain term, including deleted documents (which are normally filtered out).
void	TermDocs.seek(Term term) Sets this to the data for a term.
void	AbstractAllTermDocs.seek(Term term)
void	MultipleTermPositions.seek(Term arg0) Not implemented.
void	FilterIndexReader.FilterTermDocs.seek(Term term)
TermDocs	ParallelReader.termDocs(Term term)
TermDocs	IndexReader.termDocs(Term term) Returns an enumeration of all the documents which contain term.
TermDocs	MultiReader.termDocs(Term term)
TermDocs	FilterIndexReader.termDocs(Term term)
TermDocs	SegmentReader.termDocs(Term term)
TermPositions	IndexReader.termPositions(Term term) Returns an enumeration of all the documents which contain term.
TermEnum	ParallelReader.terms(Term term)
abstract TermEnum	IndexReader.terms(Term t) Returns an enumeration of all terms starting at a given term.
TermEnum	MultiReader.terms(Term term)
TermEnum	FilterIndexReader.terms(Term t)
TermEnum	SegmentReader.terms(Term t)
protected void	ThreadedIndexingAndSearchingTestCase.updateDocument(Term term, Document doc)
void	RandomIndexWriter.updateDocument(Term t, Document doc) Updates a document.
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.
protected void	ThreadedIndexingAndSearchingTestCase.updateDocuments(Term id, Collection<Document> docs)
void	RandomIndexWriter.updateDocuments(Term delTerm, Collection<Document> docs)
void	IndexWriter.updateDocuments(Term delTerm, Collection<Document> 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, Collection<Document> 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.

Constructors in org.apache.lucene.index with parameters of type Term

MultipleTermPositions(IndexReader indexReader, Term[] terms)
Creates a new MultipleTermPositions instance.

PKIndexSplitter(Directory input, Directory dir1, Directory dir2, Term midTerm)
Deprecated. use PKIndexSplitter.PKIndexSplitter(Version, Directory, Directory, Directory, Term) instead. This constructor will be removed in Lucene 4.0.

PKIndexSplitter(Directory input, Directory dir1, Directory dir2, Term midTerm, IndexWriterConfig config1, IndexWriterConfig config2)

PKIndexSplitter(Version version, Directory input, Directory dir1, Directory dir2, Term midTerm)
Split an index based on a given primary key term and a 'middle' term.

Uses of Term in org.apache.lucene.index.pruning

Methods in org.apache.lucene.index.pruning with parameters of type Term

void	CarmelUniformTermPruningPolicy.initPositionsTerm(TermPositions tp, Term t)
void	TFTermPruningPolicy.initPositionsTerm(TermPositions in, Term t)
abstract void	TermPruningPolicy.initPositionsTerm(TermPositions in, Term t) Called when moving TermPositions to a new Term.
void	RIDFTermPruningPolicy.initPositionsTerm(TermPositions tp, Term t)
void	CarmelTopKTermPruningPolicy.initPositionsTerm(TermPositions tp, Term t)
boolean	CarmelUniformTermPruningPolicy.pruneAllPositions(TermPositions termPositions, Term t)
boolean	TFTermPruningPolicy.pruneAllPositions(TermPositions termPositions, Term t)
abstract boolean	TermPruningPolicy.pruneAllPositions(TermPositions termPositions, Term t) Prune all postings per term (invoked once per term per doc)
boolean	RIDFTermPruningPolicy.pruneAllPositions(TermPositions termPositions, Term t)
boolean	CarmelTopKTermPruningPolicy.pruneAllPositions(TermPositions termPositions, Term t)
boolean	TermPruningPolicy.prunePayload(TermPositions in, Term curTerm) Called when checking for the presence of payload for the current term at a current position
int	CarmelUniformTermPruningPolicy.pruneSomePositions(int docNum, int[] positions, Term curTerm)
int	TFTermPruningPolicy.pruneSomePositions(int docNum, int[] positions, Term curTerm)
abstract int	TermPruningPolicy.pruneSomePositions(int docNum, int[] positions, Term curTerm) Prune some postings per term (invoked once per term per doc).
int	RIDFTermPruningPolicy.pruneSomePositions(int docNum, int[] positions, Term curTerm)
int	CarmelTopKTermPruningPolicy.pruneSomePositions(int docNum, int[] positions, Term curTerm)

Uses of Term in org.apache.lucene.misc

Methods in org.apache.lucene.misc with parameters of type Term

static void	GetTermInfo.getTermInfo(Directory dir, Term term)
static long	HighFreqTerms.getTotalTermFreq(IndexReader reader, Term term)

Uses of Term in org.apache.lucene.queryParser

Methods in org.apache.lucene.queryParser with parameters of type Term

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.queryParser.complexPhrase

Methods in org.apache.lucene.queryParser.complexPhrase with parameters of type Term

protected Query

ComplexPhraseQueryParser.newTermQuery(Term term)

Uses of Term in org.apache.lucene.queryParser.surround.query

Methods in org.apache.lucene.queryParser.surround.query that return Term

Term	SrndPrefixQuery.getLucenePrefixTerm(String fieldName)
Term	SrndTermQuery.getLuceneTerm(String fieldName)

Methods in org.apache.lucene.queryParser.surround.query with parameters of type Term

void	SpanNearClauseFactory.addTermWeighted(Term t, float weight)
SpanTermQuery	BasicQueryFactory.newSpanTermQuery(Term term)
TermQuery	BasicQueryFactory.newTermQuery(Term term)
void	SimpleTerm.MatchingTermVisitor.visitMatchingTerm(Term t)

Uses of Term in org.apache.lucene.search

Fields in org.apache.lucene.search declared as Term

protected Term	FilteredTermEnum.currentTerm the current term
protected Term	FuzzyQuery.term
protected Term	WildcardQuery.term

Methods in org.apache.lucene.search that return Term

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	FuzzyQuery.getTerm() Returns the pattern term.
Term	WildcardQuery.getTerm() Returns the pattern term.
Term[]	PhraseQuery.getTerms() Returns the set of terms in this phrase.
protected Term	SearchEquivalenceTestBase.randomTerm() returns a term suitable for searching.
Term	FilteredTermEnum.term() Returns the current Term in the enumeration.

Methods in org.apache.lucene.search with parameters of type Term

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.
protected void	MultiTermQuery.TopTermsScoringBooleanQueryRewrite.addClause(BooleanQuery topLevel, Term term, float boost)
protected void	MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite.addClause(BooleanQuery topLevel, Term term, float boost)
void	TermsFilter.addTerm(Term term) Adds a term to the list of acceptable terms
long	NRTManager.TrackingIndexWriter.deleteDocuments(Term... terms)
long	NRTManager.TrackingIndexWriter.deleteDocuments(Term t)
int	RemoteSearchable.docFreq(Term term) Deprecated.
int	IndexSearcher.docFreq(Term term) Returns total docFreq for this term.
abstract int	Searcher.docFreq(Term term) Deprecated.
int	Searchable.docFreq(Term term) Deprecated. Expert: Returns the number of documents containing term.
int	ParallelMultiSearcher.docFreq(Term term) Deprecated. Executes each Searchable's docFreq() in its own thread and waits for each search to complete and merge the results back together.
int	MultiSearcher.docFreq(Term term) Deprecated.
int[]	RemoteSearchable.docFreqs(Term[] terms) Deprecated.
int[]	Searcher.docFreqs(Term[] terms) Deprecated.
int[]	Searchable.docFreqs(Term[] terms) Deprecated. Expert: For each term in the terms array, calculates the number of documents containing term.
Explanation.IDFExplanation	Similarity.idfExplain(Term term, Searcher searcher) This method forwards to Similarity.idfExplain(Term,Searcher,int) by passing searcher.docFreq(term) as the docFreq.
Explanation.IDFExplanation	Similarity.idfExplain(Term term, Searcher searcher, int docFreq) 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 boolean	SingleTermEnum.termCompare(Term term)
protected abstract boolean	FilteredTermEnum.termCompare(Term term) Equality compare on the 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.
protected boolean	TermRangeTermEnum.termCompare(Term term)
long	NRTManager.TrackingIndexWriter.updateDocument(Term t, Document d)
long	NRTManager.TrackingIndexWriter.updateDocument(Term t, Document d, Analyzer a)
long	NRTManager.TrackingIndexWriter.updateDocuments(Term t, Collection<Document> docs)
long	NRTManager.TrackingIndexWriter.updateDocuments(Term t, Collection<Document> docs, Analyzer a)

Method parameters in org.apache.lucene.search with type arguments of type Term

void	ConstantScoreQuery.extractTerms(Set<Term> terms)
void	DisjunctionMaxQuery.extractTerms(Set<Term> terms)
void	MatchAllDocsQuery.extractTerms(Set<Term> terms)
void	BooleanQuery.extractTerms(Set<Term> terms)
void	TermQuery.extractTerms(Set<Term> terms)
void	MultiPhraseQuery.extractTerms(Set<Term> terms)
void	PhraseQuery.extractTerms(Set<Term> queryTerms)
void	FilteredQuery.extractTerms(Set<Term> terms)
void	Query.extractTerms(Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
Explanation.IDFExplanation	Similarity.idfExplain(Collection<Term> terms, Searcher searcher) Computes a score factor for a phrase.

Constructors in org.apache.lucene.search with parameters of type Term

FuzzyQuery(Term term)
Calls FuzzyQuery(term, 0.5f, 0, Integer.MAX_VALUE).

FuzzyQuery(Term term, float minimumSimilarity)
Calls FuzzyQuery(term, minimumSimilarity, 0, Integer.MAX_VALUE).

FuzzyQuery(Term term, float minimumSimilarity, int prefixLength)
Calls FuzzyQuery(term, minimumSimilarity, prefixLength, Integer.MAX_VALUE).

FuzzyQuery(Term term, float minimumSimilarity, int prefixLength, int maxExpansions)
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.

PrefixFilter(Term prefix)

PrefixQuery(Term prefix)
Constructs a query for terms starting with prefix.

PrefixTermEnum(IndexReader reader, Term prefix)

SingleTermEnum(IndexReader reader, Term singleTerm)
Creates a new SingleTermEnum.

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.function

Method parameters in org.apache.lucene.search.function with type arguments of type Term

void	ValueSourceQuery.extractTerms(Set<Term> terms)
void	CustomScoreQuery.extractTerms(Set<Term> terms)

Uses of Term in org.apache.lucene.search.join

Method parameters in org.apache.lucene.search.join with type arguments of type Term

void	ToChildBlockJoinQuery.extractTerms(Set<Term> terms)
void	ToParentBlockJoinQuery.extractTerms(Set<Term> terms)

Constructors in org.apache.lucene.search.join with parameters of type Term

RawTermFilter(Term term)

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

Constructors in org.apache.lucene.search.payloads with parameters of type Term

PayloadTermQuery(Term term, PayloadFunction function)

PayloadTermQuery(Term term, PayloadFunction function, boolean includeSpanScore)

Uses of Term in org.apache.lucene.search.regex

Methods in org.apache.lucene.search.regex that return Term

Term	SpanRegexQuery.getTerm() Deprecated.
Term	RegexQuery.getTerm()

Methods in org.apache.lucene.search.regex with parameters of type Term

protected boolean

RegexTermEnum.termCompare(Term term)

Constructors in org.apache.lucene.search.regex with parameters of type Term

RegexQuery(Term term)
Constructs a query for terms matching term.

RegexTermEnum(IndexReader reader, Term term, RegexCapabilities regexImpl)

SpanRegexQuery(Term term)
Deprecated.

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

Fields in org.apache.lucene.search.spans declared as Term

protected Term	TermSpans.term
protected Term	SpanTermQuery.term

Fields in org.apache.lucene.search.spans with type parameters of type Term

protected Set<Term>

SpanWeight.terms

Methods in org.apache.lucene.search.spans that return Term

Term	SpanTermQuery.getTerm() Return the term whose spans are matched.

Method parameters in org.apache.lucene.search.spans with type arguments of type Term

void	SpanOrQuery.extractTerms(Set<Term> terms)
void	SpanPositionCheckQuery.extractTerms(Set<Term> terms)
void	SpanTermQuery.extractTerms(Set<Term> terms)
void	SpanNearQuery.extractTerms(Set<Term> terms)
void	SpanNotQuery.extractTerms(Set<Term> terms)
void	FieldMaskingSpanQuery.extractTerms(Set<Term> terms)

Constructors in org.apache.lucene.search.spans with parameters of type Term

SpanTermQuery(Term term)
Construct a SpanTermQuery matching the named term's spans.

TermSpans(TermPositions positions, Term term)

Uses of Term in org.apache.lucene.store.instantiated

Methods in org.apache.lucene.store.instantiated that return Term

Term	InstantiatedTerm.getTerm()
Term	InstantiatedTermEnum.term() Returns the current Term in the enumeration.

Methods in org.apache.lucene.store.instantiated with parameters of type Term

void	InstantiatedIndexWriter.deleteDocuments(Term term) Deprecated.
void	InstantiatedIndexWriter.deleteDocuments(Term[] terms) Deprecated.
int	InstantiatedIndexReader.docFreq(Term t) Deprecated.
void	InstantiatedTermDocs.seek(Term term)
TermDocs	InstantiatedIndexReader.termDocs(Term term) Deprecated.
TermEnum	InstantiatedIndexReader.terms(Term t) Deprecated.
void	InstantiatedIndexWriter.updateDocument(Term term, Document doc) Deprecated.
void	InstantiatedIndexWriter.updateDocument(Term term, Document doc, Analyzer analyzer) Deprecated.