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


Public Member Functions | Static Public Member Functions | Data Fields
Lucene::FieldInfo Class Reference

#include <FieldInfo.h>

+ Inheritance diagram for Lucene::FieldInfo:

Public Member Functions

 FieldInfo (const String &na, bool tk, int32_t nu, bool storeTermVector, bool storePositionWithTermVector, bool storeOffsetWithTermVector, bool omitNorms, bool storePayloads, bool omitTermFreqAndPositions)
 
virtual ~FieldInfo ()
 
virtual String getClassName ()
 
boost::shared_ptr< FieldInfoshared_from_this ()
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object. More...
 
void update (bool isIndexed, bool storeTermVector, bool storePositionWithTermVector, bool storeOffsetWithTermVector, bool omitNorms, bool storePayloads, bool omitTermFreqAndPositions)
 
- 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. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal. More...
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects. More...
 
virtual String toString ()
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock. More...
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal. More...
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout. More...
 
virtual void unlock ()
 Unlock this object. More...
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread. More...
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout. More...
 
virtual void notifyAll ()
 Notify all threads waiting for signal. More...
 

Static Public Member Functions

static String _getClassName ()
 

Data Fields

String name
 
bool isIndexed
 
int32_t number
 
bool storeTermVector
 
bool storeOffsetWithTermVector
 
bool storePositionWithTermVector
 
bool omitNorms
 
bool omitTermFreqAndPositions
 
bool storePayloads
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Constructor & Destructor Documentation

Lucene::FieldInfo::FieldInfo ( const String &  na,
bool  tk,
int32_t  nu,
bool  storeTermVector,
bool  storePositionWithTermVector,
bool  storeOffsetWithTermVector,
bool  omitNorms,
bool  storePayloads,
bool  omitTermFreqAndPositions 
)
virtual Lucene::FieldInfo::~FieldInfo ( )
virtual

Member Function Documentation

static String Lucene::FieldInfo::_getClassName ( )
inlinestatic
virtual LuceneObjectPtr Lucene::FieldInfo::clone ( const LuceneObjectPtr other = LuceneObjectPtr())
virtual

Return clone of this object.

Parameters
otherclone reference - null when called initially, then set in top virtual override.

Reimplemented from Lucene::LuceneObject.

virtual String Lucene::FieldInfo::getClassName ( )
inlinevirtual
boost::shared_ptr< FieldInfo > Lucene::FieldInfo::shared_from_this ( )
inline
void Lucene::FieldInfo::update ( bool  isIndexed,
bool  storeTermVector,
bool  storePositionWithTermVector,
bool  storeOffsetWithTermVector,
bool  omitNorms,
bool  storePayloads,
bool  omitTermFreqAndPositions 
)

Field Documentation

bool Lucene::FieldInfo::isIndexed
String Lucene::FieldInfo::name
int32_t Lucene::FieldInfo::number
bool Lucene::FieldInfo::omitNorms
bool Lucene::FieldInfo::omitTermFreqAndPositions
bool Lucene::FieldInfo::storeOffsetWithTermVector
bool Lucene::FieldInfo::storePayloads
bool Lucene::FieldInfo::storePositionWithTermVector
bool Lucene::FieldInfo::storeTermVector

The documentation for this class was generated from the following file:

clucene.sourceforge.net