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 | Protected Member Functions | Properties | List of all members
Lucene.Net.Index.CompoundFileReader Class Reference

Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception. More...

Inherits Directory.

Classes

class  CSIndexInput
 Implementation of an IndexInput that reads from a portion of the compound file. The visibility is left as "package" only because this helps with testing since JUnit test cases in a different class can then access package fields of this class. More...
 

Public Member Functions

 CompoundFileReader (Directory dir, System.String name)
 
 CompoundFileReader (Directory dir, System.String name, int readBufferSize)
 
override IndexInput OpenInput (System.String id)
 
override IndexInput OpenInput (System.String id, int readBufferSize)
 
override System.String[] ListAll ()
 Returns an array of strings, one for each file in the directory.
 
override bool FileExists (System.String name)
 Returns true iff a file with the given name exists.
 
override long FileModified (System.String name)
 Returns the time the compound file was last modified.
 
override void TouchFile (System.String name)
 Set the modified time of the compound file to now.
 
override void DeleteFile (System.String name)
 Not implemented
 
void RenameFile (System.String from, System.String to)
 Not implemented
 
override long FileLength (System.String name)
 Returns the length of a file in the directory.
 
override IndexOutput CreateOutput (System.String name)
 Not implemented
 
override Lock MakeLock (System.String name)
 Not implemented
 

Protected Member Functions

override void Dispose (bool disposing)
 

Properties

virtual Directory Directory [get]
 
virtual string Name [get]
 

Detailed Description

Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception.

Definition at line 34 of file CompoundFileReader.cs.

Constructor & Destructor Documentation

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

Definition at line 55 of file CompoundFileReader.cs.

Lucene.Net.Index.CompoundFileReader.CompoundFileReader ( Directory  dir,
System.String  name,
int  readBufferSize 
)

Definition at line 59 of file CompoundFileReader.cs.

Member Function Documentation

override IndexOutput Lucene.Net.Index.CompoundFileReader.CreateOutput ( System.String  name)

Not implemented

<throws> UnsupportedOperationException </throws>

Definition at line 219 of file CompoundFileReader.cs.

override void Lucene.Net.Index.CompoundFileReader.DeleteFile ( System.String  name)

Not implemented

<throws> UnsupportedOperationException </throws>

Definition at line 195 of file CompoundFileReader.cs.

override void Lucene.Net.Index.CompoundFileReader.Dispose ( bool  disposing)
protected

Definition at line 122 of file CompoundFileReader.cs.

override bool Lucene.Net.Index.CompoundFileReader.FileExists ( System.String  name)

Returns true iff a file with the given name exists.

Definition at line 176 of file CompoundFileReader.cs.

override long Lucene.Net.Index.CompoundFileReader.FileLength ( System.String  name)

Returns the length of a file in the directory.

<throws> IOException if the file does not exist </throws>

Definition at line 209 of file CompoundFileReader.cs.

override long Lucene.Net.Index.CompoundFileReader.FileModified ( System.String  name)

Returns the time the compound file was last modified.

Definition at line 182 of file CompoundFileReader.cs.

override System.String [] Lucene.Net.Index.CompoundFileReader.ListAll ( )

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

Definition at line 170 of file CompoundFileReader.cs.

override Lock Lucene.Net.Index.CompoundFileReader.MakeLock ( System.String  name)

Not implemented

<throws> UnsupportedOperationException </throws>

Definition at line 226 of file CompoundFileReader.cs.

override IndexInput Lucene.Net.Index.CompoundFileReader.OpenInput ( System.String  id)

Definition at line 145 of file CompoundFileReader.cs.

override IndexInput Lucene.Net.Index.CompoundFileReader.OpenInput ( System.String  id,
int  readBufferSize 
)

Definition at line 154 of file CompoundFileReader.cs.

void Lucene.Net.Index.CompoundFileReader.RenameFile ( System.String  from,
System.String  to 
)

Not implemented

<throws> UnsupportedOperationException </throws>

Definition at line 202 of file CompoundFileReader.cs.

override void Lucene.Net.Index.CompoundFileReader.TouchFile ( System.String  name)

Set the modified time of the compound file to now.

Definition at line 188 of file CompoundFileReader.cs.

Property Documentation

virtual Directory Lucene.Net.Index.CompoundFileReader.Directory
get

Definition at line 113 of file CompoundFileReader.cs.

virtual string Lucene.Net.Index.CompoundFileReader.Name
get

Definition at line 118 of file CompoundFileReader.cs.


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