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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::Term Class Reference

A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occurred in, an interned string. More...

#include <Term.h>

+ Inheritance diagram for Lucene::Term:

Public Member Functions

 Term (const String &fld, const String &txt=EmptyString)
 Constructs a Term with the given field and text.
 
virtual ~Term ()
 
virtual String getClassName ()
 
boost::shared_ptr< Termshared_from_this ()
 
String field ()
 Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.
 
String text ()
 Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string.
 
TermPtr createTerm (const String &text)
 Optimized construction of new Terms by reusing same field as this Term.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument.
 
void set (const String &fld, const String &txt)
 
virtual String toString ()
 Returns a string representation of the object.
 
- 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.
 
- 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 ()
 

Data Fields

String _field
 
String _text
 

Additional Inherited Members

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

Detailed Description

A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occurred in, an interned string.

Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.

Constructor & Destructor Documentation

◆ Term()

Lucene::Term::Term ( const String &  fld,
const String &  txt = EmptyString 
)

Constructs a Term with the given field and text.

◆ ~Term()

virtual Lucene::Term::~Term ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::Term::_getClassName ( )
inlinestatic

◆ compareTo()

virtual int32_t Lucene::Term::compareTo ( const LuceneObjectPtr other)
virtual

Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument.

The ordering of terms is first by field, then by text.

Reimplemented from Lucene::LuceneObject.

◆ createTerm()

TermPtr Lucene::Term::createTerm ( const String &  text)

Optimized construction of new Terms by reusing same field as this Term.

Parameters
textThe text of the new term (field is implicitly same as this Term instance)
Returns
A new Term

◆ equals()

virtual bool Lucene::Term::equals ( const LuceneObjectPtr other)
virtual

Return whether two objects are equal.

Reimplemented from Lucene::LuceneObject.

◆ field()

String Lucene::Term::field ( )

Returns the field of this term, an interned string. The field indicates the part of a document which this term came from.

◆ getClassName()

virtual String Lucene::Term::getClassName ( )
inlinevirtual

◆ hashCode()

virtual int32_t Lucene::Term::hashCode ( )
virtual

Return hash code for this object.

Reimplemented from Lucene::LuceneObject.

◆ set()

void Lucene::Term::set ( const String &  fld,
const String &  txt 
)

◆ shared_from_this()

boost::shared_ptr< Term > Lucene::Term::shared_from_this ( )
inline

◆ text()

String Lucene::Term::text ( )

Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string.

◆ toString()

virtual String Lucene::Term::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ _field

String Lucene::Term::_field

◆ _text

String Lucene::Term::_text

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

clucene.sourceforge.net