org.apache.lucene.store

Class WindowsDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.BaseDirectory

org.apache.lucene.store.FSDirectory

org.apache.lucene.store.WindowsDirectory

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class WindowsDirectory
extends FSDirectory

Native Directory implementation for Microsoft Windows.

Steps:

1. Compile the source code to create WindowsDirectory.dll:

   c:\mingw\bin\g++ -Wall -D_JNI_IMPLEMENTATION_ -Wl,--kill-at -I"%JAVA_HOME%\include" -I"%JAVA_HOME%\include\win32" -static-libgcc -static-libstdc++ -shared WindowsDirectory.cpp -o WindowsDirectory.dll

   For 64-bit JREs, use mingw64, with the -m64 option.
2. Put WindowsDirectory.dll into some directory in your windows PATH
3. Open indexes with WindowsDirectory and use it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	WindowsDirectory.WindowsIndexInput

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

FSDirectory.FSIndexOutput

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_BUFFERSIZE

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

directory

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

isOpen, lockFactory

Constructor Summary

Constructors

Constructor and Description
WindowsDirectory(java.nio.file.Path path) Create a new WindowsDirectory for the named location and FSLockFactory.getDefault().
WindowsDirectory(java.nio.file.Path path, LockFactory lockFactory) Create a new WindowsDirectory for the named location.

Method Summary

Modifier and Type	Method and Description
private static void	close(long fd) Closes a handle to a file
private static long	length(long fd) Returns the length of a file
private static long	open(java.lang.String filename) Opens a handle to a file.
IndexInput	openInput(java.lang.String name, IOContext context) Opens a stream for reading an existing file.
private static int	read(long fd, byte[] bytes, int offset, int length, long pos) Reads data from a file at pos into bytes

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

close, createOutput, createTempOutput, deleteFile, deletePendingFiles, ensureCanRead, fileLength, fsync, getDirectory, getPendingDeletions, listAll, listAll, open, open, rename, sync, syncMetaData, toString

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

ensureOpen, obtainLock

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

copyFrom, getTempFileName, openChecksumInput

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFERSIZE

private static final int DEFAULT_BUFFERSIZE

See Also:

Constant Field Values

Constructor Detail

WindowsDirectory

public WindowsDirectory(java.nio.file.Path path,
                        LockFactory lockFactory)
                 throws java.io.IOException

Create a new WindowsDirectory for the named location.

Parameters:

path - the path of the directory

lockFactory - the lock factory to use

Throws:

java.io.IOException - If there is a low-level I/O error

WindowsDirectory

public WindowsDirectory(java.nio.file.Path path)
                 throws java.io.IOException

Create a new WindowsDirectory for the named location and FSLockFactory.getDefault().

Parameters:

path - the path of the directory

Throws:

java.io.IOException - If there is a low-level I/O error

Method Detail

openInput

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

Description copied from class: Directory

Opens a stream for reading an existing file. This method must throw either NoSuchFileException or FileNotFoundException if name points to a non-existing file.

Specified by:

openInput in class Directory

Parameters:

name - the name of an existing file.

Throws:

java.io.IOException - in case of I/O error

open

private static long open(java.lang.String filename)
                  throws java.io.IOException

Opens a handle to a file.

Throws:

java.io.IOException

read

private static int read(long fd,
                        byte[] bytes,
                        int offset,
                        int length,
                        long pos)
                 throws java.io.IOException

Reads data from a file at pos into bytes

Throws:

java.io.IOException

close

private static void close(long fd)
                   throws java.io.IOException

Closes a handle to a file

Throws:

java.io.IOException

length

private static long length(long fd)
                    throws java.io.IOException

Returns the length of a file

Throws:

java.io.IOException