C# Class Lucene.Net.QueryParsers.Classic.Token

Show file Open project: apache/lucenenet Class Usage Examples

Public Properties

Property	Type	Description
beginColumn	int
beginLine	int
endColumn	int
endLine	int
image	string
kind	int
next	Token
specialToken	Token

Public Methods

Method	Description
NewToken ( int ofKind ) : Token
NewToken ( int ofKind, string image ) : Token	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.
ToString ( ) : string	Returns the image.
Token ( ) : System	No-argument constructor
Token ( int kind ) : System	Constructs a new token for the specified Image.
Token ( int kind, string image ) : System	Constructs a new token for the specified Image and Kind.

Method Details

NewToken() public static method

public static NewToken ( int ofKind ) : Token
ofKind	int
return	Token

NewToken() public static method

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.

public static NewToken ( int ofKind, string image ) : Token
ofKind	int
image	string
return	Token

ToString() public method

Returns the image.

public ToString ( ) : string
return	string

Token() public method

No-argument constructor

public Token ( ) : System
return	System

Token() public method

Constructs a new token for the specified Image.

public Token ( int kind ) : System
kind	int
return	System

Token() public method

Constructs a new token for the specified Image and Kind.

public Token ( int kind, string image ) : System
kind	int
image	string
return	System

Property Details

beginColumn public property

The column number of the first character of this Token.

public int beginColumn
return	int

beginLine public property

The line number of the first character of this Token.

public int beginLine
return	int

endColumn public property

The column number of the last character of this Token.

public int endColumn
return	int

endLine public property

The line number of the last character of this Token.

public int endLine
return	int

image public property

The string image of the token.

public string image
return	string

kind public property

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.

public int kind
return	int

next public property

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.

public Token,Lucene.Net.QueryParsers.Classic next
return	Token

specialToken public property

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.

public Token,Lucene.Net.QueryParsers.Classic specialToken
return	Token