Home » lucene-2.3.2-src » org.apache » lucene » index »

org.apache.lucene.index

Sub Packages:

org.apache.lucene.index.memory   High-performance single-document main memory Apache Lucene fulltext search index.  
org.apache.lucene.index.store    

Interfaces:

IndexCommitPoint  

Expert: represents a single commit into an index as seen by the IndexDeletionPolicy

code | html
IndexDeletionPolicy  

Expert: policy for deletion of stale index commits

code | html
TermDocs   TermDocs provides an interface for enumerating <document, frequency> pairs for a term.  code | html
TermFreqVector   Provides access to stored term vector of a document field.  code | html
TermPositionVector   Extends TermFreqVector to provide additional information about positions in which each of the terms is found.  code | html
TermPositions   TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.  code | html

Abstract Classes:

DirectoryIndexReader   IndexReader implementation that has access to a Directory.  code | html
IndexReader   IndexReader is an abstract class, providing an interface for accessing an index.  code | html
LogMergePolicy  

This class implements a MergePolicy that tries to merge segments into levels of exponentially increasing size, where each level has < mergeFactor segments in it. 

code | html
MergePolicy  

Expert: a MergePolicy determines the sequence of primitive merge operations to be used for overall merge and optimize operations.

Whenever the segments in an index have been altered by IndexWriter , either the addition of a newly flushed segment, addition of many segments from addIndexes* calls, or a previous merge that may now need to cascade, IndexWriter invokes #findMerges to give the MergePolicy a chance to pick merges that are now required. 

code | html
MergeScheduler   Expert: IndexWriter uses an instance implementing this interface to execute the merges selected by a MergePolicy code | html
MultiLevelSkipListReader   This abstract class reads skip lists with multiple levels.  code | html
MultiLevelSkipListWriter   This abstract class writes skip lists with multiple levels.  code | html
SegmentInfos.FindSegmentsFile   Utility class for executing code that needs to do something with the current segments file.  code | html
TermEnum   Abstract class for enumerating terms.  code | html
TermVectorMapper   The TermVectorMapper can be used to map Term Vectors into your own structure instead of the parallel array structure used by org.apache.lucene.index.IndexReader#getTermFreqVector(int,String) code | html

Classes:

AbortException     code | html
CheckIndex   Basic tool to check the health of an index and write a new segments file that removes reference to problematic segments.  code | html
CheckIndex.MySegmentTermDocs     code | html
CompoundFileReader   Class for accessing a compound stream.  code | html
CompoundFileReader.CSIndexInput   Implementation of an IndexInput that reads from a portion of the compound file.  code | html
CompoundFileReader.FileEntry     code | html
CompoundFileWriter   Combines multiple files into a single compound file.  code | html
CompoundFileWriter.FileEntry     code | html
ConcurrentMergeScheduler   A MergeScheduler that runs each merge using a separate thread, up until a maximum number of threads (#setMaxThreadCount ) at which points merges are run in the foreground, serially.  code | html
ConcurrentMergeScheduler.MergeThread     code | html
CorruptIndexException   This exception is thrown when Lucene detects an inconsistency in the index.  code | html
DefaultSkipListReader   Implements the skip list reader for the default posting list format that stores positions and payloads.  code | html
DefaultSkipListWriter   Implements the skip list writer for the default posting list format that stores positions and payloads.  code | html
DocHelper     code | html
DocTest   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
DocumentWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
DocumentsWriter   This class accepts multiple added documents and directly writes a single segment file.  code | html
DocumentsWriter.BufferedNorms     code | html
DocumentsWriter.ByteBlockPool     code | html
DocumentsWriter.ByteSliceReader     code | html
DocumentsWriter.CharBlockPool     code | html
DocumentsWriter.FieldMergeState   Used to merge the postings from multiple ThreadStates when creating a segment  code | html
DocumentsWriter.Num     code | html
DocumentsWriter.Posting     code | html
DocumentsWriter.PostingVector     code | html
DocumentsWriter.ReusableStringReader     code | html
DocumentsWriter.ThreadState   Per-thread state.  code | html
DocumentsWriter.ThreadState.FieldData   Holds data associated with a single field, including the Postings hash.  code | html
FieldInfo   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
FieldInfos   Access to the Fieldable Info file that describes document fields and whether or not they are indexed.  code | html
FieldNormModifier   Given a directory and a list of fields, updates the fieldNorms in place for every document.  code | html
FieldReaderException     code | html
FieldSortedTermVectorMapper   For each Field, store a sorted collection of TermVectorEntry s

This is not thread-safe. 

code | html
FieldsReader   Class responsible for access to stored document fields.  code | html
FieldsReader.FieldForMerge     code | html
FieldsReader.LazyField   A Lazy implementation of Fieldable that differs loading of fields until asked for, instead of when the Document is loaded.  code | html
FieldsWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
FilterIndexReader   A FilterIndexReader contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.  code | html
FilterIndexReader.FilterTermDocs   Base class for filtering TermDocs implementations.  code | html
FilterIndexReader.FilterTermEnum   Base class for filtering TermEnum implementations.  code | html
FilterIndexReader.FilterTermPositions   Base class for filtering TermPositions implementations.  code | html
GCJSegmentReader   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
GCJTermDocs   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
IndexFileDeleter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
IndexFileDeleter.CommitPoint   Holds details for each commit point.  code | html
IndexFileDeleter.RefCount   Tracks the reference count for a single index file:  code | html
IndexFileNameFilter   Filename filter that accept filenames and extensions only created by Lucene.  code | html
IndexFileNames   Useful constants representing filenames and extensions used by lucene  code | html
IndexModifier  

[Note that as of 2.1, all but one of the methods in this class are available via IndexWriter

code | html
IndexReader.FieldOption   Constants describing field properties, for example used for IndexReader#getFieldNames(FieldOption) code | html
IndexWriter   An IndexWriter creates and maintains an index.  code | html
KeepOnlyLastCommitDeletionPolicy   This IndexDeletionPolicy implementation that keeps only the most recent commit and immediately removes all prior commits after a new commit is done.  code | html
LogByteSizeMergePolicy   This is a LogMergePolicy that measures size of a segment as the total byte size of the segment's files.  code | html
LogDocMergePolicy   This is a LogMergePolicy that measures size of a segment as the number of documents (not taking deletions into account).  code | html
MergePolicy.MergeAbortedException     code | html
MergePolicy.MergeException   Exception thrown if there are any problems while executing a merge.  code | html
MergePolicy.MergeSpecification   A MergeSpecification instance provides the information necessary to perform multiple merges.  code | html
MergePolicy.OneMerge   OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment.  code | html
MockInputStream   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
MultiLevelSkipListReader.SkipBuffer   used to buffer the top skip levels  code | html
MultiReader   An IndexReader which reads multiple indexes, appending their content.  code | html
MultiSegmentReader   An IndexReader which reads indexes with multiple segments.  code | html
MultiSegmentReader.MultiTermDocs     code | html
MultiSegmentReader.MultiTermEnum     code | html
MultiSegmentReader.MultiTermPositions     code | html
MultipleTermPositions   Describe class MultipleTermPositions here.  code | html
MultipleTermPositions.IntQueue     code | html
MultipleTermPositions.TermPositionsQueue     code | html
ParallelArrayTermVectorMapper   Models the existing parallel array structure  code | html
ParallelReader   An IndexReader which reads multiple, parallel indexes.  code | html
ParallelReader.ParallelTermDocs     code | html
ParallelReader.ParallelTermEnum     code | html
ParallelReader.ParallelTermPositions     code | html
Payload   A Payload is metadata that can be stored together with each occurrence of a term.  code | html
PositionBasedTermVectorMapper   For each Field, store position by position information.  code | html
PositionBasedTermVectorMapper.TVPositionInfo   Container for a term at a position  code | html
Posting     code | html
SegmentInfo   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentInfos   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentMergeInfo   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentMergeQueue   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentMerger   The SegmentMerger class combines two or more Segments, represented by an IndexReader (#add , into a single Segment.  code | html
SegmentMerger.CheckAbort     code | html
SegmentReader     code | html
SegmentReader.Norm     code | html
SegmentTermDocs   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermEnum   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermPositionVector   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermPositions   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
SegmentTermVector     code | html
SerialMergeScheduler   A MergeScheduler that simply does each merge sequentially, using the current thread.  code | html
SnapshotDeletionPolicy   A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold and later release a single "snapshot" of an index.  code | html
SnapshotDeletionPolicy.MyCommitPoint     code | html
SortedTermVectorMapper   Store a sorted collection of org.apache.lucene.index.TermVectorEntry s.  code | html
StaleReaderException   This exception is thrown when an IndexReader tries to make changes to the index (via IndexReader#deleteDocument , IndexReader#undeleteAll or IndexReader#setNorm ) but changes have already been committed to the index since this reader was instantiated.  code | html
Term   A Term represents a word from text.  code | html
TermBuffer   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TermInfo   A TermInfo is the record of information stored for a term.  code | html
TermInfosReader   This stores a monotonically increasing set of pairs in a Directory.  code | html
TermInfosTest   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TermInfosWriter   This stores a monotonically increasing set of pairs in a Directory.  code | html
TermVectorEntry   Convenience class for holding TermVector information.  code | html
TermVectorEntryFreqSortedComparator   Compares org.apache.lucene.index.TermVectorEntry s first by frequency and then by the term (case-sensitive)  code | html
TermVectorOffsetInfo   The TermVectorOffsetInfo class holds information pertaining to a Term in a org.apache.lucene.index.TermPositionVector 's offset information.  code | html
TermVectorsReader     code | html
TermVectorsWriter   Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  code | html
TestFilterIndexReader.TestReader     code | html
TestFilterIndexReader.TestReader.TestTermEnum   Filter that only permits terms containing 'e'.  code | html
TestFilterIndexReader.TestReader.TestTermPositions   Filter that only returns odd numbered documents.  code | html

All Test Cases:

TestCompoundFile     code | html
TestDoc   JUnit adaptation of an older test case DocTest.  code | html
TestDocumentWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestFieldInfos     code | html
TestFieldsReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestFilterIndexReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestIndexReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestIndexWriter     code | html
TestInputStream   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestMultiReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentMerger   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentReader   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentTermDocs   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html
TestSegmentTermEnum     code | html
TestTermVectorsReader     code | html
TestTermVectorsWriter   Copyright 2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.  code | html