org.apache.lucene.store

Class MMapDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.FSDirectory

org.apache.lucene.store.MMapDirectory

public class MMapDirectory
extends FSDirectory

File-based Directory implementation that uses mmap for input.

To use this, invoke Java with the System property org.apache.lucene.FSDirectory.class set to org.apache.lucene.store.MMapDirectory. This will cause FSDirectory.getDirectory(File,boolean) to return instances of this class.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.store.FSDirectory

FSDirectory.FSIndexInput, FSDirectory.FSIndexOutput

Field Summary

Fields inherited from class org.apache.lucene.store.FSDirectory

LOCK_DIR

Fields inherited from class org.apache.lucene.store.Directory

lockFactory

Constructor Summary

Constructors

Constructor and Description
MMapDirectory()

Method Summary

Methods

Modifier and Type	Method and Description
IndexInput	openInput(java.lang.String name) Returns a stream reading an existing file.
IndexInput	openInput(java.lang.String name, int bufferSize) Returns a stream reading an existing file, with the specified read buffer size.

Methods inherited from class org.apache.lucene.store.FSDirectory

close, createOutput, deleteFile, fileExists, fileLength, fileModified, fileModified, getDirectory, getDirectory, getDirectory, getDirectory, getDirectory, getDirectory, getDisableLocks, getFile, getLockID, list, renameFile, setDisableLocks, sync, toString, touchFile

Methods inherited from class org.apache.lucene.store.Directory

clearLock, copy, ensureOpen, getLockFactory, makeLock, setLockFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MMapDirectory

public MMapDirectory()

Method Detail

openInput

public IndexInput openInput(java.lang.String name)
                     throws java.io.IOException

Description copied from class: Directory

Returns a stream reading an existing file.

Overrides:

openInput in class FSDirectory

Throws:

java.io.IOException

openInput

public IndexInput openInput(java.lang.String name,
                   int bufferSize)
                     throws java.io.IOException

Description copied from class: Directory

Returns a stream reading an existing file, with the specified read buffer size. The particular Directory implementation may ignore the buffer size. Currently the only Directory implementations that respect this parameter are FSDirectory and CompoundFileReader.

Overrides:

openInput in class FSDirectory

Throws:

java.io.IOException