Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
Lucene.Net.QueryParsers.Token Class Reference

Describes the input token stream. More...

Public Member Functions

 Token ()
 No-argument constructor
 
 Token (int kind)
 Constructs a new token for the specified Image.
 
 Token (int kind, System.String image)
 Constructs a new token for the specified Image and Kind.
 
override System.String ToString ()
 Returns the image.
 

Static Public Member Functions

static Token NewToken (int ofKind, System.String image)
 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. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simply add something like :
 
static Token NewToken (int ofKind)
 

Public Attributes

int kind
 An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.
 
int beginLine
 The line number of the first character of this Token.
 
int beginColumn
 The column number of the first character of this Token.
 
int endLine
 The line number of the last character of this Token.
 
int endColumn
 The column number of the last character of this Token.
 
System.String image
 The string image of the token.
 
Token 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.
 
Token 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.
 

Properties

virtual object Value [get]
 An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.
 

Detailed Description

Describes the input token stream.

Definition at line 28 of file Token.cs.

Constructor & Destructor Documentation

Lucene.Net.QueryParsers.Token.Token ( )

No-argument constructor

Definition at line 84 of file Token.cs.

Lucene.Net.QueryParsers.Token.Token ( int  kind)

Constructs a new token for the specified Image.

Definition at line 89 of file Token.cs.

Lucene.Net.QueryParsers.Token.Token ( int  kind,
System.String  image 
)

Constructs a new token for the specified Image and Kind.

Definition at line 94 of file Token.cs.

Member Function Documentation

static Token Lucene.Net.QueryParsers.Token.NewToken ( int  ofKind,
System.String  image 
)
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. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simply add something like :

case MyParserConstants.ID : return new IDToken(ofKind, image);

to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use sit in your lexical actions.

Definition at line 117 of file Token.cs.

static Token Lucene.Net.QueryParsers.Token.NewToken ( int  ofKind)
static

Definition at line 127 of file Token.cs.

override System.String Lucene.Net.QueryParsers.Token.ToString ( )

Returns the image.

Definition at line 101 of file Token.cs.

Member Data Documentation

int Lucene.Net.QueryParsers.Token.beginColumn

The column number of the first character of this Token.

Definition at line 40 of file Token.cs.

int Lucene.Net.QueryParsers.Token.beginLine

The line number of the first character of this Token.

Definition at line 38 of file Token.cs.

int Lucene.Net.QueryParsers.Token.endColumn

The column number of the last character of this Token.

Definition at line 44 of file Token.cs.

int Lucene.Net.QueryParsers.Token.endLine

The line number of the last character of this Token.

Definition at line 42 of file Token.cs.

System.String Lucene.Net.QueryParsers.Token.image

The string image of the token.

Definition at line 47 of file Token.cs.

int Lucene.Net.QueryParsers.Token.kind

An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

Definition at line 35 of file Token.cs.

Token Lucene.Net.QueryParsers.Token.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.

Definition at line 56 of file Token.cs.

Token Lucene.Net.QueryParsers.Token.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.

Definition at line 69 of file Token.cs.

Property Documentation

virtual object Lucene.Net.QueryParsers.Token.Value
get

An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.

Definition at line 79 of file Token.cs.


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