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

Loading...
Searching...
No Matches
IndexFileNames.h
Go to the documentation of this file.
1
2// 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();
18 LUCENE_CLASS(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
85 static const HashSet<String> INDEX_EXTENSIONS();
86
89 static const HashSet<String> INDEX_EXTENSIONS_IN_COMPOUND_FILE();
90
91 static const HashSet<String> STORE_INDEX_EXTENSIONS();
92 static const HashSet<String> NON_STORE_INDEX_EXTENSIONS();
93
95 static const HashSet<String> COMPOUND_EXTENSIONS();
96
98 static const HashSet<String> VECTOR_EXTENSIONS();
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
LuceneObject.h
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Lucene::HashSet
Utility template class to handle hash set collections that can be safely copied and shared.
Definition HashSet.h:17
Lucene::IndexFileNames
Constants representing filenames and extensions used by Lucene.
Definition IndexFileNames.h:15
Lucene::IndexFileNames::COMPOUND_FILE_EXTENSION
static const String & COMPOUND_FILE_EXTENSION()
Extension of compound file.
Lucene::IndexFileNames::NON_STORE_INDEX_EXTENSIONS
static const HashSet< String > NON_STORE_INDEX_EXTENSIONS()
Lucene::IndexFileNames::FIELD_INFOS_EXTENSION
static const String & FIELD_INFOS_EXTENSION()
Extension of field infos.
Lucene::IndexFileNames::COMPOUND_FILE_STORE_EXTENSION
static const String & COMPOUND_FILE_STORE_EXTENSION()
Extension of compound file for doc store files.
Lucene::IndexFileNames::SEPARATE_NORMS_EXTENSION
static const String & SEPARATE_NORMS_EXTENSION()
Extension of separate norms.
Lucene::IndexFileNames::COMPOUND_EXTENSIONS
static const HashSet< String > COMPOUND_EXTENSIONS()
File extensions of old-style index files.
Lucene::IndexFileNames::segmentFileName
static String segmentFileName(const String &segmentName, const String &ext)
Return segment file name.
Lucene::IndexFileNames::INDEX_EXTENSIONS_IN_COMPOUND_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",...
Lucene::IndexFileNames::SEGMENTS
static const String & SEGMENTS()
Name of the index segment file.
Lucene::IndexFileNames::GEN_EXTENSION
static const String & GEN_EXTENSION()
Extension of gen file.
Lucene::IndexFileNames::FIELDS_EXTENSION
static const String & FIELDS_EXTENSION()
Extension of stored fields file.
Lucene::IndexFileNames::VECTORS_INDEX_EXTENSION
static const String & VECTORS_INDEX_EXTENSION()
Extension of vectors index file.
Lucene::IndexFileNames::TERMS_INDEX_EXTENSION
static const String & TERMS_INDEX_EXTENSION()
Extension of terms index file.
Lucene::IndexFileNames::TERMS_EXTENSION
static const String & TERMS_EXTENSION()
Extension of terms file.
Lucene::IndexFileNames::SEGMENTS_GEN
static const String & SEGMENTS_GEN()
Name of the generation reference file name.
Lucene::IndexFileNames::STORE_INDEX_EXTENSIONS
static const HashSet< String > STORE_INDEX_EXTENSIONS()
Lucene::IndexFileNames::DELETABLE
static const String & DELETABLE()
Name of the index deletable file (only used in pre-lockless indices).
Lucene::IndexFileNames::~IndexFileNames
virtual ~IndexFileNames()
Lucene::IndexFileNames::FREQ_EXTENSION
static const String & FREQ_EXTENSION()
Extension of freq postings file.
Lucene::IndexFileNames::VECTORS_FIELDS_EXTENSION
static const String & VECTORS_FIELDS_EXTENSION()
Extension of vectors fields file.
Lucene::IndexFileNames::FIELDS_INDEX_EXTENSION
static const String & FIELDS_INDEX_EXTENSION()
Extension of stored fields index file.
Lucene::IndexFileNames::isDocStoreFile
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_...
Lucene::IndexFileNames::VECTORS_DOCUMENTS_EXTENSION
static const String & VECTORS_DOCUMENTS_EXTENSION()
Extension of vectors documents file.
Lucene::IndexFileNames::VECTOR_EXTENSIONS
static const HashSet< String > VECTOR_EXTENSIONS()
File extensions for term vector support.
Lucene::IndexFileNames::PROX_EXTENSION
static const String & PROX_EXTENSION()
Extension of prox postings file.
Lucene::IndexFileNames::DELETES_EXTENSION
static const String & DELETES_EXTENSION()
Extension of deletes.
Lucene::IndexFileNames::fileNameFromGeneration
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,...
Lucene::IndexFileNames::PLAIN_NORMS_EXTENSION
static const String & PLAIN_NORMS_EXTENSION()
Extension of plain norms.
Lucene::IndexFileNames::NORMS_EXTENSION
static const String & NORMS_EXTENSION()
Extension of norms file.
Lucene::IndexFileNames::INDEX_EXTENSIONS
static const HashSet< String > INDEX_EXTENSIONS()
This array contains all filename extensions used by Lucene's index files, with two exceptions,...
Lucene::LuceneObject
Base class for all Lucene classes.
Definition LuceneObject.h:31
Lucene
Definition AbstractAllTermDocs.h:12

clucene.sourceforge.net