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


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

Describes the input token stream. More...

#include <QueryParserToken.h>

+ Inheritance diagram for Lucene::QueryParserToken:

Public Member Functions

 QueryParserToken (int32_t kind=0, const String &image=EmptyString)
 Constructs a new token for the specified Image and Kind.
 
virtual ~QueryParserToken ()
 
virtual String getClassName ()
 
boost::shared_ptr< QueryParserTokenshared_from_this ()
 
virtual String toString ()
 Returns the image.
 
- 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.
 
- 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 ()
 
static QueryParserTokenPtr newToken (int32_t ofKind, const String &image=EmptyString)
 Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases.
 

Data Fields

int32_t kind
 An integer that describes the kind of this token.
 
int32_t beginLine
 The line number of the first character of this Token.
 
int32_t beginColumn
 The column number of the first character of this Token.
 
int32_t endLine
 The line number of the last character of this Token.
 
int32_t endColumn
 The column number of the last character of this Token.
 
String image
 The string image of the token.
 
QueryParserTokenPtr next
 A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.
 
QueryParserTokenPtr specialToken
 This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.
 

Additional Inherited Members

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

Detailed Description

Describes the input token stream.

Constructor & Destructor Documentation

◆ QueryParserToken()

Lucene::QueryParserToken::QueryParserToken ( int32_t  kind = 0,
const String &  image = EmptyString 
)

Constructs a new token for the specified Image and Kind.

◆ ~QueryParserToken()

virtual Lucene::QueryParserToken::~QueryParserToken ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getClassName()

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

◆ newToken()

static QueryParserTokenPtr Lucene::QueryParserToken::newToken ( int32_t  ofKind,
const String &  image = EmptyString 
)
static

Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases.

◆ shared_from_this()

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

◆ toString()

virtual String Lucene::QueryParserToken::toString ( )
virtual

Returns the image.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ beginColumn

int32_t Lucene::QueryParserToken::beginColumn

The column number of the first character of this Token.

◆ beginLine

int32_t Lucene::QueryParserToken::beginLine

The line number of the first character of this Token.

◆ endColumn

int32_t Lucene::QueryParserToken::endColumn

The column number of the last character of this Token.

◆ endLine

int32_t Lucene::QueryParserToken::endLine

The line number of the last character of this Token.

◆ image

String Lucene::QueryParserToken::image

The string image of the token.

◆ kind

int32_t Lucene::QueryParserToken::kind

An integer that describes the kind of this token.

◆ next

QueryParserTokenPtr Lucene::QueryParserToken::next

A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

◆ specialToken

QueryParserTokenPtr Lucene::QueryParserToken::specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.


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

clucene.sourceforge.net