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 | Protected Member Functions | List of all members
Lucene.Net.Analysis.TokenFilter Class Reference

A TokenFilter is a TokenStream whose input is another TokenStream. This is an abstract class; subclasses must override TokenStream.IncrementToken(). More...

Inherits Lucene.Net.Analysis.TokenStream.

Inherited by Lucene.Net.Analysis.AR.ArabicNormalizationFilter, Lucene.Net.Analysis.AR.ArabicStemFilter, Lucene.Net.Analysis.ASCIIFoldingFilter, Lucene.Net.Analysis.BR.BrazilianStemFilter, Lucene.Net.Analysis.CachingTokenFilter, Lucene.Net.Analysis.Cn.ChineseFilter, Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase, Lucene.Net.Analysis.De.GermanStemFilter, Lucene.Net.Analysis.El.GreekLowerCaseFilter, Lucene.Net.Analysis.Fa.PersianNormalizationFilter, Lucene.Net.Analysis.Fr.ElisionFilter, Lucene.Net.Analysis.Fr.FrenchStemFilter, Lucene.Net.Analysis.Hunspell.HunspellStemFilter, Lucene.Net.Analysis.ISOLatin1AccentFilter, Lucene.Net.Analysis.LengthFilter, Lucene.Net.Analysis.LowerCaseFilter, Lucene.Net.Analysis.NGram.EdgeNGramTokenFilter, Lucene.Net.Analysis.NGram.NGramTokenFilter, Lucene.Net.Analysis.Nl.DutchStemFilter, Lucene.Net.Analysis.Payloads.DelimitedPayloadTokenFilter, Lucene.Net.Analysis.Payloads.NumericPayloadTokenFilter, Lucene.Net.Analysis.Payloads.TokenOffsetPayloadTokenFilter, Lucene.Net.Analysis.Payloads.TypeAsPayloadTokenFilter, Lucene.Net.Analysis.PorterStemFilter, Lucene.Net.Analysis.Position.PositionFilter, Lucene.Net.Analysis.Reverse.ReverseStringFilter, Lucene.Net.Analysis.Ru.RussianLowerCaseFilter, Lucene.Net.Analysis.Ru.RussianStemFilter, Lucene.Net.Analysis.Shingle.ShingleFilter, Lucene.Net.Analysis.Snowball.SnowballFilter, Lucene.Net.Analysis.Standard.StandardFilter, Lucene.Net.Analysis.StopFilter, Lucene.Net.Analysis.TeeSinkTokenFilter, and Lucene.Net.Analysis.Th.ThaiWordFilter.

Public Member Functions

override void End ()
 Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.NOTE: Be sure to call super.end() first when overriding this method.
 
override void Reset ()
 Reset the filter as well as the input TokenStream.
 
- Public Member Functions inherited from Lucene.Net.Analysis.TokenStream
abstract bool IncrementToken ()
 Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.
 
void Close ()
 Releases resources associated with this stream.
 
void Dispose ()
 
- Public Member Functions inherited from Lucene.Net.Util.AttributeSource
 AttributeSource ()
 An AttributeSource using the default attribute factory AttributeSource.AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY.
 
 AttributeSource (AttributeSource input)
 An AttributeSource that uses the same attributes as the supplied one.
 
 AttributeSource (AttributeFactory factory)
 An AttributeSource using the supplied AttributeFactory for creating new IAttribute instances.
 
virtual IEnumerable< Type > GetAttributeTypesIterator ()
 Returns a new iterator that iterates the attribute classes in the same order they were added in. Signature for Java 1.5: public Iterator<Class<? extends Attribute>> getAttributeClassesIterator()
 
virtual IEnumerable< AttributeGetAttributeImplsIterator ()
 Returns a new iterator that iterates all unique Attribute implementations. This iterator may contain less entries that GetAttributeTypesIterator, if one instance implements more than one Attribute interface. Signature for Java 1.5: public Iterator<AttributeImpl> getAttributeImplsIterator()
 
virtual void AddAttributeImpl (Attribute att)
 Expert: Adds a custom AttributeImpl instance with one or more Attribute interfaces.
 
virtual T AddAttribute< T > ()
 The caller must pass in a Class<? extends Attribute> value. This method first checks if an instance of that class is already in this AttributeSource and returns it. Otherwise a new instance is created, added to this AttributeSource and returned.
 
virtual bool HasAttribute< T > ()
 The caller must pass in a Class<? extends Attribute> value. Returns true, iff this AttributeSource contains the passed-in Attribute.
 
virtual T GetAttribute< T > ()
 The caller must pass in a Class<? extends Attribute> value. Returns the instance of the passed in Attribute contained in this AttributeSource
 
virtual void ClearAttributes ()
 Resets all Attributes in this AttributeSource by calling Attribute.Clear() on each Attribute implementation.
 
virtual State CaptureState ()
 Captures the state of all Attributes. The return value can be passed to RestoreState to restore the state of this or another AttributeSource.
 
virtual void RestoreState (State state)
 Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (e.g. it is not possible to restore the state of an AttributeSource containing a TermAttribute into a AttributeSource using a Token instance as implementation).
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 
override System.String ToString ()
 
virtual AttributeSource CloneAttributes ()
 Performs a clone of all Attribute instances returned in a new AttributeSource instance. This method can be used to e.g. create another TokenStream with exactly the same attributes (using AttributeSource(AttributeSource))
 

Protected Member Functions

override void Dispose (bool disposing)
 

Additional Inherited Members

- Properties inherited from Lucene.Net.Util.AttributeSource
virtual AttributeFactory Factory [get]
 Returns the used AttributeFactory.
 
virtual bool HasAttributes [get]
 Returns true, iff this AttributeSource has any attributes
 

Detailed Description

A TokenFilter is a TokenStream whose input is another TokenStream.

This is an abstract class; subclasses must override TokenStream.IncrementToken().

See Also
TokenStream

Definition at line 28 of file TokenFilter.cs.

Member Function Documentation

override void Lucene.Net.Analysis.TokenFilter.Dispose ( bool  disposing)
protectedvirtual

Implements Lucene.Net.Analysis.TokenStream.

Definition at line 50 of file TokenFilter.cs.

override void Lucene.Net.Analysis.TokenFilter.End ( )
virtual

Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.NOTE: Be sure to call super.end() first when overriding this method.

Reimplemented from Lucene.Net.Analysis.TokenStream.

Definition at line 45 of file TokenFilter.cs.

override void Lucene.Net.Analysis.TokenFilter.Reset ( )
virtual

Reset the filter as well as the input TokenStream.

Reimplemented from Lucene.Net.Analysis.TokenStream.

Definition at line 67 of file TokenFilter.cs.


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