Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Lucene.Net.Index.IndexFileNames Class Reference

Useful constants representing filenames and extensions used by lucene More...

Static Public Member Functions

static System.String FileNameFromGeneration (System.String base_Renamed, System.String extension, long gen)
 Computes the full file name from base, extension and generation. If the generation is -1, the file name is null. If it's 0, the file name is If it's > 0, the file name is
 

Public Attributes

const System.String SEGMENTS = "segments"
 Name of the index segment file
 
const System.String SEGMENTS_GEN = "segments.gen"
 Name of the generation reference file name
 
const System.String DELETABLE = "deletable"
 Name of the index deletable file (only used in pre-lockless indices)
 
const System.String NORMS_EXTENSION = "nrm"
 Extension of norms file
 
const System.String FREQ_EXTENSION = "frq"
 Extension of freq postings file
 
const System.String PROX_EXTENSION = "prx"
 Extension of prox postings file
 
const System.String TERMS_EXTENSION = "tis"
 Extension of terms file
 
const System.String TERMS_INDEX_EXTENSION = "tii"
 Extension of terms index file
 
const System.String FIELDS_INDEX_EXTENSION = "fdx"
 Extension of stored fields index file
 
const System.String FIELDS_EXTENSION = "fdt"
 Extension of stored fields file
 
const System.String VECTORS_FIELDS_EXTENSION = "tvf"
 Extension of vectors fields file
 
const System.String VECTORS_DOCUMENTS_EXTENSION = "tvd"
 Extension of vectors documents file
 
const System.String VECTORS_INDEX_EXTENSION = "tvx"
 Extension of vectors index file
 
const System.String COMPOUND_FILE_EXTENSION = "cfs"
 Extension of compound file
 
const System.String COMPOUND_FILE_STORE_EXTENSION = "cfx"
 Extension of compound file for doc store files
 
const System.String FIELD_INFOS_EXTENSION = "fnm"
 Extension of field infos
 
const System.String PLAIN_NORMS_EXTENSION = "f"
 Extension of plain norms
 
const System.String SEPARATE_NORMS_EXTENSION = "s"
 Extension of separate norms
 
const System.String GEN_EXTENSION = "gen"
 Extension of gen file
 

Static Public Attributes

static readonly System.String[] INDEX_EXTENSIONS = new System.String[]{COMPOUND_FILE_EXTENSION, FIELD_INFOS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, DELETES_EXTENSION, VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION, GEN_EXTENSION, NORMS_EXTENSION, COMPOUND_FILE_STORE_EXTENSION}
 This array contains all filename extensions used by Lucene's index files, with two exceptions, namely the extension made up from .f + a number and from .s + a number. Also note that Lucene's segments_N files do not have any filename extension.
 
static readonly System.String[] INDEX_EXTENSIONS_IN_COMPOUND_FILE = new System.String[]{FIELD_INFOS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION, NORMS_EXTENSION}
 File extensions that are added to a compound file (same as above, minus "del", "gen", "cfs").
 
static readonly System.String[] STORE_INDEX_EXTENSIONS = new System.String[]{VECTORS_INDEX_EXTENSION, VECTORS_FIELDS_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION}
 
static readonly System.String[] NON_STORE_INDEX_EXTENSIONS = new System.String[]{FIELD_INFOS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, TERMS_EXTENSION, TERMS_INDEX_EXTENSION, NORMS_EXTENSION}
 
static readonly System.String[] COMPOUND_EXTENSIONS = new System.String[]{FIELD_INFOS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION}
 File extensions of old-style index files
 
static readonly System.String[] VECTOR_EXTENSIONS = new System.String[]{VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION}
 File extensions for term vector support
 

Detailed Description

Useful constants representing filenames and extensions used by lucene

Definition at line 25 of file IndexFileNames.cs.

Member Function Documentation

static System.String Lucene.Net.Index.IndexFileNames.FileNameFromGeneration ( System.String  base_Renamed,
System.String  extension,
long  gen 
)
static

Computes the full file name from base, extension and generation. If the generation is -1, the file name is null. If it's 0, the file name is If it's > 0, the file name is

Parameters
base_Renamed– main part of the file name
extension– extension of the filename (including .)
gen– generation

Definition at line 126 of file IndexFileNames.cs.

Member Data Documentation

readonly System.String [] Lucene.Net.Index.IndexFileNames.COMPOUND_EXTENSIONS = new System.String[]{FIELD_INFOS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION}
static

File extensions of old-style index files

Definition at line 109 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.COMPOUND_FILE_EXTENSION = "cfs"

Extension of compound file

Definition at line 70 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.COMPOUND_FILE_STORE_EXTENSION = "cfx"

Extension of compound file for doc store files

Definition at line 73 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.DELETABLE = "deletable"

Name of the index deletable file (only used in pre-lockless indices)

Definition at line 37 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.FIELD_INFOS_EXTENSION = "fnm"

Extension of field infos

Definition at line 79 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.FIELDS_EXTENSION = "fdt"

Extension of stored fields file

Definition at line 58 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.FIELDS_INDEX_EXTENSION = "fdx"

Extension of stored fields index file

Definition at line 55 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.FREQ_EXTENSION = "frq"

Extension of freq postings file

Definition at line 43 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.GEN_EXTENSION = "gen"

Extension of gen file

Definition at line 88 of file IndexFileNames.cs.

This array contains all filename extensions used by Lucene's index files, with two exceptions, namely the extension made up from .f + a number and from .s + a number. Also note that Lucene's segments_N files do not have any filename extension.

Definition at line 97 of file IndexFileNames.cs.

readonly System.String [] Lucene.Net.Index.IndexFileNames.INDEX_EXTENSIONS_IN_COMPOUND_FILE = new System.String[]{FIELD_INFOS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION, NORMS_EXTENSION}
static

File extensions that are added to a compound file (same as above, minus "del", "gen", "cfs").

Definition at line 102 of file IndexFileNames.cs.

readonly System.String [] Lucene.Net.Index.IndexFileNames.NON_STORE_INDEX_EXTENSIONS = new System.String[]{FIELD_INFOS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, TERMS_EXTENSION, TERMS_INDEX_EXTENSION, NORMS_EXTENSION}
static

Definition at line 106 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.NORMS_EXTENSION = "nrm"

Extension of norms file

Definition at line 40 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.PLAIN_NORMS_EXTENSION = "f"

Extension of plain norms

Definition at line 82 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.PROX_EXTENSION = "prx"

Extension of prox postings file

Definition at line 46 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.SEGMENTS = "segments"

Name of the index segment file

Definition at line 29 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.SEGMENTS_GEN = "segments.gen"

Name of the generation reference file name

Definition at line 32 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.SEPARATE_NORMS_EXTENSION = "s"

Extension of separate norms

Definition at line 85 of file IndexFileNames.cs.

readonly System.String [] Lucene.Net.Index.IndexFileNames.STORE_INDEX_EXTENSIONS = new System.String[]{VECTORS_INDEX_EXTENSION, VECTORS_FIELDS_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION}
static

Definition at line 104 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.TERMS_EXTENSION = "tis"

Extension of terms file

Definition at line 49 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.TERMS_INDEX_EXTENSION = "tii"

Extension of terms index file

Definition at line 52 of file IndexFileNames.cs.

readonly System.String [] Lucene.Net.Index.IndexFileNames.VECTOR_EXTENSIONS = new System.String[]{VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION}
static

File extensions for term vector support

Definition at line 112 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.VECTORS_DOCUMENTS_EXTENSION = "tvd"

Extension of vectors documents file

Definition at line 64 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.VECTORS_FIELDS_EXTENSION = "tvf"

Extension of vectors fields file

Definition at line 61 of file IndexFileNames.cs.

const System.String Lucene.Net.Index.IndexFileNames.VECTORS_INDEX_EXTENSION = "tvx"

Extension of vectors index file

Definition at line 67 of file IndexFileNames.cs.


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