Class Directory
A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.
Java's i/o APIs not used directly, but rather all i/o is through this API. This permits things such as:
Directory locking is implemented by an instance of LockFactory , and can be changed for each Directory instance using SetLockFactory(LockFactory).
Inheritance
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public abstract class Directory : IDisposableFields
| Name | Description |
|---|---|
| interalLockFactory | Holds the LockFactory instance (implements locking for this Directory instance). |
| isOpen |
Properties
| Name | Description |
|---|---|
| isOpen_ForNUnit | |
| LockFactory | Get the LockFactory that this Directory instance is using for its locking implementation. Note that this may be null for Directory implementations that provide their own locking implementation. |
Methods
| Name | Description |
|---|---|
| ClearLock(String) | Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use. |
| Close() | |
| Copy(Directory, Directory, Boolean) | Copy contents of a directory src to a directory dest. If a file in src already exists in dest then the one in dest will be blindly overwritten. NOTE: the source directory cannot change while this method is running. Otherwise the results are undefined and you could easily hit a FileNotFoundException. NOTE: this method only copies files that look like index files (ie, have extensions matching the known extensions of index files). |
| CreateOutput(String) | Creates a new, empty file in the directory with the given name. Returns a stream writing this file. |
| DeleteFile(String) | Removes an existing file in the directory. |
| Dispose() | Closes the store. |
| Dispose(Boolean) | |
| EnsureOpen() | |
| FileExists(String) | Returns true iff a file with the given name exists. |
| FileLength(String) | Returns the length of a file in the directory. |
| FileModified(String) | Returns the time the named file was last modified. |
| GetLockId() | Return a string identifier that uniquely differentiates this Directory instance from other Directory instances. This ID should be the same if two Directory instances (even in different JVMs and/or on different machines) are considered "the same index". This is how locking "scopes" to the right index. |
| ListAll() | Returns an array of strings, one for each file in the directory. |
| MakeLock(String) | Construct a Lock. |
| OpenInput(String) | Returns a stream reading an existing file. |
| OpenInput(String, Int32) | 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 . |
| SetLockFactory(LockFactory) | Set the LockFactory that this Directory instance should use for its locking implementation. Each * instance of LockFactory should only be used for one directory (ie, do not share a single instance across multiple Directories). |
| Sync(String) | Ensure that any writes to this file are moved to stable storage. Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index. |
| ToString() | |
| TouchFile(String) | Set the modified time of an existing file to now. |