Lucene++ - a full-featured, c++ search engine
API Documentation


IndexFileNames.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6 
7 #ifndef INDEXFILENAMES_H
8 #define INDEXFILENAMES_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
15 class LPPAPI IndexFileNames : public LuceneObject {
16 public:
17  virtual ~IndexFileNames();
19 
20 public:
22  static const String& SEGMENTS();
23 
25  static const String& SEGMENTS_GEN();
26 
28  static const String& DELETABLE();
29 
31  static const String& NORMS_EXTENSION();
32 
34  static const String& FREQ_EXTENSION();
35 
37  static const String& PROX_EXTENSION();
38 
40  static const String& TERMS_EXTENSION();
41 
43  static const String& TERMS_INDEX_EXTENSION();
44 
46  static const String& FIELDS_INDEX_EXTENSION();
47 
49  static const String& FIELDS_EXTENSION();
50 
52  static const String& VECTORS_FIELDS_EXTENSION();
53 
55  static const String& VECTORS_DOCUMENTS_EXTENSION();
56 
58  static const String& VECTORS_INDEX_EXTENSION();
59 
61  static const String& COMPOUND_FILE_EXTENSION();
62 
64  static const String& COMPOUND_FILE_STORE_EXTENSION();
65 
67  static const String& DELETES_EXTENSION();
68 
70  static const String& FIELD_INFOS_EXTENSION();
71 
73  static const String& PLAIN_NORMS_EXTENSION();
74 
76  static const String& SEPARATE_NORMS_EXTENSION();
77 
79  static const String& GEN_EXTENSION();
80 
86 
90 
93 
96 
99 
104  static String fileNameFromGeneration(const String& base, const String& extension, int64_t gen);
105 
108  static bool isDocStoreFile(const String& fileName);
109 
111  static String segmentFileName(const String& segmentName, const String& ext);
112 };
113 
114 }
115 
116 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Constants representing filenames and extensions used by Lucene.
Definition: IndexFileNames.h:15
static const String & FREQ_EXTENSION()
Extension of freq postings file.
static const HashSet< String > INDEX_EXTENSIONS_IN_COMPOUND_FILE()
File extensions that are added to a compound file (same as INDEX_EXTENSIONS, minus "del",...
static String segmentFileName(const String &segmentName, const String &ext)
Return segment file name.
static const String & DELETES_EXTENSION()
Extension of deletes.
static const String & SEGMENTS_GEN()
Name of the generation reference file name.
static const String & VECTORS_DOCUMENTS_EXTENSION()
Extension of vectors documents file.
static const HashSet< String > NON_STORE_INDEX_EXTENSIONS()
static const String & PLAIN_NORMS_EXTENSION()
Extension of plain norms.
static const HashSet< String > INDEX_EXTENSIONS()
This array contains all filename extensions used by Lucene's index files, with two exceptions,...
static const HashSet< String > COMPOUND_EXTENSIONS()
File extensions of old-style index files.
static const String & TERMS_EXTENSION()
Extension of terms file.
static const String & SEGMENTS()
Name of the index segment file.
static const String & COMPOUND_FILE_STORE_EXTENSION()
Extension of compound file for doc store files.
static const String & PROX_EXTENSION()
Extension of prox postings file.
static const String & FIELDS_EXTENSION()
Extension of stored fields file.
static const String & COMPOUND_FILE_EXTENSION()
Extension of compound file.
static const String & VECTORS_FIELDS_EXTENSION()
Extension of vectors fields file.
static bool isDocStoreFile(const String &fileName)
Returns true if the provided filename is one of the doc store files (ends with an extension in STORE_...
static const HashSet< String > STORE_INDEX_EXTENSIONS()
static const String & DELETABLE()
Name of the index deletable file (only used in pre-lockless indices).
static String fileNameFromGeneration(const String &base, const String &extension, int64_t gen)
Computes the full file name from base, extension and generation. If the generation is SegmentInfo#NO,...
static const String & NORMS_EXTENSION()
Extension of norms file.
static const HashSet< String > VECTOR_EXTENSIONS()
File extensions for term vector support.
static const String & FIELD_INFOS_EXTENSION()
Extension of field infos.
static const String & SEPARATE_NORMS_EXTENSION()
Extension of separate norms.
static const String & GEN_EXTENSION()
Extension of gen file.
static const String & TERMS_INDEX_EXTENSION()
Extension of terms index file.
static const String & VECTORS_INDEX_EXTENSION()
Extension of vectors index file.
static const String & FIELDS_INDEX_EXTENSION()
Extension of stored fields index file.
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Definition: AbstractAllTermDocs.h:12

clucene.sourceforge.net