org.apache.lucene.store

Class RAMDirectory

public final class RAMDirectory extends Directory

A memory-resident {@link Directory} implementation.

Version: $Id: RAMDirectory.java,v 1.15 2004/05/09 12:41:47 ehatcher Exp $

Constructor Summary
	RAMDirectory() Constructs an empty {@link Directory}.
	RAMDirectory(Directory dir) Creates a new `RAMDirectory` instance from a different `Directory` implementation.
	RAMDirectory(File dir) Creates a new `RAMDirectory` instance from the {@link FSDirectory}.
	RAMDirectory(String dir) Creates a new `RAMDirectory` instance from the {@link FSDirectory}.

Method Summary
void	close() Closes the store to future operations.
OutputStream	createFile(String name) Creates a new, empty file in the directory with the given name.
void	deleteFile(String name) Removes an existing file in the directory.
boolean	fileExists(String name) Returns true iff the named file exists in this directory.
long	fileLength(String name) Returns the length in bytes of a file in the directory.
long	fileModified(String name) Returns the time the named file was last modified.
String[]	list() Returns an array of strings, one for each file in the directory.
Lock	makeLock(String name) Construct a {@link Lock}.
InputStream	openFile(String name) Returns a stream reading an existing file.
void	renameFile(String from, String to) Removes an existing file in the directory.
void	touchFile(String name) Set the modified time of an existing file to now.

Constructor Detail

RAMDirectory

public RAMDirectory()

Constructs an empty {@link Directory}.

RAMDirectory

public RAMDirectory(Directory dir)

Creates a new RAMDirectory instance from a different Directory implementation. This can be used to load a disk-based index into memory.

This should be used only with indices that can fit into memory.

Parameters: dir a Directory value

Throws: IOException if an error occurs

RAMDirectory

public RAMDirectory(File dir)

Creates a new RAMDirectory instance from the {@link FSDirectory}.

Parameters: dir a File specifying the index directory

RAMDirectory

public RAMDirectory(String dir)

Creates a new RAMDirectory instance from the {@link FSDirectory}.

Parameters: dir a String specifying the full index directory path

Method Detail

close

public final void close()

Closes the store to future operations.

createFile

public final OutputStream createFile(String name)

Creates a new, empty file in the directory with the given name. Returns a stream writing this file.

deleteFile

public final void deleteFile(String name)

Removes an existing file in the directory.

fileExists

public final boolean fileExists(String name)

Returns true iff the named file exists in this directory.

fileLength

public final long fileLength(String name)

Returns the length in bytes of a file in the directory.

fileModified

public final long fileModified(String name)

Returns the time the named file was last modified.

list

public final String[] list()

Returns an array of strings, one for each file in the directory.

makeLock

public final Lock makeLock(String name)

Construct a {@link Lock}.

Parameters: name the name of the lock file

openFile

public final InputStream openFile(String name)

Returns a stream reading an existing file.

renameFile

public final void renameFile(String from, String to)

Removes an existing file in the directory.

touchFile

public void touchFile(String name)

Set the modified time of an existing file to now.

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.