|
| Field (const String &name, const String &value, Store store, Index index) |
| Create a field by specifying its name, value and how it will be saved in the index. Term vectors will not be stored in the index.
|
|
| Field (const String &name, const String &value, Store store, Index index, TermVector termVector) |
| Create a field by specifying its name, value and how it will be saved in the index.
|
|
| Field (const String &name, const ReaderPtr &reader) |
| Create a tokenized and indexed field that is not stored. Term vectors will not be stored. The Reader is read only when the Document is added to the index, ie. you may not close the Reader until IndexWriter#addDocument(Document) has been called.
|
|
| Field (const String &name, const ReaderPtr &reader, TermVector termVector) |
| Create a tokenized and indexed field that is not stored, optionally with storing term vectors. The Reader is read only when the Document is added to the index, ie. you may not close the Reader until IndexWriter#addDocument(Document) has been called.
|
|
| Field (const String &name, const TokenStreamPtr &tokenStream) |
| Create a tokenized and indexed field that is not stored. Term vectors will not be stored. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, ie. you may not close the TokenStream until IndexWriter#addDocument(Document) has been called.
|
|
| Field (const String &name, const TokenStreamPtr &tokenStream, TermVector termVector) |
| Create a tokenized and indexed field that is not stored, optionally with storing term vectors. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, ie. you may not close the TokenStream until IndexWriter#addDocument(Document) has been called.
|
|
| Field (const String &name, ByteArray value, Store store) |
| Create a stored field with binary value. Optionally the value may be compressed.
|
|
| Field (const String &name, ByteArray value, int32_t offset, int32_t length, Store store) |
| Create a stored field with binary value. Optionally the value may be compressed.
|
|
virtual | ~Field () |
|
virtual String | getClassName () |
|
boost::shared_ptr< Field > | shared_from_this () |
|
virtual String | stringValue () |
| The value of the field as a String, or null. If null, the Reader value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set.
|
|
virtual ReaderPtr | readerValue () |
| The value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set.
|
|
virtual TokenStreamPtr | tokenStreamValue () |
| The value of the field as a TokesStream, or null. If null, the Reader value or String value is analyzed to produce the indexed tokens.
|
|
virtual void | setValue (const String &value) |
| Change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed. Typically a single Document instance is re-used as well. This helps most on small documents.
|
|
virtual void | setValue (const ReaderPtr &value) |
| Change the value of this field.
|
|
virtual void | setValue (ByteArray value) |
| Change the value of this field.
|
|
virtual void | setValue (ByteArray value, int32_t offset, int32_t length) |
| Change the value of this field.
|
|
virtual void | setTokenStream (const TokenStreamPtr &tokenStream) |
| Sets the token stream to be used for indexing and causes isIndexed() and isTokenized() to return true. May be combined with stored values from stringValue() or getBinaryValue()
|
|
virtual bool | isStored () |
| True if the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued.
|
|
virtual bool | isIndexed () |
| True if the value of the field is to be indexed, so that it may be searched on.
|
|
virtual | ~AbstractField () |
|
boost::shared_ptr< AbstractField > | shared_from_this () |
|
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 this this field of this document.
|
|
virtual double | getBoost () |
| Returns the boost factor for hits for this field.
|
|
virtual String | name () |
| Returns the name of the field as an interned string. For example "date", "title", "body", ...
|
|
virtual bool | isTokenized () |
| True if the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued.
|
|
virtual bool | isTermVectorStored () |
| True if the term or terms used to index this field are stored as a term vector, available from IndexReader#getTermFreqVector(int,String) . These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the stored attribute instead.
|
|
virtual bool | isStoreOffsetWithTermVector () |
| True if terms are stored as term vector together with their offsets (start and end position in source text).
|
|
virtual bool | isStorePositionWithTermVector () |
| True if terms are stored as term vector together with their token positions.
|
|
virtual bool | isBinary () |
| True if the value of the field is stored as binary.
|
|
virtual ByteArray | getBinaryValue () |
| Return the raw byte[] for the binary field. Note that you must also call getBinaryLength and getBinaryOffset to know which range of bytes in this returned array belong to the field.
|
|
virtual ByteArray | getBinaryValue (ByteArray result) |
| Return the raw byte[] for the binary field. Note that you must also call getBinaryLength and getBinaryOffset to know which range of bytes in this returned array belong to the field.
|
|
virtual int32_t | getBinaryLength () |
| Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined.
|
|
virtual int32_t | getBinaryOffset () |
| Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined.
|
|
virtual bool | getOmitNorms () |
| True if norms are omitted for this indexed field.
|
|
virtual bool | getOmitTermFreqAndPositions () |
|
virtual void | setOmitNorms (bool omitNorms) |
| If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.
|
|
virtual void | setOmitTermFreqAndPositions (bool omitTermFreqAndPositions) |
| If set, omit term freq, positions and payloads from postings for this field.
|
|
virtual bool | isLazy () |
| Indicates whether a Field is Lazy or not. The semantics of Lazy loading are such that if a Field is lazily loaded, retrieving it's values via stringValue() or getBinaryValue() is only valid as long as the IndexReader that retrieved the Document is still open.
|
|
virtual String | toString () |
| Prints a Field for human consumption.
|
|
virtual | ~Fieldable () |
|
virtual | ~LuceneObject () |
|
virtual void | initialize () |
| Called directly after instantiation to create objects that depend on this object being fully constructed.
|
|
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
| Return clone of this object.
|
|
virtual int32_t | hashCode () |
| Return hash code for this object.
|
|
virtual bool | equals (const LuceneObjectPtr &other) |
| Return whether two objects are equal.
|
|
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
| Compare two objects.
|
|
virtual | ~LuceneSync () |
|
virtual SynchronizePtr | getSync () |
| Return this object synchronize lock.
|
|
virtual LuceneSignalPtr | getSignal () |
| Return this object signal.
|
|
virtual void | lock (int32_t timeout=0) |
| Lock this object using an optional timeout.
|
|
virtual void | unlock () |
| Unlock this object.
|
|
virtual bool | holdsLock () |
| Returns true if this object is currently locked by current thread.
|
|
virtual void | wait (int32_t timeout=0) |
| Wait for signal using an optional timeout.
|
|
virtual void | notifyAll () |
| Notify all threads waiting for signal.
|
|