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

Information about a segment such as it's name, directory, and files related to the segment. More...

Inherits ICloneable.

Public Member Functions

override System.String ToString ()
 
 SegmentInfo (System.String name, int docCount, Directory dir)
 
 SegmentInfo (System.String name, int docCount, Directory dir, bool isCompoundFile, bool hasSingleNormFile)
 
 SegmentInfo (System.String name, int docCount, Directory dir, bool isCompoundFile, bool hasSingleNormFile, int docStoreOffset, System.String docStoreSegment, bool docStoreIsCompoundFile, bool hasProx)
 
long SizeInBytes ()
 Returns total size in bytes of all of files used by this segment.
 
bool HasDeletions ()
 
System.Object Clone ()
 
System.String GetDelFileName ()
 
bool HasSeparateNorms (int fieldNumber)
 Returns true if this field for this segment has saved a separate norms file (_<segment>_N.sX).
 
bool HasSeparateNorms ()
 Returns true if any fields in this segment have separate norms.
 
System.String GetNormFileName (int number)
 Get the file name for the norms file for this field.
 
bool GetUseCompoundFile ()
 Returns true if this segment is stored as a compound file; else, false.
 
int GetDelCount ()
 
IList< string > Files ()
 
System.String SegString (Directory dir)
 Used for debugging
 
override bool Equals (System.Object obj)
 We consider another SegmentInfo instance equal if it has the same dir and same name.
 
override int GetHashCode ()
 

Public Attributes

System.String name
 
int docCount
 
Directory dir
 

Properties

IDictionary< string, string > Diagnostics [get, set]
 
int DocStoreOffset [get, set]
 
bool DocStoreIsCompoundFile [get, set]
 
string DocStoreSegment [get]
 
bool HasProx [get, set]
 

Detailed Description

Information about a segment such as it's name, directory, and files related to the segment.

NOTE: This API is new and still experimental (subject to change suddenly in the next release)

Definition at line 35 of file SegmentInfo.cs.

Constructor & Destructor Documentation

Lucene.Net.Index.SegmentInfo.SegmentInfo ( System.String  name,
int  docCount,
Directory  dir 
)

Definition at line 97 of file SegmentInfo.cs.

Lucene.Net.Index.SegmentInfo.SegmentInfo ( System.String  name,
int  docCount,
Directory  dir,
bool  isCompoundFile,
bool  hasSingleNormFile 
)

Definition at line 113 of file SegmentInfo.cs.

Lucene.Net.Index.SegmentInfo.SegmentInfo ( System.String  name,
int  docCount,
Directory  dir,
bool  isCompoundFile,
bool  hasSingleNormFile,
int  docStoreOffset,
System.String  docStoreSegment,
bool  docStoreIsCompoundFile,
bool  hasProx 
)

Definition at line 117 of file SegmentInfo.cs.

Member Function Documentation

System.Object Lucene.Net.Index.SegmentInfo.Clone ( )

Definition at line 357 of file SegmentInfo.cs.

override bool Lucene.Net.Index.SegmentInfo.Equals ( System.Object  obj)

We consider another SegmentInfo instance equal if it has the same dir and same name.

Definition at line 858 of file SegmentInfo.cs.

IList<string> Lucene.Net.Index.SegmentInfo.Files ( )

Definition at line 697 of file SegmentInfo.cs.

int Lucene.Net.Index.SegmentInfo.GetDelCount ( )

Definition at line 589 of file SegmentInfo.cs.

System.String Lucene.Net.Index.SegmentInfo.GetDelFileName ( )

Definition at line 396 of file SegmentInfo.cs.

override int Lucene.Net.Index.SegmentInfo.GetHashCode ( )

Definition at line 870 of file SegmentInfo.cs.

System.String Lucene.Net.Index.SegmentInfo.GetNormFileName ( int  number)

Get the file name for the norms file for this field.

Parameters
numberfield index

Definition at line 522 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.GetUseCompoundFile ( )

Returns true if this segment is stored as a compound file; else, false.

Definition at line 575 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.HasDeletions ( )

Definition at line 307 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.HasSeparateNorms ( int  fieldNumber)

Returns true if this field for this segment has saved a separate norms file (_<segment>_N.sX).

Parameters
fieldNumberthe field index to check

Definition at line 416 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.HasSeparateNorms ( )

Returns true if any fields in this segment have separate norms.

Definition at line 435 of file SegmentInfo.cs.

System.String Lucene.Net.Index.SegmentInfo.SegString ( Directory  dir)

Used for debugging

Definition at line 830 of file SegmentInfo.cs.

long Lucene.Net.Index.SegmentInfo.SizeInBytes ( )

Returns total size in bytes of all of files used by this segment.

Definition at line 288 of file SegmentInfo.cs.

override System.String Lucene.Net.Index.SegmentInfo.ToString ( )

Definition at line 92 of file SegmentInfo.cs.

Member Data Documentation

Directory Lucene.Net.Index.SegmentInfo.dir

Definition at line 45 of file SegmentInfo.cs.

int Lucene.Net.Index.SegmentInfo.docCount

Definition at line 44 of file SegmentInfo.cs.

System.String Lucene.Net.Index.SegmentInfo.name

Definition at line 43 of file SegmentInfo.cs.

Property Documentation

IDictionary<string, string> Lucene.Net.Index.SegmentInfo.Diagnostics
getset

Definition at line 156 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.DocStoreIsCompoundFile
getset

Definition at line 622 of file SegmentInfo.cs.

int Lucene.Net.Index.SegmentInfo.DocStoreOffset
getset

Definition at line 612 of file SegmentInfo.cs.

string Lucene.Net.Index.SegmentInfo.DocStoreSegment
get

Definition at line 632 of file SegmentInfo.cs.

bool Lucene.Net.Index.SegmentInfo.HasProx
getset

Definition at line 676 of file SegmentInfo.cs.


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