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


FieldSelector.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 FIELDSELECTOR_H
8 #define FIELDSELECTOR_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
16 class LPPAPI FieldSelector : public LuceneObject {
17 protected:
18  FieldSelector();
19 
20 public:
21  virtual ~FieldSelector();
22 
24 
25 public:
30 
36 
43 
48 
55 
61 
64  SELECTOR_SIZE_AND_BREAK
65  };
66 
67 public:
68  virtual FieldSelectorResult accept(const String& fieldName) = 0;
69 };
70 
71 }
72 
73 #endif
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::FieldSelector::FieldSelectorResult
FieldSelectorResult
Provides information about what should be done with this Field.
Definition: FieldSelector.h:27
Lucene::FieldSelector::SELECTOR_NO_LOAD
@ SELECTOR_NO_LOAD
Do not load the Field. Document#getField(String) and {} should return null. Document#add(Fieldable)}...
Definition: FieldSelector.h:47
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::FieldSelector::SELECTOR_LOAD
@ SELECTOR_LOAD
Load this Field every time the Document is loaded, reading in the data as it is encountered....
Definition: FieldSelector.h:35
Lucene::FieldSelector::SELECTOR_LAZY_LOAD
@ SELECTOR_LAZY_LOAD
Lazily load this Field. This means the Field is valid, but it may not actually contain its data until...
Definition: FieldSelector.h:42
Lucene::FieldSelector
The FieldSelector allows one to make decisions about what Fields get loaded on a Document by IndexRea...
Definition: FieldSelector.h:16
Lucene::FieldSelector::SELECTOR_SIZE
@ SELECTOR_SIZE
Load the size of this Field rather than its value. Size is measured as number of bytes required to st...
Definition: FieldSelector.h:60
Lucene::FieldSelector::SELECTOR_LOAD_AND_BREAK
@ SELECTOR_LOAD_AND_BREAK
Load this field as in the LOAD case, but immediately return from Field loading for the Document....
Definition: FieldSelector.h:54
Lucene::FieldSelector::SELECTOR_NULL
@ SELECTOR_NULL
Null value.
Definition: FieldSelector.h:29
LuceneObject.h

clucene.sourceforge.net