Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | Properties | List of all members
Lucene.Net.Index.CompoundFileWriter Class Reference

Combines multiple files into a single compound file. The file format:

More...

Inherits IDisposable.

Public Member Functions

 CompoundFileWriter (Directory dir, System.String name)
 Create the compound stream in the specified file. The file name is the entire name (no extensions are added).
 
void AddFile (String file)
 Add a source stream. file is the string by which the sub-stream will be known in the compound stream.
 
void Close ()
 
void Dispose ()
 Merge files with the extensions added up to now. All files with these extensions are combined sequentially into the compound stream. After successful merge, the source files are deleted.
 

Properties

Directory Directory [get]
 Returns the directory of the compound file.
 
string Name [get]
 Returns the name of the compound file.
 

Detailed Description

Combines multiple files into a single compound file. The file format:

The fileCount integer indicates how many files are contained in this compound file. The {directory} that follows has that many entries. Each directory entry contains a long pointer to the start of this file's data section, and a String with that file's name.

Definition at line 47 of file CompoundFileWriter.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.CompoundFileWriter.CompoundFileWriter ( Directory  dir,
System.String  name 
)

Create the compound stream in the specified file. The file name is the entire name (no extensions are added).

<throws> NullPointerException if dir or name is null </throws>

Definition at line 74 of file CompoundFileWriter.cs.

Member Function Documentation

void Lucene.Net.Index.CompoundFileWriter.AddFile ( String  file)

Add a source stream. file is the string by which the sub-stream will be known in the compound stream.

<throws> IllegalStateException if this writer is closed </throws> <throws> NullPointerException if file is null </throws> <throws> IllegalArgumentException if a file with the same name </throws>

has been added already

Definition at line 112 of file CompoundFileWriter.cs.

void Lucene.Net.Index.CompoundFileWriter.Close ( )

Definition at line 134 of file CompoundFileWriter.cs.

void Lucene.Net.Index.CompoundFileWriter.Dispose ( )

Merge files with the extensions added up to now. All files with these extensions are combined sequentially into the compound stream. After successful merge, the source files are deleted.

<throws> IllegalStateException if close() had been called before or </throws>

if no file has been added to this object

Definition at line 147 of file CompoundFileWriter.cs.

Property Documentation

Directory Lucene.Net.Index.CompoundFileWriter.Directory
get

Returns the directory of the compound file.

Definition at line 93 of file CompoundFileWriter.cs.

string Lucene.Net.Index.CompoundFileWriter.Name
get

Returns the name of the compound file.

Definition at line 99 of file CompoundFileWriter.cs.


The documentation for this class was generated from the following file: