Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Properties | List of all members
Lucene.Net.Analysis.Tokenattributes.OffsetAttribute Class Reference

The start and end character offset of a Token. More...

Inherits Attribute, Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute, and ICloneable.

Public Member Functions

virtual void SetOffset (int startOffset, int endOffset)
 Set the starting and ending offset. See StartOffset() and EndOffset()
 
override void Clear ()
 
override bool Equals (System.Object other)
 
override int GetHashCode ()
 
override void CopyTo (Attribute target)
 
override System.Object Clone ()
 

Properties

virtual int StartOffset [get]
 Returns this Token's starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter.
 
virtual int EndOffset [get]
 Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset).
 
- Properties inherited from Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute
int StartOffset [get]
 Returns this Token's starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter.
 
int EndOffset [get]
 Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset).
 

Detailed Description

The start and end character offset of a Token.

Definition at line 26 of file OffsetAttribute.cs.

Member Function Documentation

override void Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.Clear ( )

Definition at line 63 of file OffsetAttribute.cs.

override System.Object Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.Clone ( )

Definition at line 98 of file OffsetAttribute.cs.

override void Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.CopyTo ( Attribute  target)

Definition at line 92 of file OffsetAttribute.cs.

override bool Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.Equals ( System.Object  other)

Definition at line 69 of file OffsetAttribute.cs.

override int Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.GetHashCode ( )

Definition at line 85 of file OffsetAttribute.cs.

virtual void Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.SetOffset ( int  startOffset,
int  endOffset 
)
virtual

Set the starting and ending offset. See StartOffset() and EndOffset()

Implements Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute.

Definition at line 46 of file OffsetAttribute.cs.

Property Documentation

virtual int Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.EndOffset
get

Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset).

Definition at line 58 of file OffsetAttribute.cs.

virtual int Lucene.Net.Analysis.Tokenattributes.OffsetAttribute.StartOffset
get

Returns this Token's starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter.

Definition at line 38 of file OffsetAttribute.cs.


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