Package | Description |
---|---|
org.apache.lucene.benchmark.byTask |
Benchmarking Lucene By Tasks.
|
org.apache.lucene.benchmark.byTask.tasks |
Extendable benchmark tasks.
|
org.apache.lucene.facet.index |
Indexing of document categories
|
org.apache.lucene.facet.taxonomy.directory |
Taxonomy implemented using a Lucene-Index
|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.misc |
Miscellaneous index tools.
|
org.apache.lucene.search |
Code to search indices.
|
org.apache.lucene.search.spell |
Suggest alternate spellings for words.
|
org.apache.lucene.store |
Binary i/o API, used for all index data.
|
org.apache.lucene.store.instantiated |
InstantiatedIndex, alternative RAM store for small corpora.
|
org.apache.lucene.util |
Some utility classes.
|
Modifier and Type | Method and Description |
---|---|
Directory |
PerfRunData.getDirectory() |
Directory |
PerfRunData.getTaxonomyDir() |
Modifier and Type | Method and Description |
---|---|
void |
PerfRunData.setDirectory(Directory directory) |
Modifier and Type | Method and Description |
---|---|
static IndexCommit |
OpenReaderTask.findIndexCommit(Directory dir,
String userData) |
Constructor and Description |
---|
FacetsPayloadProcessorProvider(Directory dir,
int[] ordinalMap,
FacetIndexingParams indexingParams)
Construct FacetsPayloadProcessorProvider with FacetIndexingParams
|
Modifier and Type | Method and Description |
---|---|
void |
DirectoryTaxonomyWriter.addTaxonomies(Directory[] taxonomies,
DirectoryTaxonomyWriter.OrdinalMap[] ordinalMaps)
Take all the categories of one or more given taxonomies, and add them to
the main taxonomy (this), if they are not already there.
|
protected IndexReader |
DirectoryTaxonomyReader.openIndexReader(Directory directory) |
protected IndexWriter |
DirectoryTaxonomyWriter.openIndexWriter(Directory directory,
IndexWriterConfig config)
Open internal index writer, which contains the taxonomy data.
|
static void |
DirectoryTaxonomyWriter.unlock(Directory directory)
Forcibly unlocks the taxonomy in the named directory.
|
Constructor and Description |
---|
DirectoryTaxonomyReader(Directory directory)
Open for reading a taxonomy stored in a given
Directory . |
DirectoryTaxonomyWriter(Directory d) |
DirectoryTaxonomyWriter(Directory directory,
IndexWriterConfig.OpenMode openMode)
Creates a new instance with a default cached as defined by
DirectoryTaxonomyWriter.defaultTaxonomyWriterCache() . |
DirectoryTaxonomyWriter(Directory directory,
IndexWriterConfig.OpenMode openMode,
TaxonomyWriterCache cache)
Construct a Taxonomy writer.
|
Modifier and Type | Field and Description |
---|---|
protected Directory |
ThreadedIndexingAndSearchingTestCase.dir |
Directory |
SegmentInfo.dir |
protected Directory |
ConcurrentMergeScheduler.dir |
Directory |
CheckIndex.Status.dir
Directory index is in.
|
Directory |
SegmentWriteState.directory |
Modifier and Type | Method and Description |
---|---|
Directory |
IndexReader.directory()
Returns the directory associated with this index.
|
Directory |
FilterIndexReader.directory() |
Directory |
SegmentReader.directory()
Returns the directory this index resides in.
|
abstract Directory |
IndexCommit.getDirectory()
Returns the
Directory for the index. |
Directory |
MergePolicy.MergeException.getDirectory()
Returns the
Directory of the index that hit
the exception. |
Directory |
IndexWriter.getDirectory()
Returns the Directory used by this index.
|
Directory |
CompoundFileWriter.getDirectory()
Returns the directory of the compound file.
|
Directory |
SnapshotDeletionPolicy.SnapshotCommitPoint.getDirectory() |
protected Directory |
ThreadedIndexingAndSearchingTestCase.getDirectory(Directory in) |
Modifier and Type | Method and Description |
---|---|
void |
CompoundFileWriter.addFile(String file,
Directory dir)
Same as
CompoundFileWriter.addFile(String) , only for files that are found in an
external Directory . |
void |
RandomIndexWriter.addIndexes(Directory... dirs) |
void |
IndexWriter.addIndexes(Directory... dirs)
Adds all segments from an array of indexes into this index.
|
void |
IndexWriter.addIndexesNoOptimize(Directory... dirs)
Deprecated.
use
IndexWriter.addIndexes(Directory...) instead |
Collection<String> |
SegmentInfos.files(Directory dir,
boolean includeSegmentsFile)
Returns all file names referenced by SegmentInfo
instances matching the provided Directory (ie files
associated with any "external" segments are skipped).
|
static SegmentReader |
SegmentReader.get(boolean readOnly,
Directory dir,
SegmentInfo si,
int readBufferSize,
boolean doOpenStores,
int termInfosIndexDivisor) |
static Map<String,String> |
IndexReader.getCommitUserData(Directory directory)
Deprecated.
Call
IndexReader.getIndexCommit() on an open IndexReader, and then call
IndexCommit.getUserData() . |
static long |
IndexReader.getCurrentVersion(Directory directory)
Deprecated.
Use
IndexReader.getVersion() on an opened IndexReader. |
protected Directory |
ThreadedIndexingAndSearchingTestCase.getDirectory(Directory in) |
PayloadProcessorProvider.DirPayloadProcessor |
PayloadProcessorProvider.getDirProcessor(Directory dir)
Deprecated.
Use
PayloadProcessorProvider.getReaderProcessor(org.apache.lucene.index.IndexReader) instead. You can still select by Directory ,
if you retrieve the underlying directory from IndexReader.directory() . |
static long |
SegmentInfos.getLastCommitGeneration(Directory directory)
Get the generation of the most recent commit to the
index in this directory (N in the segments_N file).
|
static String |
SegmentInfos.getLastCommitSegmentsFileName(Directory directory)
Get the filename of the segments_N file for the most
recent commit to the index in this Directory.
|
static boolean |
IndexReader.indexExists(Directory directory)
Returns
true if an index exists at the specified directory. |
static boolean |
IndexWriter.isLocked(Directory directory)
Returns
true iff the index in the named directory is
currently locked. |
static long |
IndexReader.lastModified(Directory directory2)
Deprecated.
If you need to track commit time of
an index, you can store it in the commit data (see
IndexWriter.commit(Map) |
static Collection<IndexCommit> |
IndexReader.listCommits(Directory dir)
Returns all commit points that exist in the Directory.
|
static IndexReader |
IndexReader.open(Directory directory)
Returns a IndexReader reading the index in the given
Directory, with readOnly=true.
|
static IndexReader |
IndexReader.open(Directory directory,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory) instead |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory) instead |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly,
int termInfosIndexDivisor)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory,int) instead |
static IndexReader |
IndexReader.open(Directory directory,
int termInfosIndexDivisor)
Expert: Returns a IndexReader reading the index in the given
Director and given termInfosIndexDivisor
|
void |
SegmentInfos.read(Directory directory)
This version of read uses the retry logic (for lock-less
commits) to find the right segments file to load.
|
void |
SegmentInfos.read(Directory directory,
String segmentFileName)
Read a particular segmentFileName.
|
static long |
SegmentInfos.readCurrentVersion(Directory directory)
Deprecated.
Load the SegmentInfos and then call
SegmentInfos.getVersion() . |
static Map<String,String> |
PersistentSnapshotDeletionPolicy.readSnapshotsInfo(Directory dir)
Reads the snapshots information from the given
Directory . |
String |
MergePolicy.OneMerge.segString(Directory dir) |
String |
MergePolicy.MergeSpecification.segString(Directory dir) |
void |
IndexSorter.sort(Directory input,
Directory output,
String field) |
void |
MultiPassIndexSplitter.split(IndexReader input,
Directory[] outputs,
boolean seq)
Deprecated.
use
MultiPassIndexSplitter.split(Version, IndexReader, Directory[], boolean) instead.
This method will be removed in Lucene 4.0. |
void |
MultiPassIndexSplitter.split(Version version,
IndexReader input,
Directory[] outputs,
boolean seq)
Split source index into multiple parts.
|
String |
SegmentInfos.toString(Directory directory) |
String |
SegmentInfo.toString(Directory dir,
int pendingDelCount)
Used for debugging.
|
static void |
IndexWriter.unlock(Directory directory)
Forcibly unlocks the index in the named directory.
|
void |
FieldInfos.write(Directory d,
String name) |
Constructor and Description |
---|
CheckIndex(Directory dir)
Create a new CheckIndex on the directory.
|
CompoundFileWriter(Directory dir,
String name)
Create the compound stream in the specified file.
|
FieldInfos(Directory d,
String name)
Construct a FieldInfos object using the directory and the name of the file
IndexInput
|
FieldNormModifier(Directory d,
Similarity s)
Deprecated.
Constructor for code that wishes to use this class programmatically
If Similarity is null, kill the field norms.
|
IndexUpgrader(Directory dir,
IndexWriterConfig iwc,
PrintStream infoStream,
boolean deletePriorCommits)
Creates index upgrader on the given directory, using an
IndexWriter using the given
config. |
IndexUpgrader(Directory dir,
Version matchVersion)
Creates index upgrader on the given directory, using an
IndexWriter using the given
matchVersion . |
IndexUpgrader(Directory dir,
Version matchVersion,
PrintStream infoStream,
boolean deletePriorCommits)
Creates index upgrader on the given directory, using an
IndexWriter using the given
matchVersion . |
IndexWriter(Directory d,
Analyzer a,
boolean create,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
IndexWriter(Directory d,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
IndexWriter(Directory d,
Analyzer a,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
IndexWriter(Directory d,
Analyzer a,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl,
IndexCommit commit)
Deprecated.
|
IndexWriter(Directory d,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
IndexWriter(Directory d,
IndexWriterConfig conf)
Constructs a new IndexWriter per the settings given in
conf . |
MergePolicy.MergeException(String message,
Directory dir) |
MergePolicy.MergeException(Throwable exc,
Directory dir) |
PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary,
Directory dir,
IndexWriterConfig.OpenMode mode,
Version matchVersion)
PersistentSnapshotDeletionPolicy wraps another
IndexDeletionPolicy to enable flexible snapshotting. |
PKIndexSplitter(Directory input,
Directory dir1,
Directory dir2,
Filter docsInFirstIndex)
Deprecated.
use
PKIndexSplitter.PKIndexSplitter(Version, Directory, Directory, Directory, Filter) instead.
This constructor will be removed in Lucene 4.0. |
PKIndexSplitter(Directory input,
Directory dir1,
Directory dir2,
Filter docsInFirstIndex,
IndexWriterConfig config1,
IndexWriterConfig config2) |
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,
Filter docsInFirstIndex)
Split an index based on a
Filter . |
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.
|
RandomIndexWriter(Random r,
Directory dir)
create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT and Whitespace+LowercasingAnalyzer
|
RandomIndexWriter(Random r,
Directory dir,
Analyzer a)
create a RandomIndexWriter with a random config: Uses TEST_VERSION_CURRENT
|
RandomIndexWriter(Random r,
Directory dir,
IndexWriterConfig c)
create a RandomIndexWriter with the provided config
|
RandomIndexWriter(Random r,
Directory dir,
Version v,
Analyzer a)
create a RandomIndexWriter with a random config
|
SegmentInfo(String name,
int docCount,
Directory dir,
boolean isCompoundFile,
boolean hasSingleNormFile,
boolean hasProx,
boolean hasVectors) |
SegmentInfos.FindSegmentsFile(Directory directory) |
SegmentWriteState(PrintStream infoStream,
Directory directory,
String segmentName,
FieldInfos fieldInfos,
int numDocs,
int termIndexInterval,
org.apache.lucene.index.BufferedDeletes segDeletes) |
Modifier and Type | Method and Description |
---|---|
static void |
GetTermInfo.getTermInfo(Directory dir,
Term term) |
Modifier and Type | Field and Description |
---|---|
protected static Directory |
SearchEquivalenceTestBase.directory |
Modifier and Type | Method and Description |
---|---|
long |
NRTManager.TrackingIndexWriter.addIndexes(Directory... dirs) |
Constructor and Description |
---|
IndexSearcher(Directory path)
Deprecated.
use
IndexSearcher.IndexSearcher(IndexReader) instead. |
IndexSearcher(Directory path,
boolean readOnly)
Deprecated.
Use
IndexSearcher.IndexSearcher(IndexReader) instead. |
SearcherManager(Directory dir,
SearcherFactory searcherFactory)
Creates and returns a new SearcherManager from the given
Directory . |
Modifier and Type | Method and Description |
---|---|
void |
SpellChecker.setSpellIndex(Directory spellIndexDir)
Use a different index as the spell checker index or re-open
the existing index if
spellIndex is the same value
as given in the constructor. |
Constructor and Description |
---|
SpellChecker(Directory spellIndex)
Use the given directory as a spell checker index with a
LevensteinDistance as the default StringDistance . |
SpellChecker(Directory spellIndex,
StringDistance sd)
Use the given directory as a spell checker index.
|
SpellChecker(Directory spellIndex,
StringDistance sd,
Comparator<SuggestWord> comparator)
Use the given directory as a spell checker index with the given
StringDistance measure
and the given Comparator for sorting the results. |
Modifier and Type | Class and Description |
---|---|
class |
DirectIOLinuxDirectory
An
Directory implementation that uses the
Linux-specific O_DIRECT flag to bypass all OS level
caching. |
class |
FileSwitchDirectory
Expert: A Directory instance that switches files between
two other Directory instances.
|
class |
FSDirectory
|
class |
MMapDirectory
File-based
Directory implementation that uses
mmap for reading, and FSDirectory.FSIndexOutput for writing. |
class |
MockDirectoryWrapper
This is a Directory Wrapper that adds methods
intended to be used only by unit tests.
|
class |
NIOFSDirectory
An
FSDirectory implementation that uses java.nio's FileChannel's
positional read, which allows multiple threads to read from the same file
without synchronizing. |
class |
NRTCachingDirectory
Wraps a
RAMDirectory
around any provided delegate directory, to
be used during NRT search. |
class |
RAMDirectory
A memory-resident
Directory implementation. |
class |
SimpleFSDirectory
A straightforward implementation of
FSDirectory
using java.io.RandomAccessFile. |
class |
WindowsDirectory
Native
Directory implementation for Microsoft Windows. |
Modifier and Type | Method and Description |
---|---|
Directory |
FileSwitchDirectory.getPrimaryDir()
Return the primary directory
|
Directory |
FileSwitchDirectory.getSecondaryDir()
Return the secondary directory
|
Modifier and Type | Method and Description |
---|---|
static void |
Directory.copy(Directory src,
Directory dest,
boolean closeDirSrc)
Deprecated.
should be replaced with calls to
copy(Directory, String, String) for every file that
needs copying. You can use the following code:
IndexFileNameFilter filter = IndexFileNameFilter.getFilter(); for (String file : src.listAll()) { if (filter.accept(null, file)) { src.copy(dest, file, file); } } |
void |
MockDirectoryWrapper.copy(Directory to,
String src,
String dest) |
void |
Directory.copy(Directory to,
String src,
String dest)
Copies the file src to
Directory to under the new
file name dest. |
Constructor and Description |
---|
FileSwitchDirectory(Set<String> primaryExtensions,
Directory primaryDir,
Directory secondaryDir,
boolean doClose) |
MockDirectoryWrapper(Random random,
Directory delegate) |
NRTCachingDirectory(Directory delegate,
double maxMergeSizeMB,
double maxCachedMB)
We will cache a newly created output if 1) it's a
flush or a merge and the estimated size of the merged segment is <=
maxMergeSizeMB, and 2) the total cached bytes is <=
maxCachedMB
|
RAMDirectory(Directory dir)
Creates a new
RAMDirectory instance from a different
Directory implementation. |
Modifier and Type | Method and Description |
---|---|
Directory |
InstantiatedIndexReader.directory()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Class<? extends Directory> |
CommandLineUtil.loadDirectoryClass(String clazzName)
Loads a specific Directory implementation
|
Modifier and Type | Method and Description |
---|---|
static boolean |
_TestUtil.anyFilesExceptWriteLock(Directory dir) |
static CheckIndex.Status |
_TestUtil.checkIndex(Directory dir)
This runs the CheckIndex tool on the index in.
|
static MockDirectoryWrapper |
LuceneTestCase.newDirectory(Directory d)
Returns a new Directory instance, with contents copied from the
provided directory.
|
static MockDirectoryWrapper |
LuceneTestCase.newDirectory(Random r,
Directory d)
Returns a new Directory instance, using the specified random
with contents copied from the provided directory.
|
void |
BitVector.write(Directory d,
String name)
Writes this vector to the file
name in Directory
d , in a format that can be read by the constructor BitVector.BitVector(Directory, String) . |
Constructor and Description |
---|
BitVector(Directory d,
String name)
Constructs a bit vector from the file
name in Directory
d , as written by the BitVector.write(org.apache.lucene.store.Directory, java.lang.String) method. |