Lucene++ - a full-featured, c++ search engine
API Documentation
Go to the documentation of this file.
7 #ifndef ABSTRACTFIELD_H
8 #define ABSTRACTFIELD_H
53 INDEX_ANALYZED_NO_NORMS
77 TERM_VECTOR_WITH_POSITIONS_OFFSETS
143 virtual bool isStored();
146 virtual bool isIndexed();
virtual bool getOmitNorms()
True if norms are omitted for this indexed field.
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
virtual void setOmitNorms(bool omitNorms)
If set, omit normalization factors associated with this indexed field. This effectively disables inde...
@ STORE_YES
Store the original field value in the index. This is useful for short texts like a document's title w...
Definition: AbstractField.h:21
virtual String name()
Returns the name of the field as an interned string. For example "date", "title", "body",...
bool _isIndexed
Definition: AbstractField.h:95
bool _isBinary
Definition: AbstractField.h:97
virtual int32_t getBinaryLength()
Returns length of byte[] segment that is used as value, if Field is not binary returned value is unde...
int32_t binaryOffset
Definition: AbstractField.h:110
@ INDEX_NOT_ANALYZED_NO_NORMS
Index the field's value without an Analyzer, and also disable the storing of norms....
Definition: AbstractField.h:48
int32_t binaryLength
Definition: AbstractField.h:109
@ TERM_VECTOR_YES
Store the term vectors of each document. A term vector is a list of the document's terms and their nu...
Definition: AbstractField.h:63
Definition: AbstractField.h:14
virtual bool isBinary()
True if the value of the field is stored as binary.
virtual double getBoost()
Returns the boost factor for hits for this field.
bool _omitNorms
Definition: AbstractField.h:93
bool storeOffsetWithTermVector
Definition: AbstractField.h:91
double boost
Definition: AbstractField.h:100
void setStoreTermVector(TermVector termVector)
virtual ByteArray getBinaryValue()
Return the raw byte[] for the binary field. Note that you must also call getBinaryLength and getBinar...
virtual ByteArray getBinaryValue(ByteArray result)
Return the raw byte[] for the binary field. Note that you must also call getBinaryLength and getBinar...
bool _isTokenized
Definition: AbstractField.h:96
virtual bool getOmitTermFreqAndPositions()
bool _isStored
Definition: AbstractField.h:94
virtual void setBoost(double boost)
Sets the boost factor hits on this field. This value will be multiplied into the score of all hits on...
virtual bool isStoreOffsetWithTermVector()
True if terms are stored as term vector together with their offsets (start and end position in source...
virtual int32_t getBinaryOffset()
Returns offset into byte[] segment that is used as value, if Field is not binary returned value is un...
Definition: AbstractAllTermDocs.h:12
Base class for all Lucene classes.
Definition: LuceneObject.h:31
@ TERM_VECTOR_NO
Do not store term vectors.
Definition: AbstractField.h:59
bool omitTermFreqAndPositions
Definition: AbstractField.h:99
TokenStreamPtr tokenStream
Definition: AbstractField.h:106
virtual bool isTokenized()
True if the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are...
Synonymous with Field.
Definition: Fieldable.h:20
AbstractField(const String &name, Store store, Index index, TermVector termVector)
Store
Specifies whether and how a field should be stored.
Definition: AbstractField.h:17
bool storeTermVector
Definition: AbstractField.h:90
virtual void setOmitTermFreqAndPositions(bool omitTermFreqAndPositions)
If set, omit term freq, positions and payloads from postings for this field.
virtual bool isTermVectorStored()
True if the term or terms used to index this field are stored as a term vector, available from IndexR...
@ INDEX_NOT_ANALYZED
Index the field's value without using an Analyzer, so it can be searched. As no analyzer is used the ...
Definition: AbstractField.h:39
@ TERM_VECTOR_WITH_OFFSETS
Store the term vector + token offset information.
Definition: AbstractField.h:71
boost::shared_ptr< TokenStream > TokenStreamPtr
Definition: LuceneTypes.h:63
Index
Specifies whether and how a field should be indexed.
Definition: AbstractField.h:28
@ INDEX_ANALYZED
Index the tokens produced by running the field's value through an Analyzer. This is useful for common...
Definition: AbstractField.h:35
virtual bool isStorePositionWithTermVector()
True if terms are stored as term vector together with their token positions.
bool lazy
Definition: AbstractField.h:98
bool storePositionWithTermVector
Definition: AbstractField.h:92
@ TERM_VECTOR_WITH_POSITIONS
Store the term vector + token position information.
Definition: AbstractField.h:67
@ INDEX_NO
Do not index the field value. This field can thus not be searched, but one can still access its conte...
Definition: AbstractField.h:31
FieldsData fieldsData
Definition: AbstractField.h:103
virtual String toString()
Prints a Field for human consumption.
virtual bool isLazy()
Indicates whether a Field is Lazy or not. The semantics of Lazy loading are such that if a Field is l...
TermVector
Specifies whether and how a field should have term vectors.
Definition: AbstractField.h:57
String _name
Definition: AbstractField.h:89
clucene.sourceforge.net