Lucene++ - a full-featured, c++ search engine
API Documentation


LuceneTypes.h
Go to the documentation of this file.
1
2// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3// Distributable under the terms of either the Apache License (Version 2.0)
4// or the GNU Lesser General Public License.
6
7#ifndef LUCENETYPES_H
8#define LUCENETYPES_H
9
10#include "Lucene.h"
11
12#define DECLARE_SHARED_PTR(Type) \
13 class Type; \
14 typedef boost::shared_ptr<Type> Type##Ptr; \
15 typedef boost::weak_ptr<Type> Type##WeakPtr;
16
17namespace Lucene {
18
19// analysis
50DECLARE_SHARED_PTR(StandardAnalyzerSavedStreams)
55DECLARE_SHARED_PTR(StopAnalyzerSavedStreams)
68
69// document
83
84// index
132DECLARE_SHARED_PTR(FieldsReaderLocal)
135DECLARE_SHARED_PTR(FindSegmentsModified)
136DECLARE_SHARED_PTR(FindSegmentsOpen)
137DECLARE_SHARED_PTR(FindSegmentsRead)
138DECLARE_SHARED_PTR(FindSegmentsReopen)
185DECLARE_SHARED_PTR(MyCommitPoint)
186DECLARE_SHARED_PTR(MySegmentTermDocs)
195DECLARE_SHARED_PTR(ParallelTermEnum)
196DECLARE_SHARED_PTR(ParallelTermDocs)
197DECLARE_SHARED_PTR(ParallelTermPositions)
216DECLARE_SHARED_PTR(SegmentReaderRef)
244DECLARE_SHARED_PTR(TermPositionsQueue)
266
267// query parser
275
276// search
283DECLARE_SHARED_PTR(BooleanWeight)
291DECLARE_SHARED_PTR(CachedDfSource)
299DECLARE_SHARED_PTR(ConstantScoreAutoRewriteDefault)
300DECLARE_SHARED_PTR(ConstantScoreBooleanQueryRewrite)
301DECLARE_SHARED_PTR(ConstantScoreFilterRewrite)
303DECLARE_SHARED_PTR(ConstantScorer)
304DECLARE_SHARED_PTR(ConstantWeight)
313DECLARE_SHARED_PTR(DefaultByteParser)
314DECLARE_SHARED_PTR(DefaultCustomScoreProvider)
315DECLARE_SHARED_PTR(DefaultDoubleParser)
316DECLARE_SHARED_PTR(DefaultIntParser)
317DECLARE_SHARED_PTR(DefaultLongParser)
321DECLARE_SHARED_PTR(DisjunctionMaxWeight)
329DECLARE_SHARED_PTR(EmptyDocIdSet)
330DECLARE_SHARED_PTR(EmptyDocIdSetIterator)
335DECLARE_SHARED_PTR(FieldCacheDocIdSet)
340DECLARE_SHARED_PTR(FieldCacheRangeFilterByte)
341DECLARE_SHARED_PTR(FieldCacheRangeFilterDouble)
342DECLARE_SHARED_PTR(FieldCacheRangeFilterInt)
343DECLARE_SHARED_PTR(FieldCacheRangeFilterLong)
344DECLARE_SHARED_PTR(FieldCacheRangeFilterString)
347DECLARE_SHARED_PTR(FieldCacheTermsFilterDocIdSet)
351DECLARE_SHARED_PTR(FieldDocIdSetIteratorIncrement)
352DECLARE_SHARED_PTR(FieldDocIdSetIteratorTermDocs)
360DECLARE_SHARED_PTR(FilterCleaner)
364DECLARE_SHARED_PTR(FilteredQueryWeight)
380DECLARE_SHARED_PTR(MatchAllDocsWeight)
381DECLARE_SHARED_PTR(MatchAllScorer)
384DECLARE_SHARED_PTR(MultiComparatorsFieldValueHitQueue)
387DECLARE_SHARED_PTR(MultiSearcherCallableNoSort)
388DECLARE_SHARED_PTR(MultiSearcherCallableWithSort)
395DECLARE_SHARED_PTR(NumericUtilsDoubleParser)
396DECLARE_SHARED_PTR(NumericUtilsIntParser)
397DECLARE_SHARED_PTR(NumericUtilsLongParser)
398DECLARE_SHARED_PTR(OneComparatorFieldValueHitQueue)
408DECLARE_SHARED_PTR(PayloadTermSpanScorer)
409DECLARE_SHARED_PTR(PayloadTermWeight)
431DECLARE_SHARED_PTR(ScoreTermQueue)
432DECLARE_SHARED_PTR(ScoringBooleanQueryRewrite)
436DECLARE_SHARED_PTR(SimilarityDisableCoord)
438DECLARE_SHARED_PTR(SimilarityIDFExplanation)
478DECLARE_SHARED_PTR(ValueSourceScorer)
479DECLARE_SHARED_PTR(ValueSourceWeight)
483
484// store
499DECLARE_SHARED_PTR(MMapIndexInput)
510DECLARE_SHARED_PTR(SimpleFSIndexInput)
511DECLARE_SHARED_PTR(SimpleFSIndexOutput)
514DECLARE_SHARED_PTR(SingleInstanceLock)
516
517// util
531DECLARE_SHARED_PTR(HeapedScorerDoc)
561}
562
563#endif
#define DECLARE_SHARED_PTR(Type)
Definition: LuceneTypes.h:12
This class converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 1...
Definition: ASCIIFoldingFilter.h:42
Base class for enumerating all but deleted docs.
Definition: AbstractAllTermDocs.h:18
Definition: AbstractField.h:14
Definition: AllTermDocs.h:14
An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...
Definition: Analyzer.h:19
Definition: AttributeSource.h:14
This class holds the state of an AttributeSource.
Definition: AttributeSource.h:168
An AttributeSource contains a list of different Attributes, and methods to add and get them....
Definition: AttributeSource.h:43
Base class for Attributes that can be added to a AttributeSource.
Definition: Attribute.h:18
Calculate the final score as the average score of all payloads seen.
Definition: AveragePayloadFunction.h:17
Base utility class for implementing a CharFilter. You subclass this, and then record mappings by call...
Definition: BaseCharFilter.h:16
Definition: BitSet.h:15
Optimized implementation of a vector of bits.
Definition: BitVector.h:15
A clause in a BooleanQuery.
Definition: BooleanClause.h:15
A Query that matches documents matching boolean combinations of other queries, eg....
Definition: BooleanQuery.h:18
See the description in BooleanScorer, comparing BooleanScorer & BooleanScorer2.
Definition: BooleanScorer2.h:20
Definition: BooleanScorer.h:65
BooleanScorer uses a ~16k array to score windows of docs. So it scores docs 0-16k first,...
Definition: BooleanScorer.h:30
Definition: BooleanScorer.h:87
A simple hash table of document scores within a range.
Definition: BooleanScorer.h:127
Definition: BooleanScorer.h:111
Holds buffered deletes, by docID, term or query. We hold two instances of this class: one for the del...
Definition: BufferedDeletes.h:19
Base implementation class for buffered IndexInput.
Definition: BufferedIndexInput.h:15
Base implementation class for buffered IndexOutput.
Definition: BufferedIndexOutput.h:15
Read text from a character-input stream, buffering characters so as to provide for the efficient read...
Definition: BufferedReader.h:16
Definition: DocumentsWriter.h:497
Definition: ByteBlockPool.h:54
Class that Posting and PostingVector use to write byte streams into shared fixed-size byte[] arrays....
Definition: ByteBlockPool.h:23
Definition: FieldCacheImpl.h:94
Obtains byte field values from the FieldCache using getBytes() and makes those values available as ot...
Definition: ByteFieldSource.h:24
Interface to parse bytes from document fields.
Definition: FieldCache.h:208
IndexInput that knows how to read the byte slices written by Posting and PostingVector....
Definition: ByteSliceReader.h:16
Class to write byte streams into slices of shared byte[]. This is used by DocumentsWriter to hold the...
Definition: ByteSliceWriter.h:16
Implementation of an IndexInput that reads from a portion of the compound file.
Definition: CompoundFileReader.h:83
Internal cache.
Definition: FieldCacheImpl.h:72
Wraps another SpanFilter's result and caches it. The purpose is to allow filters to simply filter,...
Definition: CachingSpanFilter.h:17
This class can be used if the token attributes of a TokenStream are intended to be consumed more than...
Definition: CachingTokenFilter.h:19
Wraps another filter's result and caches it. The purpose is to allow filters to simply filter,...
Definition: CachingWrapperFilter.h:16
A simple class that stores Strings as char[]'s in a hash table. Note that this is not a general purpo...
Definition: CharArraySet.h:17
Definition: CharBlockPool.h:14
Subclasses of CharFilter can be chained to filter CharStream. They can be used as Reader with additio...
Definition: CharFilter.h:17
CharReader is a Reader wrapper. It reads chars from Reader and outputs CharStream,...
Definition: CharReader.h:16
CharStream adds correctOffset functionality over Reader. All Tokenizers accept a CharStream instead o...
Definition: CharStream.h:18
An abstract base class for simple, character-oriented tokenizers.
Definition: CharTokenizer.h:15
Definition: SegmentMerger.h:122
Basic tool and API to check the health of an index and write a new segments file that removes referen...
Definition: CheckIndex.h:20
Writes bytes through to a primary IndexInput, computing checksum as it goes. Note that you cannot use...
Definition: ChecksumIndexInput.h:17
Writes bytes through to a primary IndexOutput, computing checksum. Note that you cannot use seek().
Definition: ChecksumIndexOutput.h:17
Convenience class for storing collate objects.
Definition: Collator.h:15
Collectors are primarily meant to be used to gather raw results from a search, and implement sorting ...
Definition: Collector.h:100
Holds details for each commit point. This class is also passed to the deletion policy....
Definition: IndexFileDeleter.h:149
Describes the score computation for document and query, and can distinguish a match independent of a ...
Definition: ComplexExplanation.h:16
Class for accessing a compound stream. This class implements a directory, but is limited to only read...
Definition: CompoundFileReader.h:18
Combines multiple files into a single compound file. The file format: VInt fileCount {Directory} file...
Definition: CompoundFileWriter.h:27
Simple utility class providing static methods to compress and decompress binary data for stored field...
Definition: CompressionTools.h:15
A MergeScheduler that runs each merge using a separate thread, up until a maximum number of threads (...
Definition: ConcurrentMergeScheduler.h:19
Scorer for conjunctions, sets of queries, all of which are required.
Definition: ConjunctionScorer.h:15
A rewrite method that tries to pick the best constant-score rewrite method based on term and document...
Definition: MultiTermQuery.h:135
A query that wraps a filter and simply returns a constant score equal to the query boost for every do...
Definition: ConstantScoreQuery.h:18
Definition: BooleanScorer2.h:85
Definition: BooleanScorer2.h:145
Definition: BooleanScorer2.h:125
Definition: FieldCache.h:170
An instance of this subclass should be returned by CustomScoreQuery#getCustomScoreProvider,...
Definition: CustomScoreProvider.h:21
Query that sets document score as a programmatic function of several (sub) scores:
Definition: CustomScoreQuery.h:21
Provides support for converting dates to strings and vice-versa. The strings are structured so that l...
Definition: DateField.h:31
Provides support for converting dates to strings and vice-versa. The strings are structured so that l...
Definition: DateTools.h:28
Definition: AttributeSource.h:154
This is the current indexing chain: DocConsumer / DocConsumerPerThread --> code: DocFieldProcessor / ...
Definition: DocumentsWriter.h:447
Default scoring implementation.
Definition: DefaultSimilarity.h:15
Implements the skip list reader for the default posting list format that stores positions and payload...
Definition: DefaultSkipListReader.h:15
Implements the skip list writer for the default posting list format that stores positions and payload...
Definition: DefaultSkipListWriter.h:15
An IndexReader which reads indexes with multiple segments.
Definition: DirectoryReader.h:19
A Directory is a flat list of files. Files may be written once, when they are created....
Definition: Directory.h:18
A query that generates the union of documents produced by its subqueries, and that scores each docume...
Definition: DisjunctionMaxQuery.h:27
The Scorer for DisjunctionMaxQuery. The union of all documents generated by the the subquery scorers ...
Definition: DisjunctionMaxScorer.h:18
A Scorer for OR like queries, counterpart of ConjunctionScorer. This Scorer implements Scorer#skipTo(...
Definition: DisjunctionSumScorer.h:16
Definition: DocConsumerPerThread.h:14
Definition: DocConsumer.h:14
Definition: DocFieldConsumerPerField.h:14
Definition: DocFieldConsumerPerThread.h:14
Definition: DocFieldConsumer.h:14
Definition: DocFieldConsumers.h:50
Definition: DocFieldConsumersPerField.h:14
Definition: DocFieldConsumersPerThread.h:14
This is just a "splitter" class: it lets you wrap two DocFieldConsumer instances as a single consumer...
Definition: DocFieldConsumers.h:16
Holds all per thread, per field state.
Definition: DocFieldProcessorPerField.h:15
Definition: DocFieldProcessorPerThread.h:63
Gathers all Fieldables for a document under the same name, updates FieldInfos, and calls per-field co...
Definition: DocFieldProcessorPerThread.h:19
This is a DocConsumer that gathers all fields under the same name, and calls per-field consumers to p...
Definition: DocFieldProcessor.h:17
Simple DocIdSet and DocIdSetIterator backed by a BitSet.
Definition: DocIdBitSet.h:15
This abstract class defines methods to iterate over a set of non-decreasing doc ids....
Definition: DocIdSetIterator.h:17
A DocIdSet contains a set of doc ids. Implementing classes must only implement iterator to provide ac...
Definition: DocIdSet.h:16
Holds state for inverting all occurrences of a single field in the document. This class doesn't do an...
Definition: DocInverterPerField.h:17
This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a Invert...
Definition: DocInverterPerThread.h:17
This is a DocFieldConsumer that inverts each field, separately, from a Document, and accepts a Invert...
Definition: DocInverter.h:16
Definition: DocumentsWriter.h:356
Represents field values as different types. Normally created via a ValueSuorce for a particular field...
Definition: DocValues.h:22
Consumer returns this on each doc. This holds any state that must be flushed synchronized "in docID o...
Definition: DocumentsWriter.h:402
Documents are the unit of indexing and search.
Definition: Document.h:24
Used by DocumentsWriter to maintain per-thread state. We keep a separate Posting hash and other state...
Definition: DocumentsWriterThreadState.h:17
This class accepts multiple added documents and directly writes a single segment file....
Definition: DocumentsWriter.h:54
Definition: FieldCacheImpl.h:127
Obtains double field values from the FieldCache using getDoubles() and makes those values available a...
Definition: DoubleFieldSource.h:25
Interface to parse doubles from document fields.
Definition: FieldCache.h:244
Definition: FieldCacheImpl.h:51
Definition: ExactPhraseScorer.h:14
Describes the score computation for document and query.
Definition: Explanation.h:15
Base class for Directory implementations that store index files in the file system....
Definition: FSDirectory.h:29
Base class for file system based locking implementation.
Definition: FSLockFactory.h:15
An efficient implementation of QueryParserCharStream interface.
Definition: FastCharStream.h:18
Definition: FieldCacheImpl.h:160
A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/debugging.
Definition: FieldCache.h:255
The default cache implementation, storing all values in memory. A WeakHashMap is used for storage.
Definition: FieldCacheImpl.h:15
A range filter built on top of a cached single term field (in FieldCache).
Definition: FieldCacheRangeFilter.h:38
Provides methods for sanity checking that entries in the FieldCache are not wasteful or inconsistent.
Definition: FieldCacheSanityChecker.h:28
A base class for ValueSource implementations that retrieve values for a single field from the FieldCa...
Definition: FieldCacheSource.h:28
A Filter that only accepts documents whose single term value in the specified field is contained in t...
Definition: FieldCacheTermsFilter.h:46
Maintains caches of term values.
Definition: FieldCache.h:17
Provides a FieldComparator for custom field sorting.
Definition: FieldComparatorSource.h:15
A FieldComparator compares hits so as to determine their sort order when collecting the top results w...
Definition: FieldComparator.h:42
Collects sorted results from Searchable's and collates them. The elements put into this queue must be...
Definition: FieldDocSortedHitQueue.h:16
A ScoreDoc which also contains information about how to sort the referenced document....
Definition: FieldDoc.h:20
Definition: FieldInfo.h:14
Access to the Fieldable Info file that describes document fields and whether or not they are indexed....
Definition: FieldInfos.h:18
This class tracks the number and position / offset parameters of terms being added to the index....
Definition: FieldInvertState.h:16
Wrapper to allow SpanQuery objects participate in composite single-field SpanQueries by 'lying' about...
Definition: FieldMaskingSpanQuery.h:52
Status from testing field norms.
Definition: CheckIndex.h:237
A query that scores each document as the value of the numeric input field.
Definition: FieldScoreQuery.h:43
The FieldSelector allows one to make decisions about what Fields get loaded on a Document by IndexRea...
Definition: FieldSelector.h:16
For each Field, store a sorted collection of TermVectorEntrys This is not thread-safe.
Definition: FieldSortedTermVectorMapper.h:17
Definition: FieldValueHitQueue.h:56
A hit queue for sorting by hits by terms in more than one field. Uses FieldCache::DEFAULT for maintai...
Definition: FieldValueHitQueue.h:19
Definition: Field.h:14
Synonymous with Field.
Definition: Fieldable.h:20
Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>....
Definition: FieldsReader.h:16
Definition: FieldsWriter.h:14
Convenience class for reading character files.
Definition: FileReader.h:15
A Directory instance that switches files between two other Directory instances.
Definition: FileSwitchDirectory.h:21
A FilterIndexReader contains another IndexReader, which it uses as its basic source of data,...
Definition: FilterIndexReader.h:21
Filter caching singleton. It can be used to save filters locally for reuse. Also could be used as a p...
Definition: FilterManager.h:20
Abstract base class for restricting which documents may be returned during searching.
Definition: Filter.h:15
Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validati...
Definition: FilteredDocIdSetIterator.h:16
Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation m...
Definition: FilteredDocIdSet.h:23
A query that applies a filter to the results of another query.
Definition: FilteredQuery.h:20
Abstract class for enumerating a subset of all terms.
Definition: FilteredTermEnum.h:18
This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter ...
Definition: FlagsAttribute.h:16
Definition: FormatPostingsDocsConsumer.h:14
Consumes doc & freq, writing them using the current index file format.
Definition: FormatPostingsDocsWriter.h:15
Abstract API that consumes terms, doc, freq, prox and payloads postings. Concrete implementations of ...
Definition: FormatPostingsFieldsConsumer.h:16
Definition: FormatPostingsFieldsWriter.h:14
Definition: FormatPostingsPositionsConsumer.h:14
Definition: FormatPostingsPositionsWriter.h:14
Definition: FormatPostingsTermsConsumer.h:14
Definition: FormatPostingsTermsWriter.h:14
Used by DocumentsWriter to merge the postings from multiple ThreadStates when creating a segment.
Definition: FreqProxFieldMergeState.h:15
Definition: FreqProxTermsWriterPerField.h:14
Definition: FreqProxTermsWriterPerThread.h:14
Definition: FreqProxTermsWriter.h:41
Definition: FreqProxTermsWriter.h:15
A Future represents the result of an asynchronous computation. Methods are provided to check if the c...
Definition: ThreadPool.h:22
Implements the fuzzy search query. The similarity measurement is based on the Levenshtein (edit dista...
Definition: FuzzyQuery.h:19
Subclass of FilteredTermEnum for enumerating all terms that are similar to the specified filter term.
Definition: FuzzyTermEnum.h:18
Definition: HitQueueBase.h:14
Definition: HitQueue.h:14
Small Util class used to pass both an idf factor as well as an explanation for that factor.
Definition: Explanation.h:70
A filter that replaces accented characters in the ISO Latin 1 character set (ISO-8859-1) by their una...
Definition: ISOLatin1AccentFilter.h:21
Represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.
Definition: IndexCommit.h:22
Policy for deletion of stale index commits. Implement this interface, and pass it to one of the Index...
Definition: IndexDeletionPolicy.h:27
This class keeps track of each SegmentInfos instance that is still "live", either because it correspo...
Definition: IndexFileDeleter.h:34
Filename filter that accept filenames and extensions only created by Lucene.
Definition: IndexFileNameFilter.h:15
Abstract base class for input from a file in a Directory. A random-access input stream....
Definition: IndexInput.h:17
Abstract base class for output to a file in a Directory. A random-access output stream....
Definition: IndexOutput.h:18
If getReader has been called (ie, this writer is in near real-time mode), then after a merge complete...
Definition: IndexWriter.h:1100
IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...
Definition: IndexReader.h:39
Implements search over a single IndexReader.
Definition: IndexSearcher.h:23
Returned from checkIndex() detailing the health and status of the index.
Definition: CheckIndex.h:108
An IndexWriter creates and maintains an index.
Definition: IndexWriter.h:90
The IndexingChain must define the getChain(DocumentsWriter) method which returns the DocConsumer that...
Definition: DocumentsWriter.h:423
Stream override to write messages to a file.
Definition: InfoStream.h:29
Stream override to write messages to a std::cout.
Definition: InfoStream.h:44
Utility class to support streaming info messages.
Definition: InfoStream.h:16
An InputStreamReader is a bridge from byte streams to character streams.
Definition: InputStreamReader.h:15
Simple container for a collection of related CacheEntry objects that in conjunction with each other r...
Definition: FieldCacheSanityChecker.h:95
Definition: IntBlockPool.h:14
Definition: FieldCacheImpl.h:105
Obtains int field values from the FieldCache using getInts() and makes those values available as othe...
Definition: IntFieldSource.h:24
Interface to parse ints from document fields.
Definition: FieldCache.h:220
Definition: NumericUtils.h:162
Definition: InvertedDocConsumerPerField.h:14
Definition: InvertedDocConsumerPerThread.h:14
Definition: InvertedDocConsumer.h:14
Definition: InvertedDocEndConsumerPerField.h:14
Definition: InvertedDocEndConsumerPerThread.h:14
Definition: InvertedDocEndConsumer.h:14
This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately remove...
Definition: KeepOnlyLastCommitDeletionPolicy.h:16
Tokenizes the entire stream as a single token. This is useful for data like zip codes,...
Definition: KeywordAnalyzer.h:16
Emits the entire input as a single token.
Definition: KeywordTokenizer.h:15
Removes words that are too long or too short from the stream.
Definition: LengthFilter.h:15
A LetterTokenizer is a tokenizer that divides text at non-letters. That's to say, it defines tokens a...
Definition: LetterTokenizer.h:19
Load the First field and break. See FieldSelectorResult#LOAD_AND_BREAK.
Definition: LoadFirstFieldSelector.h:16
Base class for Locking implementation. Directory uses instances of this class to implement locking....
Definition: LockFactory.h:23
An interprocess mutex lock.
Definition: Lock.h:16
This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's file...
Definition: LogByteSizeMergePolicy.h:16
This is a LogMergePolicy that measures size of a segment as the number of documents (not taking delet...
Definition: LogDocMergePolicy.h:16
This class implements a MergePolicy that tries to merge segments into levels of exponentially increas...
Definition: LogMergePolicy.h:24
Definition: FieldCacheImpl.h:116
Interface to parse longs from document fields.
Definition: FieldCache.h:232
Callback for splitLongRange. You need to overwrite only one of the methods. NOTE: This is a very low-...
Definition: NumericUtils.h:148
Normalizes token text to lower case.
Definition: LowerCaseFilter.h:15
LowerCaseTokenizer performs the function of LetterTokenizer and LowerCaseFilter together....
Definition: LowerCaseTokenizer.h:21
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Utility class to support signaling notifications.
Definition: LuceneSignal.h:16
Lucene thread container.
Definition: LuceneThread.h:23
File-based Directory implementation that uses mmap for reading, and SimpleFSIndexOutput for writing.
Definition: MMapDirectory.h:22
A FieldSelector based on a Map of field names to FieldSelectorResults.
Definition: MapFieldSelector.h:17
Simplistic CharFilter that applies the mappings contained in a NormalizeCharMap to the character stre...
Definition: MappingCharFilter.h:16
A query that matches all documents.
Definition: MatchAllDocsQuery.h:15
Returns the maximum payload score seen, else 1 if there are no payloads on the doc.
Definition: MaxPayloadFunction.h:17
Remaps docIDs after a merge has completed, where the merged segments had at least one deletion....
Definition: MergeDocIDRemapper.h:17
A MergePolicy determines the sequence of primitive merge operations to be used for overall merge and ...
Definition: MergePolicy.h:32
IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePol...
Definition: MergeScheduler.h:16
A MergeSpecification instance provides the information necessary to perform multiple merges....
Definition: MergePolicy.h:119
Calculates the minimum payload seen.
Definition: MinPayloadFunction.h:15
A QueryParser which constructs queries to search multiple fields.
Definition: MultiFieldQueryParser.h:16
This abstract class reads skip lists with multiple levels.
Definition: MultiLevelSkipListReader.h:20
This abstract class writes skip lists with multiple levels.
Definition: MultiLevelSkipListWriter.h:36
MultiPhraseQuery is a generalized version of PhraseQuery, with an added method add(Term[])....
Definition: MultiPhraseQuery.h:18
An IndexReader which reads multiple indexes, appending their content.
Definition: MultiReader.h:15
Implements search over a set of Searchables.
Definition: MultiSearcher.h:19
Definition: DirectoryReader.h:225
Definition: DirectoryReader.h:195
Definition: DirectoryReader.h:278
A wrapper for MultiTermQuery, that exposes its functionality as a Filter.
Definition: MultiTermQueryWrapperFilter.h:22
An abstract Query that matches documents containing a subset of terms provided by a FilteredTermEnum ...
Definition: MultiTermQuery.h:31
Allows you to iterate over the TermPositions for multiple Terms as a single TermPositions.
Definition: MultipleTermPositions.h:16
Implements LockFactory using native file lock.
Definition: NativeFSLockFactory.h:16
A Spans that is formed from the ordered subspans of a SpanNearQuery where the subspans do not overlap...
Definition: NearSpansOrdered.h:31
Similar to NearSpansOrdered, but for the unordered case.
Definition: NearSpansUnordered.h:17
Use this LockFactory to disable locking entirely. Only one instance of this lock is created....
Definition: NoLockFactory.h:18
Holds a map of String input to String output, to be used with MappingCharFilter.
Definition: NormalizeCharMap.h:15
Taps into DocInverter, as an InvertedDocEndConsumer, which is called at the end of inverting each fie...
Definition: NormsWriterPerField.h:16
Definition: NormsWriterPerThread.h:14
Writes norms. Each thread X field accumulates the norms for the doc/fields it saw,...
Definition: NormsWriter.h:16
Number of documents a delete term applies to.
Definition: BufferedDeletes.h:43
Provides support for converting longs to Strings, and back again. The strings are structured so that ...
Definition: NumberTools.h:26
This class provides a Field that enables indexing of numeric values for efficient range filtering and...
Definition: NumericField.h:59
A Filter that only accepts numeric values within a specified range. To use this, you must first index...
Definition: NumericRangeFilter.h:24
A Query that matches numeric values within a specified range. To use this, you must first index the n...
Definition: NumericRangeQuery.h:108
This class provides a TokenStream for indexing numeric values that can be used by NumericRangeQuery o...
Definition: NumericTokenStream.h:52
This is a helper class to generate prefix-encoded representations for numerical values and supplies c...
Definition: NumericUtils.h:37
The start and end character offset of a Token.
Definition: OffsetAttribute.h:15
OneMerge provides the information necessary to perform an individual primitive merge operation,...
Definition: MergePolicy.h:76
Definition: OpenBitSetDISI.h:14
An iterator to iterate over set bits in an OpenBitSet. This is faster than nextSetBit() for iterating...
Definition: OpenBitSetIterator.h:17
An "open" BitSet implementation that allows direct access to the array of words storing the bits.
Definition: OpenBitSet.h:19
Obtains the ordinal of the field value from the default Lucene FieldCache using getStringIndex().
Definition: OrdFieldSource.h:31
Models the existing parallel array structure.
Definition: TermVectorsReader.h:118
Implements parallel search over a set of Searchables.
Definition: ParallelMultiSearcher.h:18
An IndexReader which reads multiple, parallel indexes. Each index added must have the same number of ...
Definition: ParallelReader.h:26
Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...
Definition: FieldCache.h:200
The start and end character offset of a Token.
Definition: PayloadAttribute.h:15
An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...
Definition: PayloadFunction.h:18
This class is very similar to SpanNearQuery except that it factors in the value of the payloads locat...
Definition: PayloadNearQuery.h:25
Definition: PayloadNearQuery.h:63
Definition: PayloadNearQuery.h:52
Experimental class to get set of payloads for most standard Lucene queries. Operates like Highlighter...
Definition: PayloadSpanUtil.h:16
This class is very similar to SpanTermQuery except that it factors in the value of the payload locate...
Definition: PayloadTermQuery.h:21
A Payload is metadata that can be stored together with each occurrence of a term. This metadata is st...
Definition: Payload.h:21
RAMFile buffer for DocWriters.
Definition: DocumentsWriter.h:381
This analyzer is used to facilitate scenarios where different fields require different analysis techn...
Definition: PerFieldAnalyzerWrapper.h:29
Position of a term in a document that takes into account the term offset within the phrase.
Definition: PhrasePositions.h:15
A Query that matches documents containing a particular sequence of terms. A PhraseQuery is built by Q...
Definition: PhraseQuery.h:18
Definition: PhraseQueue.h:14
Scoring functionality for phrase queries. A document is considered matching if it contains the phrase...
Definition: PhraseScorer.h:21
Transforms the token stream as per the Porter stemming algorithm. Note: the input to the stemming fil...
Definition: PorterStemFilter.h:31
This is the Porter stemming algorithm, coded up as thread-safe ANSI C by the author.
Definition: PorterStemmer.h:26
Definition: PositionBasedTermVectorMapper.h:14
The positionIncrement determines the position of this token relative to the previous Token in a Token...
Definition: PositionIncrementAttribute.h:32
Definition: SpanFilterResult.h:39
A Collector implementation which wraps another Collector and makes sure only documents with scores > ...
Definition: PositiveScoresOnlyCollector.h:16
A Filter that restricts search results to values that have a matching prefix in a given field.
Definition: PrefixFilter.h:15
A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by Qu...
Definition: PrefixQuery.h:18
Subclass of FilteredTermEnum for enumerating all terms that match the specified prefix filter term.
Definition: PrefixTermEnum.h:18
Definition: HitQueueBase.h:45
This interface describes a character stream that maintains line and column number positions of the ch...
Definition: QueryParserCharStream.h:22
Token literal values and constants.
Definition: QueryParserConstants.h:15
Token Manager.
Definition: QueryParserTokenManager.h:15
Describes the input token stream.
Definition: QueryParserToken.h:15
The most important method is parse(const String&).
Definition: QueryParser.h:70
Definition: QueryTermVector.h:14
Constrains search results to only match those which also match a provided query.
Definition: QueryWrapperFilter.h:20
The abstract base class for queries.
Definition: Query.h:31
A memory-resident Directory implementation. Locking implementation is by default the SingleInstanceLo...
Definition: RAMDirectory.h:17
File used as buffer in RAMDirectory.
Definition: RAMFile.h:15
A memory-resident IndexInput implementation.
Definition: RAMInputStream.h:15
A memory-resident IndexOutput implementation.
Definition: RAMOutputStream.h:15
Utility class to generate a stream of pseudorandom numbers.
Definition: Random.h:15
This is the base class for an in-memory posting list, keyed by a Token. TermsHash maintains a hash ta...
Definition: RawPostingList.h:19
Definition: ReadOnlyDirectoryReader.h:14
Definition: ReadOnlySegmentReader.h:14
Definition: DirectoryReader.h:302
Abstract class for reading character streams.
Definition: Reader.h:15
Tracks the reference count for a single index file.
Definition: IndexFileDeleter.h:130
A Scorer for queries with a required subscorer and an excluding (prohibited) sub DocIdSetIterator....
Definition: ReqExclScorer.h:16
A Scorer for queries with a required part and an optional part. Delays skipTo() on the optional part ...
Definition: ReqOptSumScorer.h:16
Used by DocumentsWriter to implemented a StringReader that can be reset to a new string; we use this ...
Definition: ReusableStringReader.h:16
Obtains the ordinal of the field value from the default Lucene FieldCache using getStringIndex() and ...
Definition: ReverseOrdFieldSource.h:31
Abstract class that defines how the query is rewritten.
Definition: MultiTermQuery.h:122
A Scorer which wraps another scorer and caches the score of the current document. Successive calls to...
Definition: ScoreCachingWrappingScorer.h:22
Expert: Returned by low-level search implementations.
Definition: ScoreDoc.h:16
A ScorerDocQueue maintains a partial ordering of its Scorers such that the least Scorer can always be...
Definition: ScorerDocQueue.h:16
Common scoring functionality for different types of queries.
Definition: Scorer.h:33
The interface for search implementations.
Definition: Searchable.h:24
An abstract base class for search implementations. Implements the main search methods.
Definition: Searcher.h:18
A collection of SegmentInfo objects to be used as a base class for SegmentInfos.
Definition: SegmentInfoCollection.h:15
Holds the status of each segment in the index. See segmentInfos.
Definition: CheckIndex.h:168
Information about a segment such as it's name, directory, and files related to the segment.
Definition: SegmentInfo.h:16
A collection of SegmentInfo objects with methods for operating on those segments in relation to the f...
Definition: SegmentInfos.h:15
Definition: SegmentMergeInfo.h:14
Definition: SegmentMergeQueue.h:14
The SegmentMerger class combines two or more Segments, represented by an IndexReader (add,...
Definition: SegmentMerger.h:20
Definition: SegmentReader.h:15
Definition: SegmentTermDocs.h:14
Definition: SegmentTermEnum.h:14
Definition: SegmentTermPositionVector.h:14
Definition: SegmentTermPositions.h:14
Definition: SegmentTermVector.h:14
Definition: SegmentWriteState.h:14
A MergeScheduler that simply does each merge sequentially, using the current thread.
Definition: SerialMergeScheduler.h:15
Declare what fields to load normally and what fields to load lazily.
Definition: SetBasedFieldSelector.h:15
Delegating scoring implementation. Useful in Query#getSimilarity(Searcher) implementations,...
Definition: SimilarityDelegator.h:16
Scoring API.
Definition: Similarity.h:427
An Analyzer that filters LetterTokenizer with LowerCaseFilter.
Definition: SimpleAnalyzer.h:15
A straightforward implementation of FSDirectory using std::ofstream and std::ifstream.
Definition: SimpleFSDirectory.h:15
Implements LockFactory using File#createNewFile().
Definition: SimpleFSLockFactory.h:17
Implements LockFactory for a single in-process instance, meaning all locking will take place through ...
Definition: SingleInstanceLockFactory.h:20
Count a scorer as a single match.
Definition: BooleanScorer2.h:105
Subclass of FilteredTermEnum for enumerating a single term.
Definition: SingleTermEnum.h:18
Definition: DocInverterPerThread.h:44
Definition: TeeSinkTokenFilter.h:95
A filter that decides which AttributeSource states to store in the sink.
Definition: TeeSinkTokenFilter.h:120
Used to buffer the top skip levels.
Definition: MultiLevelSkipListReader.h:88
Definition: DocumentsWriter.h:457
Definition: SloppyPhraseScorer.h:14
Definition: SnapshotDeletionPolicy.h:14
Stores information about how to sort documents by terms in an individual field. Fields must be indexe...
Definition: SortField.h:16
Encapsulates sort criteria for returned hits.
Definition: Sort.h:68
Store a sorted collection of TermVectorEntrys. Collects all term information into a single,...
Definition: SortedTermVectorMapper.h:22
Stores and iterate on sorted integers in compressed form in RAM.
Definition: SortedVIntList.h:22
The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery.
Definition: SpanFilterResult.h:15
Abstract base class providing a mechanism to restrict searches to a subset of an index and also maint...
Definition: SpanFilter.h:21
Matches spans near the beginning of a field.
Definition: SpanFirstQuery.h:16
Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...
Definition: SpanNearQuery.h:16
Removes matches which overlap with another SpanQuery.
Definition: SpanNotQuery.h:15
Matches the union of its clauses.
Definition: SpanOrQuery.h:15
Constrains search results to only match those which also match a provided query. Also provides positi...
Definition: SpanQueryFilter.h:20
Base class for span-based queries.
Definition: SpanQuery.h:15
Public for extension only.
Definition: SpanScorer.h:15
Matches spans containing a term.
Definition: SpanTermQuery.h:15
Public for use by other weight implementations.
Definition: SpanWeight.h:15
An enumeration of span matches. Used to implement span searching. Each span represents a range of ter...
Definition: Spans.h:17
Filters StandardTokenizer with StandardFilter, LowerCaseFilter and StopFilter, using a list of Englis...
Definition: StandardAnalyzer.h:23
Normalizes tokens extracted with StandardTokenizer.
Definition: StandardFilter.h:15
Definition: StandardTokenizerImpl.h:14
A grammar-based tokenizer.
Definition: StandardTokenizer.h:34
Definition: SpanFilterResult.h:56
Filters LetterTokenizer with LowerCaseFilter and StopFilter.
Definition: StopAnalyzer.h:18
Removes stop words from a token stream.
Definition: StopFilter.h:15
Status from testing stored fields.
Definition: CheckIndex.h:275
Definition: StoredFieldsWriter.h:50
Definition: StoredFieldsWriterPerThread.h:14
This is a DocFieldConsumer that writes stored fields.
Definition: StoredFieldsWriter.h:15
Definition: FieldCacheImpl.h:138
Definition: FieldCacheImpl.h:149
Stores term text values and document ordering data.
Definition: FieldCache.h:180
Convenience class for reading strings.
Definition: StringReader.h:15
Definition: BooleanScorer.h:146
Utility class to support locking via a mutex.
Definition: Synchronize.h:16
This TokenFilter provides the ability to set aside attribute states that have already been analyzed....
Definition: TeeSinkTokenFilter.h:62
The term text of a Token.
Definition: TermAttribute.h:15
Definition: TermBuffer.h:14
TermDocs provides an interface for enumerating <document, frequency>; pairs for a term....
Definition: TermDocs.h:19
Abstract class for enumerating terms.
Definition: TermEnum.h:18
Provides access to stored term vector of a document field. The vector consists of the name of the fie...
Definition: TermFreqVector.h:18
Status from testing term index.
Definition: CheckIndex.h:253
A TermInfo is the record of information stored for a term.
Definition: TermInfo.h:15
Definition: TermInfosReader.h:74
This stores a monotonically increasing set of <Term, TermInfo> pairs in a Directory....
Definition: TermInfosReader.h:17
This stores a monotonically increasing set of <Term, TermInfo> pairs in a Directory....
Definition: TermInfosWriter.h:16
Extends TermFreqVector to provide additional information about positions in which each of the terms i...
Definition: TermPositionVector.h:16
TermPositions provides an interface for enumerating the <document, frequency, <position>*> tuples for...
Definition: TermPositions.h:18
A Query that matches documents containing a term. This may be combined with other terms with a Boolea...
Definition: TermQuery.h:16
A Filter that restricts search results to a range of term values in a given field.
Definition: TermRangeFilter.h:22
A Query that matches documents within an range of terms.
Definition: TermRangeQuery.h:21
Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.
Definition: TermRangeTermEnum.h:18
A Scorer for documents matching a Term.
Definition: TermScorer.h:15
Public for extension only.
Definition: TermSpans.h:15
Compares TermVectorEntrys first by frequency and then by the term (case-sensitive)
Definition: TermVectorEntryFreqSortedComparator.h:15
Convenience class for holding TermVector information.
Definition: TermVectorEntry.h:15
The TermVectorMapper can be used to map Term Vectors into your own structure instead of the parallel ...
Definition: TermVectorMapper.h:18
The TermVectorOffsetInfo class holds information pertaining to a Term in a TermPositionVector's offse...
Definition: TermVectorOffsetInfo.h:17
Status from testing stored fields.
Definition: CheckIndex.h:294
Container for a term at a position.
Definition: PositionBasedTermVectorMapper.h:49
Definition: TermVectorsReader.h:14
Definition: TermVectorsTermsWriter.h:54
Definition: TermVectorsTermsWriterPerField.h:14
Definition: TermVectorsTermsWriterPerThread.h:14
Definition: TermVectorsTermsWriter.h:80
Definition: TermVectorsTermsWriter.h:16
Definition: TermVectorsWriter.h:14
A Term represents a word from text. This is the unit of search. It is composed of two elements,...
Definition: Term.h:20
Implement this class to plug into the TermsHash processor, which inverts & stores Tokens into a hash ...
Definition: TermsHashConsumerPerField.h:16
Definition: TermsHashConsumerPerThread.h:14
Definition: TermsHashConsumer.h:14
Definition: TermsHashPerField.h:14
Definition: TermsHashPerThread.h:14
This class implements InvertedDocConsumer, which is passed each token produced by the analyzer on eac...
Definition: TermsHash.h:18
Utility class to handle a pool of threads.
Definition: ThreadPool.h:46
The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowe...
Definition: TimeLimitingCollector.h:17
Creates a TokenAttributeFactory returning Token as instance for the basic attributes and for all othe...
Definition: Token.h:338
A TokenFilter is a TokenStream whose input is another TokenStream.
Definition: TokenFilter.h:18
A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text.
Definition: TokenStream.h:44
A Token is an occurrence of a term from the text of a field. It consists of a term's text,...
Definition: Token.h:76
A Tokenizer is a TokenStream whose input is a Reader.
Definition: Tokenizer.h:20
A base class for all collectors that return a TopDocs output. This collector allows easy extension by...
Definition: TopDocsCollector.h:21
Represents hits returned by Searcher#search(QueryPtr, FilterPtr, int32_t) and Searcher#search(QueryPt...
Definition: TopDocs.h:16
A Collector that sorts by SortField using FieldComparators.
Definition: TopFieldCollector.h:17
Represents hits returned by Searcher#search(QueryPtr, FilterPtr, int32_t, SortPtr).
Definition: TopFieldDocs.h:15
A Collector implementation that collects the top-scoring hits, returning them as a TopDocs....
Definition: TopScoreDocCollector.h:21
A Token's lexical type. The Default value is "word".
Definition: TypeAttribute.h:15
Definition: UTF8Stream.h:120
Definition: UTF8Stream.h:106
Definition: UTF8Stream.h:81
Definition: UTF8Stream.h:67
Definition: UTF8Stream.h:44
Definition: UnicodeUtils.h:84
Definition: UnicodeUtils.h:89
A Query that sets the scores of document to the values obtained from a ValueSource.
Definition: ValueSourceQuery.h:22
Source of values for basic function queries.
Definition: ValueSource.h:21
Definition: DocumentsWriter.h:469
Calculate query weights and build query scorers.
Definition: Weight.h:30
An Analyzer that uses WhitespaceTokenizer.
Definition: WhitespaceAnalyzer.h:15
A WhitespaceTokenizer is a tokenizer that divides text at whitespace. Adjacent sequences of non-White...
Definition: WhitespaceTokenizer.h:16
Implements the wildcard search query. Supported wildcards are *, which matches any character sequence...
Definition: WildcardQuery.h:21
Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term.
Definition: WildcardTermEnum.h:18
Loader for text files that represent a list of stopwords.
Definition: WordlistLoader.h:15
Definition: AbstractAllTermDocs.h:12

clucene.sourceforge.net