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

QueryParserCharStream.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6
7 #ifndef QUERYPARSERCHARSTREAM_H
8 #define QUERYPARSERCHARSTREAM_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
22 class LPPAPI QueryParserCharStream {
23 public:
24 LUCENE_INTERFACE(QueryParserCharStream);
25
26 public:
29 virtual wchar_t readChar() = 0;
30
34 virtual int32_t getColumn() = 0;
35
39 virtual int32_t getLine() = 0;
40
43 virtual int32_t getEndColumn() = 0;
44
47 virtual int32_t getEndLine() = 0;
48
51 virtual int32_t getBeginColumn() = 0;
52
55 virtual int32_t getBeginLine() = 0;
56
60 virtual void backup(int32_t amount) = 0;
61
64 virtual wchar_t BeginToken() = 0;
65
69 virtual String GetImage() = 0;
70
73 virtual CharArray GetSuffix(int32_t length) = 0;
74
78 virtual void Done() = 0;
79 };
80
81 }
82
83 #endif
LuceneObject.h
LUCENE_INTERFACE
#define LUCENE_INTERFACE(Name)
Definition: LuceneObject.h:19
Lucene::QueryParserCharStream
This interface describes a character stream that maintains line and column number positions of the ch...
Definition: QueryParserCharStream.h:22
Lucene::QueryParserCharStream::GetImage
virtual String GetImage()=0
Returns a string made up of characters from the marked token beginning to the current buffer position...
Lucene::QueryParserCharStream::getBeginColumn
virtual int32_t getBeginColumn()=0
Returns the column number of the first character for current token (being matched after the last call...
Lucene::QueryParserCharStream::getLine
virtual int32_t getLine()=0
Returns the line number of the character last read.
Lucene::QueryParserCharStream::getEndColumn
virtual int32_t getEndColumn()=0
Returns the column number of the last character for current token (being matched after the last call ...
Lucene::QueryParserCharStream::readChar
virtual wchar_t readChar()=0
Returns the next character from the selected input. The method of selecting the input is the responsi...
Lucene::QueryParserCharStream::BeginToken
virtual wchar_t BeginToken()=0
Returns the next character that marks the beginning of the next token. All characters must remain in ...
Lucene::QueryParserCharStream::backup
virtual void backup(int32_t amount)=0
Backs up the input stream by amount steps. Lexer calls this method if it had already read some charac...
Lucene::QueryParserCharStream::getEndLine
virtual int32_t getEndLine()=0
Returns the line number of the last character for current token (being matched after the last call to...
Lucene::QueryParserCharStream::getBeginLine
virtual int32_t getBeginLine()=0
Returns the line number of the first character for current token (being matched after the last call t...
Lucene::QueryParserCharStream::GetSuffix
virtual CharArray GetSuffix(int32_t length)=0
Returns an array of characters that make up the suffix of length for the currently matched token....
Lucene::QueryParserCharStream::getColumn
virtual int32_t getColumn()=0
Returns the column position of the character last read.
Lucene::QueryParserCharStream::Done
virtual void Done()=0
The lexer calls this function to indicate that it is done with the stream and hence implementations c...
Lucene
Definition: AbstractAllTermDocs.h:12

clucene.sourceforge.net