| Interface | Description | 
|---|---|
| AggregateRule | AggregateRuledefines a configuration for a node index
 aggregate. | 
| CloseableHits | Defines an interface for query hits that need to be closed when done reading
 from it. | 
| ExcerptProvider | ExcerptProviderdefines an interface to create an excerpt for
 a matching node. | 
| HierarchyResolver | HierarchyResolverextends anIndexReaderwith the ability to resolve a JCR hierarchy. | 
| HighlightingExcerptProvider | HighlightingExcerptProviderextends theExcerptProviderinterface with a method that highlights matching
 terms in arbitrary text. | 
| IndexingConfiguration | IndexingConfigurationdefines the interface to check whether
 a certain property is indexed or not. | 
| IndexListener | Defines an interface that allows implementing classes to listen for index
 changes (namely document deletes) while using a  ReadOnlyIndexReader. | 
| JackrabbitQuery | JackrabbitQuerydefines an interface for Jackrabbit query
 implementations that are at the root of the lucene query tree. | 
| MultiColumnQuery | MultiColumnQuerydefines an interface for a query that returnsMultiColumnQueryHits. | 
| MultiColumnQueryHits | MultiColumnQueryHitsdefines an interface for reading tuples ofScoreNodes. | 
| MultiIndexReader | MultiIndexReaderexposes methods to get access to the containedIndexReaders of thisMultiIndexReader. | 
| NamespaceMappings | The class  NamespaceMappingsholds a namespace mapping that is
 used internally in the search index. | 
| QueryHits | Defines an interface for reading  ScoreNodes | 
| RedoLog | Defines a redo log for changes that have not been committed to disk. | 
| RedoLogFactory | RedoLogFactorya factory forRedoLogs. | 
| ReleaseableIndexReader | ReleaseableIndexReader... | 
| ScoreNodeIterator | A range iterator over  ScoreNode[]. | 
| SpellChecker | SpellCheckerdefines an interface to run a spellchecker over
 a fulltext query statement. | 
| SynonymProvider | SynonymProviderdefines an interface for a component that
 returns synonyms for a given term. | 
| Transformable | Transformablemarks queries that can transform the value to
 upper- or lower-case. | 
| TransformConstants | TransformConstantsdefines constants for query processing. | 
| Class | Description | 
|---|---|
| AbstractExcerpt | AbstractExcerptimplements base functionality for an excerpt
 provider. | 
| AbstractNamespaceMappings | AbstractNamespaceMappingsis the base class for index internal
 namespace mappings. | 
| AbstractQueryHits | AbstractQueryHitsserves as a base class forQueryHitsimplementations. | 
| AbstractQueryImpl | AbstractQueryImplprovides a base class for executable queries
 based onSearchIndex. | 
| CachingMultiIndexReader | |
| ChildNodesQueryHits | ChildNodesQueryHitsimplements query hits that returns the child
 nodes of another given query hits. | 
| ConsistencyCheck | Implements a consistency check on the search index. | 
| ConsistencyCheckError | Common base class for errors detected during the consistency check. | 
| DateField | Implements  Date<->Stringconversions in
 a way that the resultingStringis suitable for indexing and
 sorting. | 
| DecimalField | The  DecimalFieldclass is a utility to convertjava.math.BigDecimalvalues toStringvalues that are lexicographically sortable according to the decimal value. | 
| DefaultHighlighter | This is an adapted version of the  FulltextHighlighterposted in
 issue: LUCENE-644. | 
| DefaultHTMLExcerpt | DefaultHTMLExcerptcreates a HTML excerpt with the following
 format: | 
| DefaultQueryHits | |
| DefaultRedoLogFactory | DefaultRedoLogFactory... | 
| DefaultXMLExcerpt | DefaultXMLExcerptcreates an XML excerpt of a matching node. | 
| DoubleField | The  DoubleFieldclass is a utility to convert double
 values intoStringvalues that are lexicographically ordered
 according to the double value. | 
| DynamicPooledExecutor | DynamicPooledExecutorimplements an executor, which dynamically
 adjusts its maximum number of threads according to the number of available
 processors returned byRuntime.availableProcessors(). | 
| FieldComparatorBase | Abstract base class for  FieldComparatorimplementations
 which are based on values in the form ofComparables. | 
| FieldNames | Defines field names that are used internally to store UUID, etc in the
 search index. | 
| FieldSelectors | FieldSelectorscontains commonly used field selectors. | 
| FileBasedNamespaceMappings | The class  NamespaceMappingsimplements aNamespaceResolverthat holds a namespace
 mapping that is used internally in the search index. | 
| FilterMultiColumnQuery | FilterMultiColumnQuerywraps a multi column query and filters
 out rows that do not satisfy a given constraint. | 
| FilterMultiColumnQueryHits | FilterMultiColumnQueryHitsimplements aMultiColumnQueryHitsfilter that forwards each call to the underlying
 query hits. | 
| IDField | IDFieldimplements a lucene field for the id of a node. | 
| IndexDeletionPolicyImpl | IndexDeletionPolicyImpl... | 
| IndexFormatVersion | This class indicates the lucene index format that is used. | 
| IndexingConfigurationEntityResolver | IndexingConfigurationEntityResolverimplements an entity
 resolver for the indexing configuration DTD. | 
| IndexingConfigurationImpl | IndexingConfigurationImplimplements a concrete indexing
 configuration. | 
| IndexMigration | IndexMigrationimplements a utility that migrates a Jackrabbit
 1.4.x index to version 1.5. | 
| IOCounters | IOCountersprovides a basic mechanism to track I/O during query
 execution. | 
| JackrabbitAnalyzer | This is the global jackrabbit lucene analyzer. | 
| JackrabbitIndexReader | JackrabbitIndexReaderwraps an index reader andreleasesthe underlying reader
 when a client callsIndexReader.close()on this reader. | 
| JackrabbitIndexSearcher | JackrabbitIndexSearcherimplements an index searcher with
 jackrabbit specific optimizations. | 
| JackrabbitQueryParser | JackrabbitQueryParserextends the standard lucene query parser
 and adds JCR specific customizations. | 
| JackrabbitTermQuery | JackrabbitTermQueryimplements aTermQuerywhere score
 values are retrieved on a per index segment basis usingMultiScorer. | 
| JoinQuery | JoinQueryimplements a query that performs a join. | 
| LazyTextExtractorField | LazyTextExtractorFieldimplements a Lucene field with a String
 value that is lazily initialized from a givenReader. | 
| LengthSortComparator | LengthSortComparatorimplements aFieldComparatorwhich
 sorts on the length of property values. | 
| LocalNameQuery | LocalNameQueryimplements a query for the local name of a node. | 
| LocalNameRangeQuery | LocalNameRangeQueryimplements a range query on the local name
 of nodes. | 
| LongField | |
| LowerCaseSortComparator | LowerCaseSortComparatorimplements aFieldComparatorwhich
 compares the lower-cased string values of a base comparator. | 
| LuceneQueryBuilder | Implements a query builder that takes an abstract query tree and creates
 a lucene  Querytree that can be executed
 on an index. | 
| LuceneQueryFactory | Factory that creates Lucene queries from QOM elements. | 
| LuceneQueryFactory.QueryPair | |
| LuceneQueryFactory.Transform | |
| LuceneQueryHits | Wraps a lucene query result and adds a close method that allows to release
 resources after a query has been executed and the results have been read
 completely. | 
| MatchAllDocsQuery | |
| MoreLikeThis | Generate "more like this" similarity queries. | 
| MultiColumnQueryAdapter | MultiColumnQueryAdapteradapts a lucene query to act like aMultiColumnQuery. | 
| MultiColumnQueryResult | MultiColumnQueryResultimplements a query result that executes
 aMultiColumnQuery. | 
| MultiIndex | A  MultiIndexconsists of aVolatileIndexand multiplePersistentIndexes. | 
| MultiIndex.Action | Defines an action on an  MultiIndex. | 
| NamePathResolverImpl | NamePathResolverImpl... | 
| NameQuery | NameQueryimplements a query for the name of a node. | 
| NameRangeQuery | NameRangeQuery... | 
| NodeIndexer | Creates a lucene  Documentobject from aNode. | 
| NodeTraversingQueryHits | NodeTraversingQueryHitsimplements query hits that traverse
 a node hierarchy. | 
| NormalizeSortComparator | NormalizeSortComparatorimplements aFieldComparatorwhich
 compares the lower-cased and normalized string values of a base sort comparator. | 
| NSRegistryBasedNamespaceMappings | NSRegistryBasedNamespaceMappingsimplements a namespace mapping
 based on the stable index prefix provided by the namespace registry. | 
| Ordering | Orderingimplements a single ordering specification. | 
| PredicateDerefQuery | Implements a Lucene  Querywhich returns the nodes which have a 
 reference property which matches the nodes of the subquery. | 
| PropertiesSynonymProvider | Implements a synonym provider based on a properties file. | 
| PropertyMetaData | PropertyMetaDataencapsulates the payload byte array and
 provides methods to access the property meta data. | 
| QueryHitsAdapter | |
| QueryHitsQuery | QueryHitsQueryexposes aQueryHitsimplementation again
 as a Lucene Query. | 
| QueryImpl | Implements the  ExecutableQueryinterface. | 
| QueryResultImpl | Implements the  QueryResultinterface. | 
| RangeQuery | Implements a variant of the lucene class  org.apache.lucene.search.RangeQuery. | 
| RefCountingIndexReader | RefCountingIndexReader... | 
| ScoreNode | ScoreNodeimplements a simple container which holds a mapping
 ofNodeIdto a score value. | 
| ScoreNodeIteratorImpl | |
| SearchIndex | Implements a  QueryHandlerusing
 Lucene. | 
| SearchIndex.CombinedIndexReader | |
| SharedFieldCache | Implements a variant of the lucene class  org.apache.lucene.search.FieldCacheImpl. | 
| SharedFieldCache.ValueIndex | Expert: Stores term text values and document ordering data. | 
| SharedFieldComparatorSource | Implements a  FieldComparatorSourceforFieldComparators which
 know how to sort on a lucene field that contains values for multiple properties. | 
| SimilarityQuery | SimilarityQueryimplements a query that returns similar nodes
 for a given node UUID. | 
| SimpleExcerptProvider | SimpleExcerptProvideris a very simple excerpt provider. | 
| SingleColumnQueryResult | SingleColumnQueryResultimplements a query result that returns
 a single column. | 
| SingletonTokenStream | SingletonTokenStreamimplements a token stream that wraps a
 single value with a given property type. | 
| SortedLuceneQueryHits | Wraps a lucene query result and adds a close method that allows to release
 resources after a query has been executed and the results have been read
 completely. | 
| SortedMultiColumnQueryHits | SortedMultiColumnQueryHitsimplements sorting of query hits
 based onOrderings. | 
| TermDocsCache | TermDocsCacheimplements a cache for frequently readTermDocs. | 
| TermFactory | TermFactoryis a factory forTerminstances with
 frequently used field names. | 
| UpperCaseSortComparator | UpperCaseSortComparatorimplements aFieldComparatorwhich
 compares the upper-cased string values of a base sort comparator. | 
| Util | Utilprovides various static utility methods. | 
| WeightedHighlighter | WeightedHighlighterimplements a highlighter that weights the
 fragments based on the proximity of the highlighted terms to each other. | 
| WeightedHTMLExcerpt | WeightedHTMLExcerptcreates a HTML excerpt with the following
 format: | 
| WeightedXMLExcerpt | WeightedXMLExcerptcreates an XML excerpt of a matching node. | 
| WildcardNameQuery | Implements a wildcard query on the name field. | 
| WildcardQuery | Implements a wildcard query on a lucene field with an embedded property name
 and a pattern. | 
Copyright © 2004–2022 The Apache Software Foundation. All rights reserved.