Lucene::TermVectorsPositionInfo Class Reference
Container for a term at a position. More...
#include <PositionBasedTermVectorMapper.h>
Inheritance diagram for Lucene::TermVectorsPositionInfo:
Public Member Functions | |
| TermVectorsPositionInfo (int32_t position, bool storeOffsets) | |
| virtual | ~TermVectorsPositionInfo () |
| virtual String | getClassName () |
| boost::shared_ptr< TermVectorsPositionInfo > | shared_from_this () |
| void | addTerm (const String &term, const TermVectorOffsetInfoPtr &info) |
| int32_t | getPosition () |
| Collection< String > | getTerms () |
| Note, there may be multiple terms at the same position. | |
| Collection< TermVectorOffsetInfoPtr > | getOffsets () |
Parallel list (to getTerms()) of TermVectorOffsetInfo objects. There may be multiple entries since there may be multiple terms at a position. | |
| Public Member Functions inherited from Lucene::LuceneObject | |
| 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 String | toString () |
| Returns a string representation of the object. | |
| Public Member Functions inherited from Lucene::LuceneSync | |
| 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. | |
Static Public Member Functions | |
| static String | _getClassName () |
Protected Attributes | |
| int32_t | position |
| Collection< String > | terms |
| Collection< TermVectorOffsetInfoPtr > | offsets |
| Protected Attributes inherited from Lucene::LuceneSync | |
| SynchronizePtr | objectLock |
| LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
| Protected Member Functions inherited from Lucene::LuceneObject | |
| LuceneObject () | |
Detailed Description
Container for a term at a position.
Constructor & Destructor Documentation
◆ TermVectorsPositionInfo()
| Lucene::TermVectorsPositionInfo::TermVectorsPositionInfo | ( | int32_t | position, |
| bool | storeOffsets ) |
References position.
Referenced by _getClassName().
◆ ~TermVectorsPositionInfo()
|
virtual |
Member Function Documentation
◆ _getClassName()
|
inlinestatic |
References TermVectorsPositionInfo().
◆ addTerm()
| void Lucene::TermVectorsPositionInfo::addTerm | ( | const String & | term, |
| const TermVectorOffsetInfoPtr & | info ) |
◆ getClassName()
|
inlinevirtual |
◆ getOffsets()
| Collection< TermVectorOffsetInfoPtr > Lucene::TermVectorsPositionInfo::getOffsets | ( | ) |
Parallel list (to getTerms()) of TermVectorOffsetInfo objects. There may be multiple entries since there may be multiple terms at a position.
- Returns
- A List of TermVectorOffsetInfo objects, if offsets are stored.
◆ getPosition()
| int32_t Lucene::TermVectorsPositionInfo::getPosition | ( | ) |
- Returns
- The position of the term
◆ getTerms()
| Collection< String > Lucene::TermVectorsPositionInfo::getTerms | ( | ) |
Note, there may be multiple terms at the same position.
- Returns
- A List of Strings
◆ shared_from_this()
|
inline |
Field Documentation
◆ offsets
|
protected |
◆ position
|
protected |
Referenced by TermVectorsPositionInfo().
◆ terms
|
protected |
The documentation for this class was generated from the following file: